CloudWatchObservabilityAdminService / Client / get_telemetry_evaluation_status_for_organization

get_telemetry_evaluation_status_for_organization¶

CloudWatchObservabilityAdminService.Client.get_telemetry_evaluation_status_for_organization()¶

This returns the onboarding status of the telemetry configuration feature for the organization. It can only be called by a Management Account of an Amazon Web Services Organization or an assigned Delegated Admin Account of Amazon CloudWatch telemetry config.

Request Syntax

response = client.get_telemetry_evaluation_status_for_organization()

Return type:

dict

Returns:

Response Syntax

{
    'Status': 'NOT_STARTED'|'STARTING'|'FAILED_START'|'RUNNING'|'STOPPING'|'FAILED_STOP'|'STOPPED',
    'FailureReason': 'string',
    'HomeRegion': 'string',
    'RegionStatuses': [
        {
            'Region': 'string',
            'Status': 'string',
            'FailureReason': 'string',
            'RuleArn': 'string'
        },
    ]
}

Response Structure

(dict) –
- Status (string) –
  
  The onboarding status of the telemetry config feature for the organization.
- FailureReason (string) –
  
  This field describes the reason for the failure status. The field will only be populated if Status is FAILED_START or FAILED_STOP.
- HomeRegion (string) –
  
  The Amazon Web Services Region that is designated as the home region for multi-region telemetry evaluation for the organization. The home region is the single management point for all multi-region operations on this organization. This field is only present when multi-region telemetry evaluation is active.
- RegionStatuses (list) –
  
  A list of per-region telemetry evaluation statuses for the organization. Each entry indicates the evaluation status for a specific spoke region included in the multi-region configuration. This field is only present when multi-region telemetry evaluation is active.
  - (dict) –
    
    Represents the status of a multi-region operation in a specific Amazon Web Services Region. This structure is used to report per-region progress for both telemetry evaluation and telemetry rule replication.
    - Region (string) –
      
      The Amazon Web Services Region code (for example, eu-west-1 or us-west-2) that this status applies to.
    - Status (string) –
      
      The status of the operation in this region. For telemetry evaluation, valid values include STARTING, RUNNING, and FAILED_START. For telemetry rules, valid values include PENDING, ACTIVE, and FAILED.
    - FailureReason (string) –
      
      The reason for a failure status in this region. This field is only populated when Status indicates a failure.
    - RuleArn (string) –
      
      The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is ACTIVE).

Exceptions

CloudWatchObservabilityAdminService.Client.exceptions.AccessDeniedException
CloudWatchObservabilityAdminService.Client.exceptions.InternalServerException
CloudWatchObservabilityAdminService.Client.exceptions.ValidationException
CloudWatchObservabilityAdminService.Client.exceptions.TooManyRequestsException