:doc:`IAM <../../iam>` / Paginator / ListServerCertificates

**********************
ListServerCertificates
**********************



.. py:class:: IAM.Paginator.ListServerCertificates

  ::

    
    paginator = client.get_paginator('list_server_certificates')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`IAM.Client.list_server_certificates`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iam-2010-05-08/ListServerCertificates>`_    


    **Request Syntax**
    ::

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

      The path prefix for filtering the results. For example: ``/company/servercerts`` would get all server certificates for which the path starts with ``/company/servercerts``.

       

      This parameter is optional. If it is not included, it defaults to a slash (/), listing all server certificates. This parameter allows (through its `regex pattern <http://wikipedia.org/wiki/regex>`__) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! ( ``\u0021``) through the DEL character ( ``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.

      

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

      
      ::

        {
            'ServerCertificateMetadataList': [
                {
                    'Path': 'string',
                    'ServerCertificateName': 'string',
                    'ServerCertificateId': 'string',
                    'Arn': 'string',
                    'UploadDate': datetime(2015, 1, 1),
                    'Expiration': datetime(2015, 1, 1)
                },
            ],
            'IsTruncated': True|False,
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the response to a successful `ListServerCertificates <https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListServerCertificates.html>`__ request.

        
        

        - **ServerCertificateMetadataList** *(list) --* 

          A list of server certificates.

          
          

          - *(dict) --* 

            Contains information about a server certificate without its certificate body, certificate chain, and private key.

             

            This data type is used as a response element in the `UploadServerCertificate <https://docs.aws.amazon.com/IAM/latest/APIReference/API_UploadServerCertificate.html>`__ and `ListServerCertificates <https://docs.aws.amazon.com/IAM/latest/APIReference/API_ListServerCertificates.html>`__ operations.

            
            

            - **Path** *(string) --* 

              The path to the server certificate. For more information about paths, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **ServerCertificateName** *(string) --* 

              The name that identifies the server certificate.

              
            

            - **ServerCertificateId** *(string) --* 

              The stable and unique string identifying the server certificate. For more information about IDs, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **Arn** *(string) --* 

              The Amazon Resource Name (ARN) specifying the server certificate. For more information about ARNs and how to use them in policies, see `IAM identifiers <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`__ in the *IAM User Guide*.

              
            

            - **UploadDate** *(datetime) --* 

              The date when the server certificate was uploaded.

              
            

            - **Expiration** *(datetime) --* 

              The date on which the certificate is set to expire.

              
        
      
        

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

          A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the ``Marker`` request parameter to retrieve more items. Note that IAM might return fewer than the ``MaxItems`` number of results even when there are more results available. We recommend that you check ``IsTruncated`` after every call to ensure that you receive all your results.

          
        

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

          A token to resume pagination.

          
    