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.

See also: AWS API Documentation

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',
            'TagPropagationStatus': 'Healthy'|'Unhealthy',
            'TagPropagationFailureReason': 'RoleNotAssumable'|'RoleLacksPermissions',
            'ContextGraphStatus': 'Healthy'|'Unhealthy'|'Provisioning',
            '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.

        • TagPropagationStatus (string) –

          The health status of tag propagation for this rule. This status is independent of the overall RuleHealth for log delivery. Returns Healthy when the most recent tag-propagation attempt succeeded, or Unhealthy when the most recent attempt failed.

        • TagPropagationFailureReason (string) –

          The reason tag propagation is unhealthy for this rule. Only present when TagPropagationStatus is Unhealthy.

        • ContextGraphStatus (string) –

          The status of context graph centralization for this rule. Returns Provisioning while the context graph is being set up, Healthy once it is active, or Unhealthy if provisioning failed. This status is independent of the overall RuleHealth for log delivery.

        • 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