You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 API Reference.
GetGroupCertificateConfiguration
Retrieves the current configuration for the CA used by the group.
URI: GET
/greengrass/groups/
GroupId
/certificateauthorities/configuration/expiry
Produces: application/json
CLI:
aws greengrass get-group-certificate-configuration \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string" }
Parameters:
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: 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