EKS / Paginator / ListCertificateAuthorities

ListCertificateAuthorities¶

class EKS.Paginator.ListCertificateAuthorities¶

paginator = client.get_paginator('list_certificate_authorities')

paginate(**kwargs)¶

Creates an iterator that will paginate through responses from EKS.Client.list_certificate_authorities().

Request Syntax

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

Parameters:

clusterName (string) –
[REQUIRED]

The name of your cluster.
PaginationConfig (dict) –
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.

Return type:

dict

Returns:

Response Syntax

{
    'certificateAuthorities': [
        {
            'id': 'string',
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'EKS'|'CUSTOMER',
            'activatedAt': datetime(2015, 1, 1),
            'activatedBy': 'EKS'|'CUSTOMER',
            'signingStatus': 'NOT_USED'|'ACTIVATING'|'IN_USE',
            'distributionStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'|'DELETING'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- certificateAuthorities (list) –
  
  A list of certificate authority summary objects, each containing basic information about a certificate authority, including its ID, signing status, and distribution status.
  - (dict) –
    
    Summary information about a certificate authority (CA) for an Amazon EKS cluster, returned by ListCertificateAuthorities and the certificate-authority write operations.
    - id (string) –
      
      The unique identifier of the certificate authority.
    - createdAt (datetime) –
      
      The Unix epoch timestamp in seconds for when the certificate authority was created.
    - createdBy (string) –
      
      The entity that created the certificate authority, either CUSTOMER or EKS.
    - activatedAt (datetime) –
      
      The Unix epoch timestamp in seconds for when the certificate authority was last activated. This value is absent if the certificate authority has never been activated.
    - activatedBy (string) –
      
      The entity that most recently activated the certificate authority, either CUSTOMER or EKS.
    - signingStatus (string) –
      
      The signing status of the certificate authority: IN_USE, ACTIVATING, or NOT_USED.
    - distributionStatus (string) –
      
      The distribution status of the certificate authority: IN_PROGRESS, COMPLETE, FAILED, or DELETING.
- NextToken (string) –
  
  A token to resume pagination.