FraudDetector / Client / get_lists_metadata

get_lists_metadata#

FraudDetector.Client.get_lists_metadata(**kwargs)#

Gets the metadata of either all the lists under the account or the specified list.

See also: AWS API Documentation

Request Syntax

response = client.get_lists_metadata(
    name='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • name (string) – The name of the list.

  • 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

{
    'lists': [
        {
            'name': 'string',
            'description': 'string',
            'variableType': 'string',
            'createdTime': 'string',
            'updatedTime': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • lists (list) –

      The metadata of the specified list or all lists under the account.

      • (dict) –

        The metadata of a list.

        • name (string) –

          The name of the list.

        • description (string) –

          The description of the list.

        • variableType (string) –

          The variable type of the list.

        • createdTime (string) –

          The time the list was created.

        • updatedTime (string) –

          The time the list was last updated.

        • arn (string) –

          The ARN of the list.

    • nextToken (string) –

      The next page token.

Exceptions