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
{
"arn": "string",
"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.
- arn
-
The detector ARN.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn\:aws[a-z-]{0,15}\:frauddetector\:[a-z0-9-]{3,20}\:[0-9]{12}\:[^\s]{2,128}$ - 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.
- AccessDeniedException
-
An exception indicating Amazon Fraud Detector does not have the needed permissions. This can occur if you submit a request, such as
PutExternalModel, that specifies a role that is not in your account.HTTP Status Code: 400
- 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:
