FraudDetector / Client / get_models

get_models#

FraudDetector.Client.get_models(**kwargs)#

Gets one or more models. Gets all models for the Amazon Web Services account if no model type and no model id provided. Gets all models for the Amazon Web Services account and model type, if the model type is specified but model id is not provided. Gets a specific model if (model type, model id) tuple is specified.

This is a paginated API. If you provide a null maxResults, this action retrieves a maximum of 10 records per page. If you provide a maxResults, the value must be between 1 and 10. To get the next page results, provide the pagination token from the response as part of your request. A null pagination token fetches the records from the beginning.

See also: AWS API Documentation

Request Syntax

response = client.get_models(
    modelId='string',
    modelType='ONLINE_FRAUD_INSIGHTS'|'TRANSACTION_FRAUD_INSIGHTS'|'ACCOUNT_TAKEOVER_INSIGHTS',
    nextToken='string',
    maxResults=123
)
Parameters:

  • modelId (string) – The model ID.

  • modelType (string) – The model type.

  • nextToken (string) – The next token for the subsequent request.

  • maxResults (integer) – The maximum number of objects to return for the request.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'models': [
        {
            'modelId': 'string',
            'modelType': 'ONLINE_FRAUD_INSIGHTS'|'TRANSACTION_FRAUD_INSIGHTS'|'ACCOUNT_TAKEOVER_INSIGHTS',
            'description': 'string',
            'eventTypeName': 'string',
            'createdTime': 'string',
            'lastUpdatedTime': 'string',
            'arn': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The next page token to be used in subsequent requests.

    • models (list) –

      The array of models.

      • (dict) –

        The model.

        • modelId (string) –

          The model ID.

        • modelType (string) –

          The model type.

        • description (string) –

          The model description.

        • eventTypeName (string) –

          The name of the event type.

        • createdTime (string) –

          Timestamp of when the model was created.

        • lastUpdatedTime (string) –

          Timestamp of last time the model was updated.

        • arn (string) –

          The ARN of the model.

Exceptions