EKS / Client / list_certificate_authorities

list_certificate_authorities¶

EKS.Client.list_certificate_authorities(**kwargs)¶

Lists the certificate authorities (CAs) for your cluster. A cluster has at most two certificate authorities: the outgoing CA that’s currently signing and, during a rotation, one successor CA.

Request Syntax

response = client.list_certificate_authorities(
    clusterName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

clusterName (string) –
[REQUIRED]

The name of your cluster.
maxResults (integer) – The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. If you don’t specify a value, the default is 100 results.
nextToken (string) –
The nextToken value returned from a previous paginated request, where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Note
This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

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) –
  
  The nextToken value to include in a future ListCertificateAuthorities request. When the results of a ListCertificateAuthorities request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.
  
  Note
  This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

Exceptions

EKS.Client.exceptions.ResourceNotFoundException
EKS.Client.exceptions.InvalidParameterException
EKS.Client.exceptions.ServerException
EKS.Client.exceptions.ServiceUnavailableException