Menu
AWS Greengrass
API Reference

/greengrass/groups/GroupId/certificateauthorities

GET

GET /greengrass/groups/GroupId/certificateauthorities

Operation ID: ListGroupCertificateAuthorities

Retrieves the current CAs for a 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 list-group-certificate-authorities \ --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.

ListGroupCertificateAuthoritiesResponse

Copy
{ "GroupCertificateAuthorities": [ { "GroupCertificateAuthorityId": "string", "GroupCertificateAuthorityArn": "string" } ] }
ListGroupCertificateAuthoritiesResponse

type: object

GroupCertificateAuthorities

A list of certificate authorities associated with the group.

type: array

items: GroupCertificateAuthorityProperties

Group Certificate Authority Properties

Information about a certificate authority for a group.

type: object

GroupCertificateAuthorityId

The ID of the certificate authority for the group.

type: string

GroupCertificateAuthorityArn

The ARN of the certificate authority for the group.

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

POST

POST /greengrass/groups/GroupId/certificateauthorities

Operation ID: CreateGroupCertificateAuthority

Creates a CA for the group. If a CA already exists, it will rotate the existing CA.

Produces: application/json

Header Parameters

X-Amzn-Client-Token

A client token used to make idempotent requests. Provide a unique token to help prevent duplicate updates from being created due to internal retries.

where used: header; required: false

type: string

Path Parameters

GroupId

The ID of the AWS Greengrass group.

where used: path; required: true

type: string

CLI

Copy
aws greengrass create-group-certificate-authority \ --group-id <value> \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

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

Responses

200

Success. The response body contains the new active CA ARN.

CreateGroupCertificateAuthorityResponse

Copy
{ "GroupCertificateAuthorityArn": "string" }
CreateGroupCertificateAuthorityResponse

type: object

GroupCertificateAuthorityArn

The ARN of the group certificate authority.

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: