IoT / Client / list_ca_certificates

list_ca_certificates#

IoT.Client.list_ca_certificates(**kwargs)#

Lists the CA certificates registered for your Amazon Web Services account.

The results are paginated with a default page size of 25. You can use the returned marker to retrieve additional results.

Requires permission to access the ListCACertificates action.

Request Syntax

response = client.list_ca_certificates(
    pageSize=123,
    marker='string',
    ascendingOrder=True|False,
    templateName='string'
)

Parameters:

pageSize (integer) – The result page size.
marker (string) – The marker for the next set of results.
ascendingOrder (boolean) – Determines the order of the results.
templateName (string) – The name of the provisioning template.

Return type:

dict

Returns:

Response Syntax

{
    'certificates': [
        {
            'certificateArn': 'string',
            'certificateId': 'string',
            'status': 'ACTIVE'|'INACTIVE',
            'creationDate': datetime(2015, 1, 1)
        },
    ],
    'nextMarker': 'string'
}

Response Structure

(dict) –

The output from the ListCACertificates operation.
- certificates (list) –
  
  The CA certificates registered in your Amazon Web Services account.
  - (dict) –
    
    A CA certificate.
    - certificateArn (string) –
      
      The ARN of the CA certificate.
    - certificateId (string) –
      
      The ID of the CA certificate.
    - status (string) –
      
      The status of the CA certificate.
      
      The status value REGISTER_INACTIVE is deprecated and should not be used.
    - creationDate (datetime) –
      
      The date the CA certificate was created.
- nextMarker (string) –
  
  The current position within the list of CA certificates.

Exceptions

IoT.Client.exceptions.InvalidRequestException
IoT.Client.exceptions.ThrottlingException
IoT.Client.exceptions.UnauthorizedException
IoT.Client.exceptions.ServiceUnavailableException
IoT.Client.exceptions.InternalFailureException