CloudWatchObservabilityAdminService / Client / list_centralization_rules_for_organization

list_centralization_rules_for_organization¶

CloudWatchObservabilityAdminService.Client.list_centralization_rules_for_organization(**kwargs)¶

Lists all centralization rules in your organization. This operation can only be called by the organization’s management account or a delegated administrator account.

Request Syntax

response = client.list_centralization_rules_for_organization(
    RuleNamePrefix='string',
    AllRegions=True|False,
    MaxResults=123,
    NextToken='string'
)

Parameters:

RuleNamePrefix (string) – A string to filter organization centralization rules whose names begin with the specified prefix.
AllRegions (boolean) – A flag determining whether to return organization centralization rules from all regions or only the current region.
MaxResults (integer) – The maximum number of organization centralization rules to return in a single call.
NextToken (string) – The token for the next set of results. A previous call generates this token.

Return type:

dict

Returns:

Response Syntax

{
    'CentralizationRuleSummaries': [
        {
            'RuleName': 'string',
            'RuleArn': 'string',
            'CreatorAccountId': 'string',
            'CreatedTimeStamp': 123,
            'CreatedRegion': 'string',
            'LastUpdateTimeStamp': 123,
            'RuleHealth': 'Healthy'|'Unhealthy'|'Provisioning',
            'FailureReason': 'TRUSTED_ACCESS_NOT_ENABLED'|'DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION'|'INTERNAL_SERVER_ERROR',
            'DestinationAccountId': 'string',
            'DestinationRegion': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- CentralizationRuleSummaries (list) –
  
  A list of centralization rule summaries.
  - (dict) –
    
    A summary of a centralization rule’s key properties and status.
    - RuleName (string) –
      
      The name of the organization centralization rule.
    - RuleArn (string) –
      
      The Amazon Resource Name (ARN) of the organization centralization rule.
    - CreatorAccountId (string) –
      
      The Amazon Web Services Account that created the organization centralization rule.
    - CreatedTimeStamp (integer) –
      
      The timestamp when the organization centralization rule was created.
    - CreatedRegion (string) –
      
      The Amazon Web Services region where the organization centralization rule was created.
    - LastUpdateTimeStamp (integer) –
      
      The timestamp when the organization centralization rule was last updated.
    - RuleHealth (string) –
      
      The health status of the organization centralization rule.
    - FailureReason (string) –
      
      The reason why an organization centralization rule is marked UNHEALTHY.
    - DestinationAccountId (string) –
      
      The primary destination account of the organization centralization rule.
    - DestinationRegion (string) –
      
      The primary destination region of the organization centralization rule.
- NextToken (string) –
  
  A token to resume pagination of results.

Exceptions

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