GetTelemetryRuleForOrganization - Amazon CloudWatch

GetTelemetryRuleForOrganization

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

Request Syntax

POST /GetTelemetryRuleForOrganization 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 telemetry 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 { "CreatedTimeStamp": number, "LastUpdateTimeStamp": number, "RuleArn": "string", "RuleName": "string", "TelemetryRule": { "DestinationConfiguration": { "DestinationPattern": "string", "DestinationType": "string", "RetentionInDays": number, "VPCFlowLogParameters": { "LogFormat": "string", "MaxAggregationInterval": number, "TrafficType": "string" } }, "ResourceType": "string", "Scope": "string", "SelectionCriteria": "string", "TelemetryType": "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.

CreatedTimeStamp

The timestamp when the organization telemetry rule was created.

Type: Long

LastUpdateTimeStamp

The timestamp when the organization telemetry rule was last updated.

Type: Long

RuleArn

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

Type: String

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

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

RuleName

The name of the organization telemetry rule.

Type: String

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

Pattern: [0-9A-Za-z-]+

TelemetryRule

The configuration details of the organization telemetry rule.

Type: TelemetryRule object

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: