GetCoreDefinitionVersion - AWS IoT Greengrass
CLI: Parameters: Responses:

AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.

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. This value maps to the Version property of the corresponding VersionInformation object, which is returned by ListCoreDefinitionVersions requests. If the version is the last one that was associated with a core definition, the value also maps to the LatestVersion property of the corresponding DefinitionInformation object.

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. Maximum length is 128 characters with the pattern [a‑zA‑Z0‑9:_‑]+.

type: string

ThingArn

The ARN of the thing that 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 synced with the cloud automatically.

type: boolean

NextToken

The token for the next set of results, or null if there are no more 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 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