GetGroupCertificateAuthority - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

You are viewing the documentation for Amazon IoT Greengrass Version 1. Amazon IoT Greengrass Version 2 is the latest major version of Amazon IoT Greengrass. For more information about the Amazon IoT Greengrass V2 API, see the Amazon IoT Greengrass Version 2 API Reference.

GetGroupCertificateAuthority

Retreives the CA associated with a group. Returns the public key of the CA.

URI: GET /greengrass/groups/GroupId/certificateauthorities/CertificateAuthorityId

Produces: application/json

CLI:

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

cli-input-json format:

{ "GroupId": "string", "CertificateAuthorityId": "string" }

Parameters:

GroupId

The ID of the Greengrass group.

where used: path; required: true

type: string

CertificateAuthorityId

The ID of the certificate authority.

where used: path; required: true

type: string

Responses:

200

Success. The response body contains the PKI configuration.

GetGroupCertificateAuthorityResponse

{ "PemEncodedCertificate": "string", "GroupCertificateAuthorityArn": "string", "GroupCertificateAuthorityId": "string" }
GetGroupCertificateAuthorityResponse

Information about a certificate authority for a group.

type: object

PemEncodedCertificate

The PEM encoded certificate for the group.

type: string

GroupCertificateAuthorityArn

The ARN of the certificate authority for the group.

type: string

GroupCertificateAuthorityId

The ID of the certificate authority for the group.

type: string

400

Invalid request.

GeneralError

{ "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.

GeneralError

{ "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