:doc:`Inspector2 <../../inspector2>` / Client / batch_get_free_trial_info

*************************
batch_get_free_trial_info
*************************



.. py:method:: Inspector2.Client.batch_get_free_trial_info(**kwargs)

  

  Gets free trial status for multiple Amazon Web Services accounts.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/BatchGetFreeTrialInfo>`_  


  **Request Syntax**
  ::

    response = client.batch_get_free_trial_info(
        accountIds=[
            'string',
        ]
    )
    
  :type accountIds: list
  :param accountIds: **[REQUIRED]** 

    The account IDs to get free trial status for.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'accounts': [
              {
                  'accountId': 'string',
                  'freeTrialInfo': [
                      {
                          'type': 'EC2'|'ECR'|'LAMBDA'|'LAMBDA_CODE'|'CODE_REPOSITORY',
                          'start': datetime(2015, 1, 1),
                          'end': datetime(2015, 1, 1),
                          'status': 'ACTIVE'|'INACTIVE'
                      },
                  ]
              },
          ],
          'failedAccounts': [
              {
                  'accountId': 'string',
                  'code': 'ACCESS_DENIED'|'INTERNAL_ERROR',
                  'message': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **accounts** *(list) --* 

        An array of objects that provide Amazon Inspector free trial details for each of the requested accounts.

        
        

        - *(dict) --* 

          Information about the Amazon Inspector free trial for an account.

          
          

          - **accountId** *(string) --* 

            The account associated with the Amazon Inspector free trial information.

            
          

          - **freeTrialInfo** *(list) --* 

            Contains information about the Amazon Inspector free trial for an account.

            
            

            - *(dict) --* 

              An object that contains information about the Amazon Inspector free trial for an account.

              
              

              - **type** *(string) --* 

                The type of scan covered by the Amazon Inspector free trail.

                
              

              - **start** *(datetime) --* 

                The date and time that the Amazon Inspector free trail started for a given account.

                
              

              - **end** *(datetime) --* 

                The date and time that the Amazon Inspector free trail ends for a given account.

                
              

              - **status** *(string) --* 

                The order to sort results by.

                
          
        
      
    
      

      - **failedAccounts** *(list) --* 

        An array of objects detailing any accounts that free trial data could not be returned for.

        
        

        - *(dict) --* 

          Information about an error received while accessing free trail data for an account.

          
          

          - **accountId** *(string) --* 

            The account associated with the Amazon Inspector free trial information.

            
          

          - **code** *(string) --* 

            The error code.

            
          

          - **message** *(string) --* 

            The error message returned.

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

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

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

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

  