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

GetIndexingRules

Retrieves all indexing rules.

Indexing rules are used to determine the server-side sampling rate for spans ingested through the CloudWatchLogs destination and indexed by X-Ray. For more information, see Transaction Search.

Request Syntax


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

{
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

NextToken

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IndexingRules": [ 
      { 
         "ModifiedAt": number,
         "Name": "string",
         "Rule": { ... }
      }
   ],
   "NextToken": "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.

IndexingRules

Retrieves all indexing rules.

Type: Array of IndexingRule objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

NextToken

Specify the pagination token returned by a previous request to retrieve the next page of indexes.

Type: String

Errors

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

InvalidRequestException

The request is missing required parameters or has invalid parameters.

HTTP Status Code: 400

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429