:doc:`LicenseManager <../../license-manager>` / Client / checkout_license

****************
checkout_license
****************



.. py:method:: LicenseManager.Client.checkout_license(**kwargs)

  

  Checks out the specified license.

   

  .. note::

    

    If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/license-manager-2018-08-01/CheckoutLicense>`_  


  **Request Syntax**
  ::

    response = client.checkout_license(
        ProductSKU='string',
        CheckoutType='PROVISIONAL'|'PERPETUAL',
        KeyFingerprint='string',
        Entitlements=[
            {
                'Name': 'string',
                'Value': 'string',
                'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
            },
        ],
        ClientToken='string',
        Beneficiary='string',
        NodeId='string'
    )
    
  :type ProductSKU: string
  :param ProductSKU: **[REQUIRED]** 

    Product SKU.

    

  
  :type CheckoutType: string
  :param CheckoutType: **[REQUIRED]** 

    Checkout type.

    

  
  :type KeyFingerprint: string
  :param KeyFingerprint: **[REQUIRED]** 

    Key fingerprint identifying the license.

    

  
  :type Entitlements: list
  :param Entitlements: **[REQUIRED]** 

    License entitlements.

    

  
    - *(dict) --* 

      Data associated with an entitlement resource.

      

    
      - **Name** *(string) --* **[REQUIRED]** 

        Entitlement data name.

        

      
      - **Value** *(string) --* 

        Entitlement data value.

        

      
      - **Unit** *(string) --* **[REQUIRED]** 

        Entitlement data unit.

        

      
    

  :type ClientToken: string
  :param ClientToken: **[REQUIRED]** 

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    

  
  :type Beneficiary: string
  :param Beneficiary: 

    License beneficiary.

    

  
  :type NodeId: string
  :param NodeId: 

    Node ID.

    

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

    
    ::

      {
          'CheckoutType': 'PROVISIONAL'|'PERPETUAL',
          'LicenseConsumptionToken': 'string',
          'EntitlementsAllowed': [
              {
                  'Name': 'string',
                  'Value': 'string',
                  'Unit': 'Count'|'None'|'Seconds'|'Microseconds'|'Milliseconds'|'Bytes'|'Kilobytes'|'Megabytes'|'Gigabytes'|'Terabytes'|'Bits'|'Kilobits'|'Megabits'|'Gigabits'|'Terabits'|'Percent'|'Bytes/Second'|'Kilobytes/Second'|'Megabytes/Second'|'Gigabytes/Second'|'Terabytes/Second'|'Bits/Second'|'Kilobits/Second'|'Megabits/Second'|'Gigabits/Second'|'Terabits/Second'|'Count/Second'
              },
          ],
          'SignedToken': 'string',
          'NodeId': 'string',
          'IssuedAt': 'string',
          'Expiration': 'string',
          'LicenseArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **CheckoutType** *(string) --* 

        Checkout type.

        
      

      - **LicenseConsumptionToken** *(string) --* 

        License consumption token.

        
      

      - **EntitlementsAllowed** *(list) --* 

        Allowed license entitlements.

        
        

        - *(dict) --* 

          Data associated with an entitlement resource.

          
          

          - **Name** *(string) --* 

            Entitlement data name.

            
          

          - **Value** *(string) --* 

            Entitlement data value.

            
          

          - **Unit** *(string) --* 

            Entitlement data unit.

            
      
    
      

      - **SignedToken** *(string) --* 

        Signed token.

        
      

      - **NodeId** *(string) --* 

        Node ID.

        
      

      - **IssuedAt** *(string) --* 

        Date and time at which the license checkout is issued.

        
      

      - **Expiration** *(string) --* 

        Date and time at which the license checkout expires.

        
      

      - **LicenseArn** *(string) --* 

        Amazon Resource Name (ARN) of the checkout license.

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

  
  *   :py:class:`LicenseManager.Client.exceptions.InvalidParameterValueException`

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

  
  *   :py:class:`LicenseManager.Client.exceptions.NoEntitlementsAllowedException`

  
  *   :py:class:`LicenseManager.Client.exceptions.UnsupportedDigitalSignatureMethodException`

  
  *   :py:class:`LicenseManager.Client.exceptions.RedirectException`

  
  *   :py:class:`LicenseManager.Client.exceptions.AuthorizationException`

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

  
  *   :py:class:`LicenseManager.Client.exceptions.RateLimitExceededException`

  
  *   :py:class:`LicenseManager.Client.exceptions.ServerInternalException`

  