:doc:`Artifact <../../artifact>` / Paginator / ListCustomerAgreements

**********************
ListCustomerAgreements
**********************



.. py:class:: Artifact.Paginator.ListCustomerAgreements

  ::

    
    paginator = client.get_paginator('list_customer_agreements')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Artifact.Client.list_customer_agreements`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/artifact-2018-05-10/ListCustomerAgreements>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

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

      
      ::

        {
            'customerAgreements': [
                {
                    'name': 'string',
                    'arn': 'string',
                    'id': 'string',
                    'agreementArn': 'string',
                    'awsAccountId': 'string',
                    'organizationArn': 'string',
                    'effectiveStart': datetime(2015, 1, 1),
                    'effectiveEnd': datetime(2015, 1, 1),
                    'state': 'ACTIVE'|'CUSTOMER_TERMINATED'|'AWS_TERMINATED',
                    'description': 'string',
                    'acceptanceTerms': [
                        'string',
                    ],
                    'terminateTerms': [
                        'string',
                    ],
                    'type': 'CUSTOM'|'DEFAULT'|'MODIFIED'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **customerAgreements** *(list) --* 

          List of customer-agreement resources.

          
          

          - *(dict) --* 

            Summary for customer-agreement resource.

            
            

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

              Name of the customer-agreement resource.

              
            

            - **arn** *(string) --* 

              ARN of the customer-agreement resource.

              
            

            - **id** *(string) --* 

              Identifier of the customer-agreement resource.

              
            

            - **agreementArn** *(string) --* 

              ARN of the agreement resource the customer-agreement resource represents.

              
            

            - **awsAccountId** *(string) --* 

              AWS account Id that owns the resource.

              
            

            - **organizationArn** *(string) --* 

              ARN of the organization that owns the resource.

              
            

            - **effectiveStart** *(datetime) --* 

              Timestamp indicating when the agreement became effective.

              
            

            - **effectiveEnd** *(datetime) --* 

              Timestamp indicating when the agreement was terminated.

              
            

            - **state** *(string) --* 

              State of the resource.

              
            

            - **description** *(string) --* 

              Description of the resource.

              
            

            - **acceptanceTerms** *(list) --* 

              Terms required to accept the agreement resource.

              
              

              - *(string) --* 
          
            

            - **terminateTerms** *(list) --* 

              Terms required to terminate the customer-agreement resource.

              
              

              - *(string) --* 
          
            

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

              Type of the customer-agreement resource.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    