# 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](#API_GetTelemetryRule_RequestSyntax) **   <a name="cwoa-GetTelemetryRule-request-RuleIdentifier"></a>
 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,
   "LastUpdateTimeStamp": number,
   "RuleArn": "string",
   "RuleName": "string",
   "TelemetryRule": { 
      "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" ]
         },
         "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"
               }
            ]
         }
      },
      "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](#API_GetTelemetryRule_ResponseSyntax) **   <a name="cwoa-GetTelemetryRule-response-CreatedTimeStamp"></a>
 The timestamp when the telemetry rule was created.   
Type: Long

 ** [LastUpdateTimeStamp](#API_GetTelemetryRule_ResponseSyntax) **   <a name="cwoa-GetTelemetryRule-response-LastUpdateTimeStamp"></a>
 The timestamp when the telemetry rule was last updated.   
Type: Long

 ** [RuleArn](#API_GetTelemetryRule_ResponseSyntax) **   <a name="cwoa-GetTelemetryRule-response-RuleArn"></a>
 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](#API_GetTelemetryRule_ResponseSyntax) **   <a name="cwoa-GetTelemetryRule-response-RuleName"></a>
 The name of the telemetry rule.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `[0-9A-Za-z-_.#/]+` 

 ** [TelemetryRule](#API_GetTelemetryRule_ResponseSyntax) **   <a name="cwoa-GetTelemetryRule-response-TelemetryRule"></a>
 The configuration details of the telemetry rule.   
Type: [TelemetryRule](API_TelemetryRule.md) object

## Errors


For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** 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](https://docs.aws.amazon.com/IAM/latest/UserGuide/access.html) 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:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/observabilityadmin-2018-05-10/GetTelemetryRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/observabilityadmin-2018-05-10/GetTelemetryRule)