Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetCentralizationRuleForOrganization

Retrieves the details of a specific organization centralization rule. This operation can only be called by the organization's management account or a delegated administrator account.

Request Syntax


POST /GetCentralizationRuleForOrganization HTTP/1.1
Content-type: application/json

{
   "RuleIdentifier": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

RuleIdentifier

The identifier (name or ARN) of the organization centralization rule to retrieve.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "CentralizationRule": { 
      "Destination": { 
         "Account": "string",
         "DestinationLogsConfiguration": { 
            "BackupConfiguration": { 
               "KmsKeyArn": "string",
               "Region": "string"
            },
            "LogsEncryptionConfiguration": { 
               "EncryptionConflictResolutionStrategy": "string",
               "EncryptionStrategy": "string",
               "KmsKeyArn": "string"
            }
         },
         "Region": "string"
      },
      "Source": { 
         "Regions": [ "string" ],
         "Scope": "string",
         "SourceLogsConfiguration": { 
            "EncryptedLogGroupStrategy": "string",
            "LogGroupSelectionCriteria": "string"
         }
      }
   },
   "CreatedRegion": "string",
   "CreatedTimeStamp": number,
   "CreatorAccountId": "string",
   "FailureReason": "string",
   "LastUpdateTimeStamp": number,
   "RuleArn": "string",
   "RuleHealth": "string",
   "RuleName": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CentralizationRule

The configuration details for the organization centralization rule.

Type: CentralizationRule object

CreatedRegion

The AWS region where the organization centralization rule was created.

Type: String

Length Constraints: Minimum length of 1.

CreatedTimeStamp

The timestamp when the organization centralization rule was created.

Type: Long

CreatorAccountId

The AWS Account that created the organization centralization rule.

Type: String

FailureReason

The reason why an organization centralization rule is marked UNHEALTHY.

Type: String

Valid Values: TRUSTED_ACCESS_NOT_ENABLED | DESTINATION_ACCOUNT_NOT_IN_ORGANIZATION | INTERNAL_SERVER_ERROR

LastUpdateTimeStamp

The timestamp when the organization centralization rule was last updated.

Type: Long

RuleArn

The Amazon Resource Name (ARN) of the organization centralization rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1011.

Pattern: arn:aws([a-z0-9\-]+)?:([a-zA-Z0-9\-]+):([a-z0-9\-]+)?:([0-9]{12})?:(.+)

RuleHealth

The health status of the organization centralization rule.

Type: String

Valid Values: Healthy | Unhealthy | Provisioning

RuleName

The name of the organization centralization rule.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [0-9A-Za-z-_.#/]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Indicates you don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access management for AWS resources in the IAM user guide.

HTTP Status Code: 400

InternalServerException

Indicates the request has failed to process because of an unknown server error, exception, or failure.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource (such as a telemetry rule) could not be found.

HTTP Status Code: 404

TooManyRequestsException

The request throughput limit was exceeded.

HTTP Status Code: 429

ValidationException

Indicates input validation failed. Check your request parameters and retry the request.

HTTP Status Code: 400