batch_get_variable

FraudDetector.Client.batch_get_variable(**kwargs)

Gets a batch of variables.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_variable(
    names=[
        'string',
    ]
)

Parameters

names (list) --

[REQUIRED]

The list of variable names to get.

• (string) --

Return type

dict

Returns

Response Syntax

{
    'variables': [
        {
            'name': 'string',
            'dataType': 'STRING'|'INTEGER'|'FLOAT'|'BOOLEAN',
            'dataSource': 'EVENT'|'MODEL_SCORE'|'EXTERNAL_MODEL_SCORE',
            'defaultValue': 'string',
            'description': 'string',
            'variableType': 'string',
            'lastUpdatedTime': 'string',
            'createdTime': 'string',
            'arn': 'string'
        },
    ],
    'errors': [
        {
            'name': 'string',
            'code': 123,
            'message': 'string'
        },
    ]
}

Response Structure

• (dict) --
  • variables (list) --

    The returned variables.

    • (dict) --

      The variable.

      • name (string) --

        The name of the variable.

      • dataType (string) --

        The data type of the variable. For more information see Variable types.

      • dataSource (string) --

        The data source of the variable.

      • defaultValue (string) --

        The default value of the variable.

      • description (string) --

        The description of the variable.

      • variableType (string) --

        The variable type of the variable.

        Valid Values: AUTH_CODE | AVS | BILLING_ADDRESS_L1 | BILLING_ADDRESS_L2 | BILLING_CITY | BILLING_COUNTRY | BILLING_NAME | BILLING_PHONE | BILLING_STATE | BILLING_ZIP | CARD_BIN | CATEGORICAL | CURRENCY_CODE | EMAIL_ADDRESS | FINGERPRINT | FRAUD_LABEL | FREE_FORM_TEXT | IP_ADDRESS | NUMERIC | ORDER_ID | PAYMENT_TYPE | PHONE_NUMBER | PRICE | PRODUCT_CATEGORY | SHIPPING_ADDRESS_L1 | SHIPPING_ADDRESS_L2 | SHIPPING_CITY | SHIPPING_COUNTRY | SHIPPING_NAME | SHIPPING_PHONE | SHIPPING_STATE | SHIPPING_ZIP | USERAGENT

      • lastUpdatedTime (string) --

        The time when variable was last updated.

      • createdTime (string) --

        The time when the variable was created.

      • arn (string) --

        The ARN of the variable.

  • errors (list) --

    The errors from the request.

    • (dict) --

      Provides the error of the batch get variable API.

      • name (string) --

        The error name.

      • code (integer) --

        The error code.

      • message (string) --

        The error message.

Exceptions

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