Menu
AWS Greengrass
API Reference

/greengrass/definition/cores/CoreDefinitionId

GET

GET /greengrass/definition/cores/CoreDefinitionId

Operation ID: GetCoreDefinition

Retrieves information about a core definition version.

Produces: application/json

Path Parameters

CoreDefinitionId

The ID of the core definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

{ "CoreDefinitionId": "string" }

Responses

200 (GetCoreDefinitionResponse)

DefinitionInformation

{ "Name": "string", "Id": "string", "Arn": "string", "LastUpdatedTimestamp": "string", "CreationTimestamp": "string", "LatestVersion": "string", "LatestVersionArn": "string" }
DefinitionInformation

Information about a definition.

type: object

Name

The name of the definition.

type: string

Id

The ID of the definition.

type: string

Arn

The ARN of the definition.

type: string

LastUpdatedTimestamp

The time, in milliseconds since the epoch, when the definition was last updated.

type: string

CreationTimestamp

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

type: string

LatestVersion

The latest version of the definition.

type: string

LatestVersionArn

The ARN of the latest version of the definition.

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

DELETE

DELETE /greengrass/definition/cores/CoreDefinitionId

Operation ID: DeleteCoreDefinition

Deletes a core definition.

Produces: application/json

Path Parameters

CoreDefinitionId

The ID of the core definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

{ "CoreDefinitionId": "string" }

Responses

200

success

Empty

{ }
Empty Schema

Empty

type: object

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

PUT

PUT /greengrass/definition/cores/CoreDefinitionId

Operation ID: UpdateCoreDefinition

Updates a core definition.

Produces: application/json

Body Parameters

UpdateDefinitionRequestBody

where used: body; required: true

{ "Name": "string" }
Name

The name of the definition.

required: true

type: string

Path Parameters

CoreDefinitionId

The ID of the core definition.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

{ "CoreDefinitionId": "string", "Name": "string" }

Responses

200

success

Empty

{ }
Empty Schema

Empty

type: object

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

On this page: