Menu
AWS IoT
Developer Guide

ListCACertificates

ListCACertificates

Lists the CA certificates registered for your AWS account.

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

https

Request syntax:

GET /cacertificates?pageSize=pageSize&marker=marker&isAscendingOrder=ascendingOrder

URI Request Parameters:

Name

Type

Req?

Description

pageSize

PageSize

no

The result page size.

marker

Marker

no

The marker for the next set of results.

ascendingOrder

AscendingOrder

no

Determines the order of the results.

Response syntax:

Content-type: application/json { "certificates": [ { "certificateArn": "string", "certificateId": "string", "status": "string", "creationDate": "timestamp" } ], "nextMarker": "string" }

Response Body Parameters:

Name

Type

Req?

Description

certificates

CACertificates

no

The CA certificates registered in your AWS account.

nextMarker

Marker

no

The current position within the list of CA certificates.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

cli

Synopsis:

aws iot list-ca-certificates \ [--page-size <value>] \ [--marker <value>] \ [--ascending-order | --no-ascending-order] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "pageSize": "integer", "marker": "string", "ascendingOrder": "boolean" }

cli-input-json fields:

Name

Type

Description

pageSize

integer

range- max:250 min:1

The result page size.

marker

string

pattern: [A-Za-z0-9+/]+={0,2}

The marker for the next set of results.

ascendingOrder

boolean

Determines the order of the results.

Output:

{ "certificates": [ { "certificateArn": "string", "certificateId": "string", "status": "string", "creationDate": "timestamp" } ], "nextMarker": "string" }

cli output fields:

Name

Type

Description

certificates

list

member: CACertificate

java class: java.util.List

The CA certificates registered in your AWS account.

certificateArn

string

The ARN of the CA certificate.

certificateId

string

length- max:64 min:64

pattern: (0x)?[a-fA-F0-9]+

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.

enum: ACTIVE | INACTIVE

creationDate

timestamp

The date the CA certificate was created.

nextMarker

string

pattern: [A-Za-z0-9+/]+={0,2}

The current position within the list of CA certificates.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

ServiceUnavailableException

The service is temporarily unavailable.

InternalFailureException

An unexpected error has occurred.