Menu
AWS Greengrass
API Reference

/greengrass/groups/GroupId/certificateauthorities/configuration/expiry

GET

GET /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

Operation ID: GetGroupCertificateConfiguration

Retrieves the current configuration for the CA used by the group.

Produces: application/json

Path Parameters

GroupId

The ID of the AWS Greengrass group.

where used: path; required: true

type: string

CLI

Copy
aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "GroupId": "string" }

Responses

200

Success. The response body contains the PKI Configuration.

GroupCertificateConfiguration

Copy
{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string" }
GroupCertificateConfiguration

Information about a group certificate configuration.

type: object

GroupId

The ID of the group certificate configuration.

type: string

CertificateAuthorityExpiryInMilliseconds

The amount of time remaining before the certificate authority expires, in milliseconds.

type: string

CertificateExpiryInMilliseconds

The amount of time remaining before the certificate expires, in milliseconds.

type: string

400

invalid request

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

500

server error

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

PUT

PUT /greengrass/groups/GroupId/certificateauthorities/configuration/expiry

Operation ID: UpdateGroupCertificateConfiguration

Updates the Certificate expiry time for a group.

Produces: application/json

Body Parameters

UpdateGroupCertificateConfigurationRequestBody

where used: body; required: true

Copy
{ "CertificateExpiryInMilliseconds": "string" }
updateGroupCertificateConfigurationRequest

type: object

required: ["CertificateExpiryInMilliseconds"]

CertificateExpiryInMilliseconds

The amount of time remaining before the certificate expires, in milliseconds.

type: string

Path Parameters

GroupId

The ID of the AWS Greengrass group.

where used: path; required: true

type: string

CLI

Copy
aws greengrass update-group-certificate-configuration \ --group-id <value> \ [--certificate-expiry-in-milliseconds <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

Copy
{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string" }

Responses

200

Success. The response body contains the PKI Configuration.

GroupCertificateConfiguration

Copy
{ "GroupId": "string", "CertificateAuthorityExpiryInMilliseconds": "string", "CertificateExpiryInMilliseconds": "string" }
GroupCertificateConfiguration

Information about a group certificate configuration.

type: object

GroupId

The ID of the group certificate configuration.

type: string

CertificateAuthorityExpiryInMilliseconds

The amount of time remaining before the certificate authority expires, in milliseconds.

type: string

CertificateExpiryInMilliseconds

The amount of time remaining before the certificate expires, in milliseconds.

type: string

400

invalid request

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

500

server error

GeneralError

Copy
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

On this page: