GetTelemetryRule
Retrieves the details of a specific telemetry rule in your account.
Request Syntax
POST /GetTelemetryRule 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 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,
"HomeRegion": "string",
"IsReplicated": boolean,
"LastUpdateTimeStamp": number,
"RegionStatuses": [
{
"FailureReason": "string",
"Region": "string",
"RuleArn": "string",
"Status": "string"
}
],
"RuleArn": "string",
"RuleName": "string",
"TelemetryRule": {
"AllowFieldUpdates": boolean,
"AllRegions": boolean,
"DestinationConfiguration": {
"CloudtrailParameters": {
"AdvancedEventSelectors": [
{
"FieldSelectors": [
{
"EndsWith": [ "string" ],
"Equals": [ "string" ],
"Field": "string",
"NotEndsWith": [ "string" ],
"NotEquals": [ "string" ],
"NotStartsWith": [ "string" ],
"StartsWith": [ "string" ]
}
],
"Name": "string"
}
]
},
"DestinationPattern": "string",
"DestinationType": "string",
"ELBLoadBalancerLoggingParameters": {
"FieldDelimiter": "string",
"OutputFormat": "string"
},
"LogDeliveryParameters": {
"LogTypes": [ "string" ]
},
"MskMonitoringParameters": {
"EnhancedMonitoring": "string"
},
"RetentionInDays": number,
"VPCFlowLogParameters": {
"LogFormat": "string",
"MaxAggregationInterval": number,
"TrafficType": "string"
},
"WAFLoggingParameters": {
"LoggingFilter": {
"DefaultBehavior": "string",
"Filters": [
{
"Behavior": "string",
"Conditions": [
{
"ActionCondition": {
"Action": "string"
},
"LabelNameCondition": {
"LabelName": "string"
}
}
],
"Requirement": "string"
}
]
},
"LogType": "string",
"RedactedFields": [
{
"Method": "string",
"QueryString": "string",
"SingleHeader": {
"Name": "string"
},
"UriPath": "string"
}
]
}
},
"Regions": [ "string" ],
"ResourceType": "string",
"Scope": "string",
"SelectionCriteria": "string",
"TelemetrySourceTypes": [ "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 telemetry rule was created.
Type: Long
- HomeRegion
-
The AWS Region where the telemetry rule was originally created. For replicated rules in spoke regions, this indicates the region that manages the rule. For rules created without multi-region scope, this field is not present.
Type: String
Length Constraints: Minimum length of 1.
- IsReplicated
-
Indicates whether this telemetry rule is a replica that was created in this region through multi-region fan-out from the home region. Replicated rules cannot be directly updated or deleted in the spoke region. To modify a replicated rule, make changes in the home region.
Type: Boolean
- LastUpdateTimeStamp
-
The timestamp when the telemetry rule was last updated.
Type: Long
- RegionStatuses
-
A list of per-region replication statuses for the telemetry rule. Each entry indicates the replication status of the rule in a specific spoke region. This field is only present for rules created with multi-region scope.
Type: Array of RegionStatus objects
- RuleArn
-
The Amazon Resource Name (ARN) of the telemetry 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})?:(.+) - RuleName
-
The name of the 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 telemetry rule.
Type: TelemetryRule object
Errors
For information about the errors that are common to all actions, see Common Error Types.
- 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.
- amznErrorType
-
The name of the exception.
HTTP Status Code: 400
- InternalServerException
-
Indicates the request has failed to process because of an unknown server error, exception, or failure.
- amznErrorType
-
The name of the exception.
- retryAfterSeconds
-
The number of seconds to wait before retrying the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource (such as a telemetry rule) could not be found.
- ResourceId
-
The identifier of the resource which could not be found.
- ResourceType
-
The type of the resource which 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.
- Errors
-
The errors in the input which caused the exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
