Skip to content

/AWS1/CL_IOT=>REGISTERCACERTIFICATE()

About RegisterCACertificate

Registers a CA certificate with Amazon Web Services IoT Core. There is no limit to the number of CA certificates you can register in your Amazon Web Services account. You can register up to 10 CA certificates with the same CA subject field per Amazon Web Services account.

Requires permission to access the RegisterCACertificate action.

Method Signature

IMPORTING

Required arguments:

IV_CACERTIFICATE TYPE /AWS1/IOTCERTIFICATEPEM /AWS1/IOTCERTIFICATEPEM

The CA certificate.

Optional arguments:

IV_VERIFICATIONCERTIFICATE TYPE /AWS1/IOTCERTIFICATEPEM /AWS1/IOTCERTIFICATEPEM

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

IV_SETASACTIVE TYPE /AWS1/IOTSETASACTIVE /AWS1/IOTSETASACTIVE

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

IV_ALLOWAUTOREGISTRATION TYPE /AWS1/IOTALLOWAUTOREGISTRATION /AWS1/IOTALLOWAUTOREGISTRATION

Allows this CA certificate to be used for auto registration of device certificates.

IO_REGISTRATIONCONFIG TYPE REF TO /AWS1/CL_IOTREGISTRATIONCONFIG /AWS1/CL_IOTREGISTRATIONCONFIG

Information about the registration configuration.

IT_TAGS TYPE /AWS1/CL_IOTTAG=>TT_TAGLIST TT_TAGLIST

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

IV_CERTIFICATEMODE TYPE /AWS1/IOTCERTIFICATEMODE /AWS1/IOTCERTIFICATEMODE

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_IOTREGCACERTRESPONSE /AWS1/CL_IOTREGCACERTRESPONSE