AWS IoT Greengrass Version 1 no longer receives feature updates, and will receive only security patches and bug fixes until June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/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 Greengrass group.
where used: path; required: true
type: string
CLI
aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string" }
Responses
- 200
-
Success. The response body contains the PKI configuration.
{ "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, in milliseconds, before the certificate authority expires.
type: string
- CertificateExpiryInMilliseconds
-
The amount of time, in milliseconds, before the certificate expires.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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
{ "CertificateExpiryInMilliseconds": "string" }- updateGroupCertificateConfigurationRequest
-
type: object
required: ["CertificateExpiryInMilliseconds"]
- CertificateExpiryInMilliseconds
-
The amount of time, in milliseconds, before the certificate expires.
type: string
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
CLI
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:
{ "GroupId": "string", "CertificateExpiryInMilliseconds": "string" }
Responses
- 200
-
Success. The response body contains the PKI configuration.
{ "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, in milliseconds, before the certificate authority expires.
type: string
- CertificateExpiryInMilliseconds
-
The amount of time, in milliseconds, before the certificate expires.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains 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
