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

CreateTelemetryRule

Creates a telemetry rule that defines how telemetry should be configured for AWS resources in your account. The rule specifies which resources should have telemetry enabled and how that telemetry data should be collected based on resource type, telemetry type, and selection criteria.

Request Syntax


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

{
   "Rule": { 
      "DestinationConfiguration": { 
         "DestinationPattern": "string",
         "DestinationType": "string",
         "RetentionInDays": number,
         "VPCFlowLogParameters": { 
            "LogFormat": "string",
            "MaxAggregationInterval": number,
            "TrafficType": "string"
         }
      },
      "ResourceType": "string",
      "Scope": "string",
      "SelectionCriteria": "string",
      "TelemetryType": "string"
   },
   "RuleName": "string",
   "Tags": { 
      "string" : "string" 
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Rule

The configuration details for the telemetry rule, including the resource type, telemetry type, destination configuration, and selection criteria for which resources the rule applies to.

Type: TelemetryRule object

Required: Yes

RuleName

A unique name for the telemetry rule being created.

Type: String

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

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

Required: Yes

Tags

The key-value pairs to associate with the telemetry rule resource for categorization and management purposes.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: ([\p{L}\p{Z}\p{N}_.:/=+\-@]*)

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "RuleArn": "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.

RuleArn

The Amazon Resource Name (ARN) of the created 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})?:(.+)

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

ConflictException

The requested operation conflicts with the current state of the specified resource or with another request.

HTTP Status Code: 409

InternalServerException

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

HTTP Status Code: 500

ServiceQuotaExceededException

The requested operation would exceed the allowed quota for the specified resource type.

HTTP Status Code: 402

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