DescribeDetector - Amazon Fraud Detector

DescribeDetector

Gets all versions for a specified detector.

Request Syntax

{ "detectorId": "string", "maxResults": number, "nextToken": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

detectorId

The detector ID.

Type: String

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

Pattern: ^[0-9a-z_-]+$

Required: Yes

maxResults

The maximum number of results to return for the request.

Type: Integer

Valid Range: Minimum value of 1000. Maximum value of 2500.

Required: No

nextToken

The next token from the previous response.

Type: String

Required: No

Response Syntax

{ "detectorId": "string", "detectorVersionSummaries": [ { "description": "string", "detectorVersionId": "string", "lastUpdatedTime": "string", "status": "string" } ], "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.

detectorId

The detector ID.

Type: String

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

Pattern: ^[0-9a-z_-]+$

detectorVersionSummaries

The status and description for each detector version.

Type: Array of DetectorVersionSummary objects

nextToken

The next token to be used for subsequent requests.

Type: String

Errors

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

InternalServerException

An exception indicating an internal server error.

HTTP Status Code: 500

ResourceNotFoundException

An exception indicating the specified resource was not found.

HTTP Status Code: 400

ThrottlingException

An exception indicating a throttling error.

HTTP Status Code: 400

ValidationException

An exception indicating a specified value is not allowed.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: