:doc:`CloudFront <../../cloudfront>` / Paginator / ListOriginAccessControls

************************
ListOriginAccessControls
************************



.. py:class:: CloudFront.Paginator.ListOriginAccessControls

  ::

    
    paginator = client.get_paginator('list_origin_access_controls')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudFront.Client.list_origin_access_controls`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/cloudfront-2020-05-31/ListOriginAccessControls>`_    


    **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**

      
      ::

        {
            'OriginAccessControlList': {
                'Marker': 'string',
                'NextMarker': 'string',
                'MaxItems': 123,
                'IsTruncated': True|False,
                'Quantity': 123,
                'Items': [
                    {
                        'Id': 'string',
                        'Description': 'string',
                        'Name': 'string',
                        'SigningProtocol': 'sigv4',
                        'SigningBehavior': 'never'|'always'|'no-override',
                        'OriginAccessControlOriginType': 's3'|'mediastore'|'mediapackagev2'|'lambda'
                    },
                ]
            },
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OriginAccessControlList** *(dict) --* 

          A list of origin access controls.

          
          

          - **Marker** *(string) --* 

            The value of the ``Marker`` field that was provided in the request.

            
          

          - **NextMarker** *(string) --* 

            If there are more items in the list than are in this response, this element is present. It contains the value to use in the ``Marker`` field of another request to continue listing origin access controls.

            
          

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

            The maximum number of origin access controls requested.

            
          

          - **IsTruncated** *(boolean) --* 

            If there are more items in the list than are in this response, this value is ``true``.

            
          

          - **Quantity** *(integer) --* 

            The number of origin access controls returned in the response.

            
          

          - **Items** *(list) --* 

            Contains the origin access controls in the list.

            
            

            - *(dict) --* 

              A CloudFront origin access control.

              
              

              - **Id** *(string) --* 

                The unique identifier of the origin access control.

                
              

              - **Description** *(string) --* 

                A description of the origin access control.

                
              

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

                A unique name that identifies the origin access control.

                
              

              - **SigningProtocol** *(string) --* 

                The signing protocol of the origin access control. The signing protocol determines how CloudFront signs (authenticates) requests. The only valid value is ``sigv4``.

                
              

              - **SigningBehavior** *(string) --* 

                A value that specifies which requests CloudFront signs (adds authentication information to). This field can have one of the following values:

                 

                
                * ``never`` – CloudFront doesn't sign any origin requests.
                 
                * ``always`` – CloudFront signs all origin requests, overwriting the ``Authorization`` header from the viewer request if necessary.
                 
                * ``no-override`` – If the viewer request doesn't contain the ``Authorization`` header, CloudFront signs the origin request. If the viewer request contains the ``Authorization`` header, CloudFront doesn't sign the origin request, but instead passes along the ``Authorization`` header that it received in the viewer request.
                

                
              

              - **OriginAccessControlOriginType** *(string) --* 

                The type of origin that this origin access control is for.

                
          
        
      
        

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

          A token to resume pagination.

          
    