FraudDetector / Client / get_outcomes

get_outcomes#

FraudDetector.Client.get_outcomes(**kwargs)#

Gets one or more outcomes. This is a paginated API. If you provide a null maxResults, this actions retrieves a maximum of 100 records per page. If you provide a maxResults, 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

response = client.get_outcomes(
    name='string',
    nextToken='string',
    maxResults=123
)

Parameters:

name (string) – The name of the outcome or outcomes to get.
nextToken (string) – The next page token for the request.
maxResults (integer) – The maximum number of objects to return for the request.

Return type:

dict

Returns:

Response Syntax

{
    'outcomes': [
        {
            'name': 'string',
            'description': 'string',
            'lastUpdatedTime': 'string',
            'createdTime': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- outcomes (list) –
  
  The outcomes.
  - (dict) –
    
    The outcome.
    - name (string) –
      
      The outcome name.
    - description (string) –
      
      The outcome description.
    - lastUpdatedTime (string) –
      
      The timestamp when the outcome was last updated.
    - createdTime (string) –
      
      The timestamp when the outcome was created.
    - arn (string) –
      
      The outcome ARN.
- nextToken (string) –
  
  The next page token for subsequent requests.

Exceptions

FraudDetector.Client.exceptions.ValidationException
FraudDetector.Client.exceptions.ResourceNotFoundException
FraudDetector.Client.exceptions.InternalServerException
FraudDetector.Client.exceptions.ThrottlingException
FraudDetector.Client.exceptions.AccessDeniedException