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

UpdateIndexingRule

Modifies an indexing rule’s configuration.

Indexing rules are used for determining the sampling rate for spans indexed from CloudWatch Logs. For more information, see Transaction Search.

Request Syntax


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

{
   "Name": "string",
   "Rule": { ... }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

Name

Name of the indexing rule to be updated.

Type: String

Required: Yes

Rule

Rule configuration to be updated.

Type: IndexingRuleValueUpdate object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "IndexingRule": { 
      "ModifiedAt": number,
      "Name": "string",
      "Rule": { ... }
   }
}

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.

IndexingRule

Updated indexing rule.

Type: IndexingRule object

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

ResourceNotFoundException

The resource was not found. Verify that the name or Amazon Resource Name (ARN) of the resource is correct.

HTTP Status Code: 404

ThrottledException

The request exceeds the maximum number of requests per second.

HTTP Status Code: 429