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.
CreateCoreDefinitionVersion
Creates a version of a core definition that has already been defined. Greengrass groups must each contain exactly one Greengrass core.
URI: POST
/greengrass/definition/cores/
CoreDefinitionId
/versions
Produces: application/json
CLI:
aws greengrass create-core-definition-version \ --core-definition-id <value> \ [--cores <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "CoreDefinitionId": "string", "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": "boolean" } ], "AmznClientToken": "string" }
Parameters:
- CoreDefinitionId
-
The ID of the core definition.
where used: path; required: true
type: string
- CreateCoreDefinitionVersionRequestBody
-
where used: body; required: true
{ "Cores": [ { "Id": "string", "ThingArn": "string", "CertificateArn": "string", "SyncShadow": true } ] }
schema:
- CoreDefinitionVersion
-
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
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:
- 200 (CreateCoreDefinitionVersionResponse)
-
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }
- VersionInformation
-
Information about a version.
type: object
- Arn
-
The ARN of the version.
type: string
- Id
-
The ID of the parent definition that the version is associated with.
type: string
- Version
-
The ID of the version.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the version was created.
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