GetOutcomes - Amazon Fraud Detector

GetOutcomes

Gets one or more outcomes. This is a paginated API. If you provide a null maxSizePerPage, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult as part of your request. A null pagination token fetches the records from the beginning.

Request Syntax

{ "maxResults": number, "name": "string", "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.

maxResults

The maximum number of objects to return for the request.

Type: Integer

Valid Range: Minimum value of 50. Maximum value of 100.

Required: No

name

The name of the outcome or outcomes to get.

Type: String

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

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

Required: No

nextToken

The next page token for the request.

Type: String

Required: No

Response Syntax

{ "nextToken": "string", "outcomes": [ { "createdTime": "string", "description": "string", "lastUpdatedTime": "string", "name": "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.

nextToken

The next page token for subsequent requests.

Type: String

outcomes

The outcomes.

Type: Array of Outcome objects

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: