:doc:`FraudDetector <../../frauddetector>` / Client / get_variables

*************
get_variables
*************



.. py:method:: FraudDetector.Client.get_variables(**kwargs)

  

  Gets all of the variables or the specific variable. This is a paginated API. Providing null ``maxSizePerPage`` results in retrieving maximum of 100 records per page. If you provide ``maxSizePerPage`` the value must be between 50 and 100. To get the next page result, a provide a pagination token from ``GetVariablesResult`` as part of your request. Null pagination token fetches the records from the beginning.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/frauddetector-2019-11-15/GetVariables>`_  


  **Request Syntax**
  ::

    response = client.get_variables(
        name='string',
        nextToken='string',
        maxResults=123
    )
    
  :type name: string
  :param name: 

    The name of the variable.

    

  
  :type nextToken: string
  :param nextToken: 

    The next page token of the get variable request.

    

  
  :type maxResults: integer
  :param maxResults: 

    The max size per page determined for the get variable request.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'variables': [
              {
                  'name': 'string',
                  'dataType': 'STRING'|'INTEGER'|'FLOAT'|'BOOLEAN'|'DATETIME',
                  'dataSource': 'EVENT'|'MODEL_SCORE'|'EXTERNAL_MODEL_SCORE',
                  'defaultValue': 'string',
                  'description': 'string',
                  'variableType': 'string',
                  'lastUpdatedTime': 'string',
                  'createdTime': 'string',
                  'arn': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **variables** *(list) --* 

        The names of the variables returned.

        
        

        - *(dict) --* 

          The variable.

          
          

          - **name** *(string) --* 

            The name of the variable.

            
          

          - **dataType** *(string) --* 

            The data type of the variable. For more information see `Variable types <https://docs.aws.amazon.com/frauddetector/latest/ug/create-a-variable.html#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.

            
      
    
      

      - **nextToken** *(string) --* 

        The next page token to be used in subsequent requests.

        
  
  **Exceptions**
  
  *   :py:class:`FraudDetector.Client.exceptions.ValidationException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`FraudDetector.Client.exceptions.InternalServerException`

  
  *   :py:class:`FraudDetector.Client.exceptions.ThrottlingException`

  
  *   :py:class:`FraudDetector.Client.exceptions.AccessDeniedException`

  