Skip to main content

List specific workloads

GET 
/c/v2/workload/:id/

Request​

Path Parameters

    id stringrequired

Responses​

Schema

    id ID (integer)
    workload_arn Workload arn (string)nullable

    Possible values: <= 255 characters

    workload_id Workload id (string)nullable

    Possible values: <= 255 characters

    name Name (string)nullablerequired

    Possible values: <= 255 characters

    owner Owner (string)
    created date-time
    modified date-time
    submitted Submitted (boolean)
    local Local (boolean)
    risk_counts Risk counts (string)
    improvement_status Improvement status (string)
    violations_counts Violations counts (string)
    filters objectrequired
    lenses Lenses (string)[]nullable

    Possible values: non-empty and <= 100 characters

    compliance_frameworks Compliance frameworks (string)[]nullable

    Possible values: non-empty and <= 100 characters

    project_id Project id (integer)required

    Possible values: >= -2147483648 and <= 2147483647

    client_id Client id (integer)required

    Possible values: >= -2147483648 and <= 2147483647

    environment Environment (string)nullable

    Possible values: <= 50 characters

    end_assessment_date End assessment date (string)
    user_id User id (integer)required

    Possible values: >= -2147483648 and <= 2147483647

    created_by_user Created by user (string)
    rules_risk_levels Rules risk levels (string)
    jira_project objectnullable
    description Description (string)nullable
    druid_query_filters Druid query filters (string)
    status Status (string)
    risk_counts_by_pillars Risk counts by pillars (string)

    recommendations

    object[]

  • Array [

    • id ID (integer)

    recommendation_attachments

    object[]

  • Array [

    • id ID (integer)
    created_by_user Created by user (string)
    created date-time
    modified date-time
    attachment_type Attachment type (string)

    Possible values: non-empty and <= 100 characters

    title Title (string)required

    Possible values: non-empty and <= 255 characters

    description Description (string)required

    Possible values: non-empty and <= 1024 characters

    internal_upload_link Internal upload link (string)nullable

    Possible values: <= 1024 characters

    external_link External link (string)nullable

    Possible values: <= 1024 characters

    document_type Document type (string)nullable

    Possible values: <= 255 characters

    created_by Created by (integer)nullable

    Possible values: >= -2147483648 and <= 2147483647

    workload Workload (integer)
    workload_recommendation Workload recommendation (integer)nullable

  • ]

    • created date-time
    modified date-time
    recommendation_key Recommendation key (string)required

    Possible values: non-empty and <= 255 characters

    lens_alias Lens alias (string)

    Possible values: [wellarchitected, softwareasaservice, serverless, baseline]

    Default value: wellarchitected

    title Title (string)required

    Possible values: non-empty and <= 255 characters

    description Description (string)required

    Possible values: non-empty and <= 255 characters

    choices Choices (string)[]nullable

    Possible values: [ACOM-001, ACOM-002, ARC-001, ARC-003, ARC-004, ARC-005, BAR-001, BAR-002, CAA-001, CAA-002, CAA-003, CAA-004, CAA-005, CAA-006, CAA-007, CTL-001, CTL-002, CTL-003, CTL-004, HOST-001, IAM-001, IAM-002, IAM-003, IAM-004, IAM-005, IAM-006, IAM-007, IAM-008, IAM-009, IAM-010, IAM-011, IAM-012, NETSEC-001, NETSEC-002, RCVP-001, RES-001, RES-002, RES-004, RES-005, RES-006, RES-007, S3-001, S3-002, S3-003, SDAT-001, SDAT-002, SDAT-003, SECOPS-001, SUP-001, WAFR-001, WAFR-002, cost_cloud_financial_management_budget_forecast, cost_cloud_financial_management_cost_awareness, cost_cloud_financial_management_function, cost_cloud_financial_management_no, cost_cloud_financial_management_partnership, cost_cloud_financial_management_proactive_process, cost_cloud_financial_management_scheduled, cost_cloud_financial_management_usage_report, cost_cost_q1_a1, cost_cost_q1_a2, cost_cost_q1_a3, cost_cost_q1_a4, cost_cost_q1_no, cost_cost_q2_a1, cost_cost_q2_a2, cost_cost_q2_no, cost_data_transfer_implement_services, cost_data_transfer_modeling, cost_data_transfer_no, cost_data_transfer_optimized_components, cost_decomissioning_resources_decomm_automated, cost_decomissioning_resources_decommission, cost_decomissioning_resources_implement_process, cost_decomissioning_resources_no, cost_decomissioning_resources_track, cost_evaluate_new_services_no, cost_evaluate_new_services_review_process, cost_evaluate_new_services_review_workload, cost_govern_usage_account_structure, cost_govern_usage_controls, cost_govern_usage_goal_target, cost_govern_usage_groups_roles, cost_govern_usage_no, cost_govern_usage_policies, cost_govern_usage_track_lifecycle, cost_manage_demand_resources_buffer_throttle, cost_manage_demand_resources_cost_analysis, cost_manage_demand_resources_dynamic, cost_manage_demand_resources_no, cost_monitor_usage_allocate_outcome, cost_monitor_usage_config_tools, cost_monitor_usage_define_attribution, cost_monitor_usage_define_kpi, cost_monitor_usage_detailed_source, cost_monitor_usage_no, cost_monitor_usage_org_information, cost_pricing_model_analysis, cost_pricing_model_implement_models, cost_pricing_model_master_analysis, cost_pricing_model_no, cost_pricing_model_region_cost, cost_pricing_model_third_party, cost_select_service_analyze_all, cost_select_service_analyze_over_time, cost_select_service_licensing, cost_select_service_no, cost_select_service_requirements, cost_select_service_select_for_cost, cost_select_service_thorough_analysis, cost_type_size_number_resources_cost_modeling, cost_type_size_number_resources_data, cost_type_size_number_resources_metrics, cost_type_size_number_resources_no, ops_dev_integ_auto_integ_deploy, ops_dev_integ_build_mgmt_sys, ops_dev_integ_code_quality, ops_dev_integ_conf_mgmt_sys, ops_dev_integ_freq_sm_rev_chg, ops_dev_integ_multi_env, ops_dev_integ_no, ops_dev_integ_patch_mgmt, ops_dev_integ_share_design_stds, ops_dev_integ_test_val_chg, ops_dev_integ_version_control, ops_event_response_auto_event_response, ops_event_response_dashboards, ops_event_response_define_escalation_paths, ops_event_response_event_incident_problem_process, ops_event_response_no, ops_event_response_prioritize_events, ops_event_response_process_per_alert, ops_event_response_push_notify, ops_evolve_ops_allocate_time_for_imp, ops_evolve_ops_drivers_for_imp, ops_evolve_ops_feedback_loops, ops_evolve_ops_knowledge_management, ops_evolve_ops_metrics_review, ops_evolve_ops_no, ops_evolve_ops_perform_rca_process, ops_evolve_ops_process_cont_imp, ops_evolve_ops_share_lessons_learned, ops_evolve_ops_validate_insights, ops_mit_deploy_risks_auto_integ_deploy, ops_mit_deploy_risks_auto_testing_and_rollback, ops_mit_deploy_risks_deploy_mgmt_sys, ops_mit_deploy_risks_deploy_to_parallel_env, ops_mit_deploy_risks_freq_sm_rev_chg, ops_mit_deploy_risks_no, ops_mit_deploy_risks_plan_for_unsucessful_changes, ops_mit_deploy_risks_test_limited_deploy, ops_mit_deploy_risks_test_val_chg, ops_operations_health_biz_level_view_ops, ops_operations_health_collect_analyze_ops_metrics, ops_operations_health_define_ops_kpis, ops_operations_health_design_ops_metrics, ops_operations_health_learn_ops_usage_patterns, ops_operations_health_no, ops_operations_health_ops_anomaly_alerts, ops_operations_health_ops_metric_baselines, ops_operations_health_ops_outcome_alerts, ops_ops_model_def_activity_owners, ops_ops_model_def_neg_team_agreements, ops_ops_model_def_proc_owners, ops_ops_model_def_resource_owners, ops_ops_model_find_owner, ops_ops_model_know_my_job, ops_ops_model_no, ops_ops_model_req_add_chg_exception, ops_ops_q1_a1, ops_ops_q1_a2, ops_ops_q1_a3, ops_ops_q1_a4, ops_ops_q1_no, ops_ops_q2_a1, ops_ops_q2_a2, ops_ops_q2_a3, ops_ops_q2_a4, ops_ops_q2_a5, ops_ops_q2_a6, ops_ops_q2_no, ops_ops_q3_a1, ops_ops_q3_a2, ops_ops_q3_a3, ops_ops_q3_no, ops_ops_q4_a1, ops_ops_q4_a2, ops_ops_q4_no, ops_org_culture_diverse_inc_access, ops_org_culture_effective_comms, ops_org_culture_executive_sponsor, ops_org_culture_no, ops_org_culture_team_emp_take_action, ops_org_culture_team_enc_escalation, ops_org_culture_team_enc_experiment, ops_org_culture_team_enc_learn, ops_org_culture_team_res_appro, ops_priorities_compliance_reqs, ops_priorities_eval_threat_landscape, ops_priorities_eval_tradeoffs, ops_priorities_ext_cust_needs, ops_priorities_governance_reqs, ops_priorities_int_cust_needs, ops_priorities_manage_risk_benefit, ops_priorities_no, ops_ready_to_support_const_orr, ops_ready_to_support_informed_deploy_decisions, ops_ready_to_support_no, ops_ready_to_support_personnel_capability, ops_ready_to_support_use_playbooks, ops_ready_to_support_use_runbooks, ops_telemetry_application_telemetry, ops_telemetry_customer_telemetry, ops_telemetry_dependency_telemetry, ops_telemetry_dist_trace, ops_telemetry_no, ops_telemetry_workload_telemetry, ops_workload_health_biz_level_view_workload, ops_workload_health_collect_analyze_workload_metrics, ops_workload_health_define_workload_kpis, ops_workload_health_design_workload_metrics, ops_workload_health_learn_workload_usage_patterns, ops_workload_health_no, ops_workload_health_workload_anomaly_alerts, ops_workload_health_workload_metric_baselines, ops_workload_health_workload_outcome_alerts, perf_continue_having_appropriate_resource_type_define_process, perf_continue_having_appropriate_resource_type_evolve, perf_continue_having_appropriate_resource_type_keep_up_to_date, perf_continue_having_appropriate_resource_type_no, perf_monitor_instances_post_launch_establish_kpi, perf_monitor_instances_post_launch_generate_alarms, perf_monitor_instances_post_launch_no, perf_monitor_instances_post_launch_proactive, perf_monitor_instances_post_launch_record_metrics, perf_monitor_instances_post_launch_review_metrics, perf_monitor_instances_post_launch_review_metrics_collected, perf_perf_q1_a1, perf_perf_q1_a2, perf_perf_q1_a3, perf_perf_q1_a4, perf_perf_q1_a5, perf_perf_q1_no, perf_perf_q2_a1, perf_perf_q2_a2, perf_perf_q2_a3, perf_perf_q2_no, perf_perf_q3_a1, perf_perf_q3_a2, perf_perf_q3_a3, perf_perf_q3_no, perf_performing_architecture_benchmark, perf_performing_architecture_cost, perf_performing_architecture_evaluate_resources, perf_performing_architecture_external_guidance, perf_performing_architecture_load_test, perf_performing_architecture_no, perf_performing_architecture_process, perf_performing_architecture_use_policies, perf_right_database_solution_access_patterns, perf_right_database_solution_collect_metrics, perf_right_database_solution_evaluate_options, perf_right_database_solution_no, perf_right_database_solution_optimize_metrics, perf_right_database_solution_understand_char, perf_right_storage_solution_evaluated_options, perf_right_storage_solution_no, perf_right_storage_solution_optimize_patterns, perf_right_storage_solution_understand_char, perf_select_compute_collect_metrics, perf_select_compute_config_options, perf_select_compute_elasticity, perf_select_compute_evaluate_options, perf_select_compute_no, perf_select_compute_right_sizing, perf_select_compute_use_metrics, perf_select_network_encryption_offload, perf_select_network_evaluate_features, perf_select_network_hybrid, perf_select_network_location, perf_select_network_no, perf_select_network_optimize, perf_select_network_protocols, perf_select_network_understand_impact, perf_tradeoffs_performance_critical_areas, perf_tradeoffs_performance_design_patterns, perf_tradeoffs_performance_implement_strategy, perf_tradeoffs_performance_measure, perf_tradeoffs_performance_no, perf_tradeoffs_performance_understand_impact, rel_adapt_to_changes_autoscale_adapt, rel_adapt_to_changes_load_tested_adapt, rel_adapt_to_changes_no, rel_adapt_to_changes_proactive_adapt_auto, rel_adapt_to_changes_reactive_adapt_auto, rel_backing_up_data_automated_backups_data, rel_backing_up_data_identified_backups_data, rel_backing_up_data_no, rel_backing_up_data_periodic_recovery_testing_data, rel_backing_up_data_secured_backups_data, rel_fault_isolation_multiaz_region_system, rel_fault_isolation_no, rel_fault_isolation_single_az_system, rel_fault_isolation_use_bulkhead, rel_manage_service_limits_automated_monitor_limits, rel_manage_service_limits_aware_fixed_limits, rel_manage_service_limits_aware_quotas_and_constraints, rel_manage_service_limits_limits_considered, rel_manage_service_limits_monitor_manage_limits, rel_manage_service_limits_no, rel_manage_service_limits_suff_buffer_limits, rel_mitigate_interaction_failure_client_timeouts, rel_mitigate_interaction_failure_emergency_levers, rel_mitigate_interaction_failure_fail_fast, rel_mitigate_interaction_failure_graceful_degradation, rel_mitigate_interaction_failure_limit_retries, rel_mitigate_interaction_failure_no, rel_mitigate_interaction_failure_stateless, rel_mitigate_interaction_failure_throttle_requests, rel_monitor_aws_resources_automate_response_monitor, rel_monitor_aws_resources_end_to_end, rel_monitor_aws_resources_monitor_resources, rel_monitor_aws_resources_no, rel_monitor_aws_resources_notification_aggregation, rel_monitor_aws_resources_notification_monitor, rel_monitor_aws_resources_review_monitoring, rel_monitor_aws_resources_storage_analytics, rel_planning_for_recovery_auto_recovery, rel_planning_for_recovery_config_drift, rel_planning_for_recovery_disaster_recovery, rel_planning_for_recovery_dr_tested, rel_planning_for_recovery_no, rel_planning_for_recovery_objective_defined_recovery, rel_planning_network_topology_ha_conn_private_networks, rel_planning_network_topology_ha_conn_users, rel_planning_network_topology_ip_subnet_allocation, rel_planning_network_topology_no, rel_planning_network_topology_non_overlap_ip, rel_planning_network_topology_prefer_hub_and_spoke, rel_prevent_interaction_failure_constant_work, rel_prevent_interaction_failure_idempotent, rel_prevent_interaction_failure_identify, rel_prevent_interaction_failure_loosely_coupled_system, rel_prevent_interaction_failure_no, rel_rel_q1_a1, rel_rel_q1_a2, rel_rel_q1_a3, rel_rel_q1_no, rel_rel_q2_a1, rel_rel_q2_a2, rel_rel_q2_a3, rel_rel_q2_a4, rel_rel_q2_no, rel_rel_q3_a1, rel_rel_q3_a2, rel_rel_q3_a3, rel_rel_q3_a4, rel_rel_q3_a5, rel_rel_q3_no, rel_service_architecture_api_contracts, rel_service_architecture_business_domains, rel_service_architecture_monolith_soa_microservice, rel_service_architecture_no, rel_testing_resiliency_failure_injection_resiliency, rel_testing_resiliency_game_days_resiliency, rel_testing_resiliency_no, rel_testing_resiliency_playbook_resiliency, rel_testing_resiliency_rca_resiliency, rel_testing_resiliency_test_functional, rel_testing_resiliency_test_non_functional, rel_tracking_change_management_automated_changemgmt, rel_tracking_change_management_functional_testing, rel_tracking_change_management_immutable_infrastructure, rel_tracking_change_management_no, rel_tracking_change_management_planned_changemgmt, rel_tracking_change_management_resiliency_testing, rel_withstand_component_failures_auto_healing_system, rel_withstand_component_failures_failover2good, rel_withstand_component_failures_monitoring_health, rel_withstand_component_failures_no, rel_withstand_component_failures_notifications_sent_system, rel_withstand_component_failures_static_stability, sec_data_classification_auto_classification, sec_data_classification_define_protection, sec_data_classification_identify_data, sec_data_classification_lifecycle_management, sec_data_classification_no, sec_detect_investigate_events_actionable_events, sec_detect_investigate_events_analyze_all, sec_detect_investigate_events_app_service_logging, sec_detect_investigate_events_auto_response, sec_detect_investigate_events_no, sec_identities_audit, sec_identities_enforce_mechanisms, sec_identities_groups_attributes, sec_identities_identity_provider, sec_identities_no, sec_identities_secrets, sec_identities_unique, sec_incident_response_auto_contain, sec_incident_response_develop_management_plans, sec_incident_response_identify_personnel, sec_incident_response_no, sec_incident_response_pre_deploy_tools, sec_incident_response_pre_provision_access, sec_incident_response_prepare_forensic, sec_incident_response_run_game_days, sec_network_protection_auto_protect, sec_network_protection_create_layers, sec_network_protection_inspection, sec_network_protection_layered, sec_network_protection_no, sec_permissions_analyze_cross_account, sec_permissions_continuous_reduction, sec_permissions_define, sec_permissions_define_guardrails, sec_permissions_emergency_process, sec_permissions_least_privileges, sec_permissions_lifecycle, sec_permissions_no, sec_permissions_share_securely, sec_protect_compute_actions_distance, sec_protect_compute_auto_protection, sec_protect_compute_implement_managed_services, sec_protect_compute_no, sec_protect_compute_reduce_surface, sec_protect_compute_validate_software_integrity, sec_protect_compute_vulnerability_management, sec_protect_data_rest_access_control, sec_protect_data_rest_automate_protection, sec_protect_data_rest_encrypt, sec_protect_data_rest_key_mgmt, sec_protect_data_rest_no, sec_protect_data_rest_use_people_away, sec_protect_data_transit_authentication, sec_protect_data_transit_auto_unintended_access, sec_protect_data_transit_encrypt, sec_protect_data_transit_key_cert_mgmt, sec_protect_data_transit_no, sec_sec_q1_a1, sec_sec_q1_a2, sec_sec_q1_a3, sec_sec_q1_no, sec_sec_q2_a1, sec_sec_q2_a2, sec_sec_q2_a3, sec_sec_q2_a4, sec_sec_q2_no, sec_sec_q3_a1, sec_sec_q3_a2, sec_sec_q3_a3, sec_sec_q3_a4, sec_sec_q3_a5, sec_sec_q3_no, sec_securely_operate_aws_account, sec_securely_operate_control_objectives, sec_securely_operate_implement_services_features, sec_securely_operate_multi_accounts, sec_securely_operate_no, sec_securely_operate_test_validate_pipeline, sec_securely_operate_threat_model, sec_securely_operate_updated_recommendations, sec_securely_operate_updated_threats, sus_sus_data_a2, sus_sus_data_a3, sus_sus_data_a4, sus_sus_data_a5, sus_sus_data_a6, sus_sus_data_a7, sus_sus_data_a8, sus_sus_data_a9, sus_sus_data_no, sus_sus_dev_a2, sus_sus_dev_a3, sus_sus_dev_a4, sus_sus_dev_a5, sus_sus_dev_no, sus_sus_hardware_a2, sus_sus_hardware_a3, sus_sus_hardware_a4, sus_sus_hardware_a5, sus_sus_hardware_no, sus_sus_region_a2, sus_sus_region_no, sus_sus_software_a2, sus_sus_software_a3, sus_sus_software_a4, sus_sus_software_a5, sus_sus_software_a6, sus_sus_software_no, sus_sus_user_a2, sus_sus_user_a3, sus_sus_user_a4, sus_sus_user_a5, sus_sus_user_a6, sus_sus_user_no]

    fix_action Fix action (string)

    Possible values: [document, rule]

    document_type Document type (string)nullable

    Possible values: <= 255 characters

    rules Rules (string)[]nullable

    Possible values: [admin_users:iam, ami_expired:ami, ami_public:ami, check_aws_config:regions, check_aws_enterprise_support:iam, check_aws_inspector:iam, check_ec2_autoscaling:ec2, check_empty_tags:ebs, check_empty_tags:ec2, check_guardduty_enabled:iam, check_resource_encryption:ebs, check_resource_encryption:rds, check_resource_encryption:s3, check_root_user_mfa:iam, check_waf_used:iam, classic_vpc:ec2, cloudtrail_log_validation_enabled:ct_trail, cloudtrail_s3_protection:s3, dynamodb_continuos_backup:dynamodb, dynamodb_limit:dynamodb, dynamodb_low_utilization:dynamodb, ebs_snapshot:ebs, ec2_low_network_utilization:ec2, ecs_low_utilization:ecs, efs_low_utilization:efs, elasticache_disabled_multizone:elasticache, inactive_keys:iam, instance_recommendation:rds, instance_recommendation_rightsizing:ec2, iops_performance:ebs, iops_performance:rds, log_group_underutilized:loggroup, no_mfa_users:iam, policy_attached_users:iam, public_ebs_snapshot:ebs_snapshot, public_lambda:lambda, public_subnet:ec2, public_subnet:rds, rds_backup_policy:rds, rds_instances_idle:rds, rds_instances_without_multiaz:rds, rds_public_snapshot:rds_snapshot, redshift_low_node_utilization:redshift, root_access_keys:iam, root_account_usage:iam, s3_bucket_security:s3, s3_bucket_versioning_disabled:s3, s3_recommendation_rightsizing:s3, s3_underutilized:s3, scheduled_events:ec2, strong_password_policy:iam, triggerless_lambda:lambda, unattached_workspace_directories:workspace_directory, underutilized_resources:ec2, unencrypted_lambda_variables:lambda, unused_resources:ebs, unused_resources:eip, unused_resources:elb, unused_resources:nat, unused_roles:iam_role, vpc_cidr:vpc, vpc_flow_logging_disabled:vpc]

    external_link urinullable

    Possible values: <= 1024 characters

    extra objectnullable
    is_fixed Is fixed (boolean)
    config Config (integer)nullable
    workload Workload (integer)

  • ]

Loading...