AWS Greengrass
API Reference

GetCoreDefinitionVersion

Retrieves information about a core definition version.

URI: GET /greengrass/definition/cores/CoreDefinitionId/versions/CoreDefinitionVersionId

Produces: application/json

CLI:

aws greengrass get-core-definition-version \ --core-definition-id <value> \ --core-definition-version-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "CoreDefinitionId": "string", "CoreDefinitionVersionId": "string" }

Parameters:

CoreDefinitionId

The ID of the core definition.

where used: path; required: true

type: string

CoreDefinitionVersionId

The ID of the core definition version.

where used: path; required: true

type: string

Responses:

200

success

GetCoreDefinitionVersionResponse

{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }, "NextToken": "string" }
GetCoreDefinitionVersionResponse

type: object

Arn

The ARN of the core definition version.

type: string

Id

The ID of the core definition version.

type: string

Version

The version of the core definition version.

type: string

CreationTimestamp

The time, in milliseconds since the epoch, when the core definition version was created.

type: string

Definition

Information about a core definition version.

type: object

Cores

A list of cores in the core definition version.

type: array

items: Core

Core

Information about a core.

type: object

required: ["Id", "ThingArn", "CertificateArn"]

Id

A descriptive or arbitrary ID for the core. This value must be unique within the core definition version. Max length is 128 characters with pattern [a‑zA‑Z0‑9:_‑]+.

type: string

ThingArn

The ARN of the thing which is the core.

type: string

CertificateArn

The ARN of the certificate associated with the core.

type: string

SyncShadow

If true, the core's local shadow is automatically synced with the cloud.

type: boolean

NextToken

The token for the next set of results, or null if there are no additional results.

type: string

400

invalid request

GeneralError

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