End of support notice: On October 7th, 2026, AWS will discontinue support for AWS IoT Greengrass Version 1. After October 7th, 2026, you will no longer be able to access the AWS IoT Greengrass V1 resources. For more information, please visit [Migrate from AWS IoT Greengrass Version 1](https://docs.aws.amazon.com/greengrass/v2/developerguide/migrate-from-v1.html).
# Greengrass V1 API
AWS IoT Greengrass provides a resource-based API that uses Hypertext Application Language (HAL). HAL provides a standard way for expressing the resources and relationships of an API as hyperlinks. Using HAL, you use HTTP methods (GET, PUT, POST, DELETE) to submit requests and receive information about the API in the response. Applications can use the information returned to explore the functionality of the API. For more information about HAL, see the [JSON Hypertext Application Language](https://www.ietf.org/archive/id/draft-kelly-json-hal-11.html) draft.
To request a HAL response from AWS IoT Greengrass, specify application/hal\$1json for the accept request header.
For more information about how AWS IoT Greengrass works, see the [https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html](https://docs.aws.amazon.com/greengrass/latest/developerguide/what-is-gg.html).
**Topics**
+ [
# Actions
](api-actions.md)
+ [
# Endpoints
](api-endpoints.md)
+ [
# Parameters
](api-parameters.md)
+ [
# Definitions
](api-definitions.md)
# Actions
**Topics**
+ [
# AssociateRoleToGroup
](associateroletogroup-put.md)
+ [
# AssociateServiceRoleToAccount
](associateserviceroletoaccount-put.md)
+ [
# CreateConnectorDefinition
](createconnectordefinition-post.md)
+ [
# CreateConnectorDefinitionVersion
](createconnectordefinitionversion-post.md)
+ [
# CreateCoreDefinition
](createcoredefinition-post.md)
+ [
# CreateCoreDefinitionVersion
](createcoredefinitionversion-post.md)
+ [
# CreateDeployment
](createdeployment-post.md)
+ [
# CreateDeviceDefinition
](createdevicedefinition-post.md)
+ [
# CreateDeviceDefinitionVersion
](createdevicedefinitionversion-post.md)
+ [
# CreateFunctionDefinition
](createfunctiondefinition-post.md)
+ [
# CreateFunctionDefinitionVersion
](createfunctiondefinitionversion-post.md)
+ [
# CreateGroup
](creategroup-post.md)
+ [
# CreateGroupCertificateAuthority
](creategroupcertificateauthority-post.md)
+ [
# CreateGroupVersion
](creategroupversion-post.md)
+ [
# CreateLoggerDefinition
](createloggerdefinition-post.md)
+ [
# CreateLoggerDefinitionVersion
](createloggerdefinitionversion-post.md)
+ [
# CreateResourceDefinition
](createresourcedefinition-post.md)
+ [
# CreateResourceDefinitionVersion
](createresourcedefinitionversion-post.md)
+ [
# CreateSoftwareUpdateJob
](createsoftwareupdatejob-post.md)
+ [
# CreateSubscriptionDefinition
](createsubscriptiondefinition-post.md)
+ [
# CreateSubscriptionDefinitionVersion
](createsubscriptiondefinitionversion-post.md)
+ [
# DeleteConnectorDefinition
](deleteconnectordefinition-delete.md)
+ [
# DeleteCoreDefinition
](deletecoredefinition-delete.md)
+ [
# DeleteDeviceDefinition
](deletedevicedefinition-delete.md)
+ [
# DeleteFunctionDefinition
](deletefunctiondefinition-delete.md)
+ [
# DeleteGroup
](deletegroup-delete.md)
+ [
# DeleteLoggerDefinition
](deleteloggerdefinition-delete.md)
+ [
# DeleteResourceDefinition
](deleteresourcedefinition-delete.md)
+ [
# DeleteSubscriptionDefinition
](deletesubscriptiondefinition-delete.md)
+ [
# DisassociateRoleFromGroup
](disassociaterolefromgroup-delete.md)
+ [
# DisassociateServiceRoleFromAccount
](disassociateservicerolefromaccount-delete.md)
+ [
# GetAssociatedRole
](getassociatedrole-get.md)
+ [
# GetBulkDeploymentStatus
](getbulkdeploymentstatus-get.md)
+ [
# GetConnectivityInfo
](getconnectivityinfo-get.md)
+ [
# GetConnectorDefinition
](getconnectordefinition-get.md)
+ [
# GetConnectorDefinitionVersion
](getconnectordefinitionversion-get.md)
+ [
# GetCoreDefinition
](getcoredefinition-get.md)
+ [
# GetCoreDefinitionVersion
](getcoredefinitionversion-get.md)
+ [
# GetDeploymentStatus
](getdeploymentstatus-get.md)
+ [
# GetDeviceDefinition
](getdevicedefinition-get.md)
+ [
# GetDeviceDefinitionVersion
](getdevicedefinitionversion-get.md)
+ [
# GetFunctionDefinition
](getfunctiondefinition-get.md)
+ [
# GetFunctionDefinitionVersion
](getfunctiondefinitionversion-get.md)
+ [
# GetGroup
](getgroup-get.md)
+ [
# GetGroupCertificateAuthority
](getgroupcertificateauthority-get.md)
+ [
# GetGroupCertificateConfiguration
](getgroupcertificateconfiguration-get.md)
+ [
# GetGroupVersion
](getgroupversion-get.md)
+ [
# GetLoggerDefinition
](getloggerdefinition-get.md)
+ [
# GetLoggerDefinitionVersion
](getloggerdefinitionversion-get.md)
+ [
# GetResourceDefinition
](getresourcedefinition-get.md)
+ [
# GetResourceDefinitionVersion
](getresourcedefinitionversion-get.md)
+ [
# GetServiceRoleForAccount
](getserviceroleforaccount-get.md)
+ [
# GetSubscriptionDefinition
](getsubscriptiondefinition-get.md)
+ [
# GetSubscriptionDefinitionVersion
](getsubscriptiondefinitionversion-get.md)
+ [
# GetThingRuntimeConfiguration
](getthingruntimeconfiguration-get.md)
+ [
# ListBulkDeploymentDetailedReports
](listbulkdeploymentdetailedreports-get.md)
+ [
# ListBulkDeployments
](listbulkdeployments-get.md)
+ [
# ListConnectorDefinitionVersions
](listconnectordefinitionversions-get.md)
+ [
# ListConnectorDefinitions
](listconnectordefinitions-get.md)
+ [
# ListCoreDefinitionVersions
](listcoredefinitionversions-get.md)
+ [
# ListCoreDefinitions
](listcoredefinitions-get.md)
+ [
# ListDeployments
](listdeployments-get.md)
+ [
# ListDeviceDefinitionVersions
](listdevicedefinitionversions-get.md)
+ [
# ListDeviceDefinitions
](listdevicedefinitions-get.md)
+ [
# ListFunctionDefinitionVersions
](listfunctiondefinitionversions-get.md)
+ [
# ListFunctionDefinitions
](listfunctiondefinitions-get.md)
+ [
# ListGroupCertificateAuthorities
](listgroupcertificateauthorities-get.md)
+ [
# ListGroupVersions
](listgroupversions-get.md)
+ [
# ListGroups
](listgroups-get.md)
+ [
# ListLoggerDefinitionVersions
](listloggerdefinitionversions-get.md)
+ [
# ListLoggerDefinitions
](listloggerdefinitions-get.md)
+ [
# ListResourceDefinitionVersions
](listresourcedefinitionversions-get.md)
+ [
# ListResourceDefinitions
](listresourcedefinitions-get.md)
+ [
# ListSubscriptionDefinitionVersions
](listsubscriptiondefinitionversions-get.md)
+ [
# ListSubscriptionDefinitions
](listsubscriptiondefinitions-get.md)
+ [
# ListTagsForResource
](listtagsforresource-get.md)
+ [
# ResetDeployments
](resetdeployments-post.md)
+ [
# StartBulkDeployment
](startbulkdeployment-post.md)
+ [
# StopBulkDeployment
](stopbulkdeployment-put.md)
+ [
# TagResource
](tagresource-post.md)
+ [
# UntagResource
](untagresource-delete.md)
+ [
# UpdateConnectivityInfo
](updateconnectivityinfo-put.md)
+ [
# UpdateConnectorDefinition
](updateconnectordefinition-put.md)
+ [
# UpdateCoreDefinition
](updatecoredefinition-put.md)
+ [
# UpdateDeviceDefinition
](updatedevicedefinition-put.md)
+ [
# UpdateFunctionDefinition
](updatefunctiondefinition-put.md)
+ [
# UpdateGroup
](updategroup-put.md)
+ [
# UpdateGroupCertificateConfiguration
](updategroupcertificateconfiguration-put.md)
+ [
# UpdateLoggerDefinition
](updateloggerdefinition-put.md)
+ [
# UpdateResourceDefinition
](updateresourcedefinition-put.md)
+ [
# UpdateSubscriptionDefinition
](updatesubscriptiondefinition-put.md)
+ [
# UpdateThingRuntimeConfiguration
](updatethingruntimeconfiguration-put.md)
# AssociateRoleToGroup
Associates a role with a group. Your Greengrass core uses the role to access AWS services. The role's permissions should allow Greengrass Lambda functions and connectors to perform actions against the cloud.
URI: `PUT /greengrass/groups/GroupId/role`
## CLI:
```
aws greengrass associate-role-to-group \
--group-id \
[--role-arn ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"RoleArn": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**AssociateRoleToGroupRequestBody**](parameters-associateroletogrouprequestbody.md)
where used: body; required: true
```
{
"RoleArn": "string"
}
```
schema:
AssociateRoleToGroupRequest
type: object
required: ["RoleArn"]
RoleArn
The ARN of the role to associate with this group.
type: string
## Responses:
**200**
Success.
[ AssociateRoleToGroupResponse](definitions-associateroletogroupresponse.md)
```
{
"AssociatedAt": "string"
}
```
Group
type: object
AssociatedAt
The time, in milliseconds since the epoch, when the role ARN was associated with the group.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# AssociateServiceRoleToAccount
Associates a role with your account. AWS IoT Greengrass uses the role to access your Lambda functions and AWS IoT resources. A role is required for deployments to succeed. The role must have at least minimum permissions in the policy `AWSGreengrassResourceAccessRolePolicy`.
URI: `PUT /greengrass/servicerole`
## CLI:
```
aws greengrass associate-service-role-to-account \
[--role-arn ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"RoleArn": "string"
}
```
## Parameters:
[**AssociateServiceRoleToAccountRequestBody**](parameters-associateserviceroletoaccountrequestbody.md)
where used: body; required: true
```
{
"RoleArn": "string"
}
```
schema:
AssociateServiceRoleToAccountRequest
type: object
required: ["RoleArn"]
RoleArn
The ARN of the service role to associate with your account.
type: string
## Responses:
**200**
Success.
[ AssociateServiceRoleToAccountResponse](definitions-associateserviceroletoaccountresponse.md)
```
{
"AssociatedAt": "string"
}
```
AssociateServiceRoleToAccountResponse
type: object
AssociatedAt
The time when the service role was associated with the account.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateConnectorDefinition
Creates a connector definition. You can provide the initial version of the connector definition now or use `CreateConnectorDefinitionVersion` later.
URI: `POST /greengrass/definition/connectors`
Produces: application/json
## CLI:
```
aws greengrass create-connector-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Connectors": [
{
"Id": "string",
"ConnectorArn": "string",
"Parameters": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateConnectorDefinitionRequestBody**](parameters-createconnectordefinitionrequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Connectors": [
{
"Id": "string",
"ConnectorArn": "string",
"Parameters": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the connector definition.
type: string
InitialVersion
Information about the connector definition version, which is a container for connectors.
type: object
Connectors
A list of references to connectors in this version, with their corresponding configuration settings.
type: array
items: [Connector](definitions-connector.md)
Connector
Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
type: object
required: ["Id", "ConnectorArn"]
Id
A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with the pattern [a-zA-Z0-9:\$1-]\$1.
type: string
ConnectorArn
The ARN of the connector.
type: string
Parameters
The parameters or configuration used by the connector.
type: object
additionalProperties: An object with properties of type `string` that represent the connector configuration.
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to enforce the idempotency of this API.
where used: header; required: false
type: string
## Responses:
**200** (CreateConnectorDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateConnectorDefinitionVersion
Creates a version of a connector definition that has already been defined.
URI: `POST /greengrass/definition/connectors/ConnectorDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-connector-definition-version \
--connector-definition-id \
[--connectors ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ConnectorDefinitionId": "string",
"Connectors": [
{
"Id": "string",
"ConnectorArn": "string",
"Parameters": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**ConnectorDefinitionId**](parameters-connectordefinitionidparam.md)
The ID of the connector definition.
where used: path; required: true
type: string
[**CreateConnectorDefinitionVersionRequestBody**](parameters-createconnectordefinitionversionrequestbody.md)
where used: body; required: true
```
{
"Connectors": [
{
"Id": "string",
"ConnectorArn": "string",
"Parameters": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
]
}
```
schema:
ConnectorDefinitionVersion
Information about the connector definition version, which is a container for connectors.
type: object
Connectors
A list of references to connectors in this version, with their corresponding configuration settings.
type: array
items: [Connector](definitions-connector.md)
Connector
Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
type: object
required: ["Id", "ConnectorArn"]
Id
A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with the pattern [a-zA-Z0-9:\$1-]\$1.
type: string
ConnectorArn
The ARN of the connector.
type: string
Parameters
The parameters or configuration used by the connector.
type: object
additionalProperties: An object with properties of type `string` that represent the connector configuration.
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to enforce the idempotency of this API.
where used: header; required: false
type: string
## Responses:
**200** (CreateConnectorDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateCoreDefinition
Creates a core definition. You can provide the initial version of the core definition now or use `CreateCoreDefinitionVersion` later. Greengrass groups must each contain exactly one Greengrass core.
URI: `POST /greengrass/definition/cores`
Produces: application/json
## CLI:
```
aws greengrass create-core-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Cores": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": "boolean"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateCoreDefinitionRequestBody**](parameters-createcoredefinitionrequestbody.md)
Information required to create a core definition.
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Cores": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": true
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the core definition.
type: string
InitialVersion
Information about a core definition version.
type: object
Cores
A list of cores in the core definition version.
type: array
items: [Core](definitions-core.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateCoreDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# 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 \
[--cores ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"CoreDefinitionId": "string",
"Cores": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": "boolean"
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**CoreDefinitionId**](parameters-coredefinitionidparam.md)
The ID of the core definition.
where used: path; required: true
type: string
[**CreateCoreDefinitionVersionRequestBody**](parameters-createcoredefinitionversionrequestbody.md)
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](definitions-core.md)
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**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateCoreDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateDeployment
Creates a deployment. `CreateDeployment` requests are idempotent with respect to the `X-Amzn-Client-Token` token and the request parameters.
URI: `POST /greengrass/groups/GroupId/deployments`
Produces: application/json
## CLI:
```
aws greengrass create-deployment \
--group-id \
[--deployment-type ] \
[--deployment-id ] \
[--group-version-id ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"DeploymentId": "string",
"GroupVersionId": "string",
"AmznClientToken": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**CreateDeploymentRequestBody**](parameters-createdeploymentrequestbody.md)
where used: body; required: true
```
{
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"DeploymentId": "string",
"GroupVersionId": "string"
}
```
schema:
CreateDeploymentRequest
Information about a deployment.
type: object
required: ["DeploymentType"]
DeploymentType
The type of deployment. When used for `CreateDeployment`, only `NewDeployment` and `Redeployment` are valid.
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
DeploymentId
The ID of the previous deployment you want to redeploy.
type: string
GroupVersionId
The ID of the group version to be deployed.
type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200**
Success. The group was deployed.
[ CreateDeploymentResponse](definitions-createdeploymentresponse.md)
```
{
"DeploymentArn": "string",
"DeploymentId": "string"
}
```
CreateDeploymentResponse
type: object
DeploymentArn
The ARN of the deployment.
type: string
DeploymentId
The ID of the deployment.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateDeviceDefinition
Creates a client device definition. You can provide the initial version of the device definition now or use `CreateDeviceDefinitionVersion` later.
URI: `POST /greengrass/definition/devices`
Produces: application/json
## CLI:
```
aws greengrass create-device-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Devices": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": "boolean"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateDeviceDefinitionRequestBody**](parameters-createdevicedefinitionrequestbody.md)
Information required to create a device definition.
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Devices": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": true
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the device definition.
type: string
InitialVersion
Information about a device definition version.
type: object
Devices
A list of client devices in the definition version.
type: array
items: [Device](definitions-device.md)
Device
Information about a client device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]
Id
A descriptive or arbitrary ID for the client device. This value must be unique within the device definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
ThingArn
The thing ARN of the client device.
type: string
CertificateArn
The ARN of the certificate associated with the client device.
type: string
SyncShadow
If true, the client device's local shadow is synced with the cloud automatically.
type: boolean
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateDeviceDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateDeviceDefinitionVersion
Creates a version of a client device definition that has already been defined.
URI: `POST /greengrass/definition/devices/DeviceDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-device-definition-version \
--device-definition-id \
[--devices ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"DeviceDefinitionId": "string",
"Devices": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": "boolean"
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**DeviceDefinitionId**](parameters-devicedefinitionidparam.md)
The ID of the device definition.
where used: path; required: true
type: string
[**CreateDeviceDefinitionVersionRequestBody**](parameters-createdevicedefinitionversionrequestbody.md)
where used: body; required: true
```
{
"Devices": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": true
}
]
}
```
schema:
DeviceDefinitionVersion
Information about a device definition version.
type: object
Devices
A list of client devices in the definition version.
type: array
items: [Device](definitions-device.md)
Device
Information about a client device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]
Id
A descriptive or arbitrary ID for the client device. This value must be unique within the device definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
ThingArn
The thing ARN of the client device.
type: string
CertificateArn
The ARN of the certificate associated with the client device.
type: string
SyncShadow
If true, the client device's local shadow is synced with the cloud automatically.
type: boolean
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateDeviceDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateFunctionDefinition
Creates a function definition that contains a list of Lambda functions and their configurations to use in a group. You can create an initial version of the definition now by providing a list of Lambda functions and their configurations, or later by using `CreateFunctionDefinitionVersion`.
URI: `POST /greengrass/definition/functions`
Produces: application/json
## CLI:
```
aws greengrass create-function-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"DefaultConfig": {
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": "integer",
"Gid": "integer"
}
}
},
"Functions": [
{
"Id": "string",
"FunctionArn": "string",
"FunctionConfiguration": {
"Pinned": "boolean",
"Executable": "string",
"ExecArgs": "string",
"MemorySize": "integer",
"Timeout": "integer",
"EncodingType": "binary|json",
"Environment": {
"Variables": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"ResourceAccessPolicies": [
{
"ResourceId": "string",
"Permission": "ro|rw"
}
],
"AccessSysfs": "boolean",
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": "integer",
"Gid": "integer"
}
}
},
"FunctionRuntimeOverride": "string"
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateFunctionDefinitionRequestBody**](parameters-createfunctiondefinitionrequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"DefaultConfig": {
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"Functions": [
{
"Id": "string",
"FunctionArn": "string",
"FunctionConfiguration": {
"Pinned": true,
"Executable": "string",
"ExecArgs": "string",
"MemorySize": 0,
"Timeout": 0,
"EncodingType": "binary|json",
"Environment": {
"Variables": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"ResourceAccessPolicies": [
{
"ResourceId": "string",
"Permission": "ro|rw"
}
],
"AccessSysfs": true,
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"FuntionRuntimeOverride": "string"
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the function definition.
type: string
InitialVersion
Information about a function definition version.
type: object
DefaultConfig
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
type: object
Execution
Configuration information that specifies how a Lambda function runs.
Functions
A list of Lambda functions in this function definition version.
type: array
items: [Function](definitions-function.md)
Information about a Lambda function.
type: object
required: ["Id"]
Id
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
FunctionArn
The ARN of the alias (recommended) or version of the target Lambda function.
type: string
FunctionConfiguration
The configuration of the Lambda function.
type: object
Pinned
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
type: boolean
Executable
The name of the function executable.
type: string
ExecArgs
The execution arguments.
type: string
MemorySize
The memory size, in KB, required by the function. This setting does not apply and should be cleared when you run the Lambda function without containerization.
type: integer
Timeout
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
type: integer
EncodingType
The expected encoding type of the input payload for the function. The default is `json`.
type: string
enum: ["binary", "json"]
Environment
The environment configuration of the function.
type: object
Variables
Environment variables for the Lambda function's configuration.
type: object
additionalProperties: An object with properties of type `string` that represent the environment variables.
ResourceAccessPolicies
A list of the resources, with their permissions, to which the Lambda function is granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies applies only when you run the Lambda function in a Greengrass container.
type: array
items: [ResourceAccessPolicy](definitions-resourceaccesspolicy.md)
ResourceAccessPolicy
A policy used by the function to access a resource.
type: object
required: ["ResourceId"]
ResourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
type: string
Permission
The type of permission a function has to access a resource.
type: string
enum: ["ro", "rw"]
AccessSysfs
If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
type: boolean
Execution
Configuration information that specifies how a Lambda function runs.
type: object
IsolationMode
Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
type: string
enum: ["GreengrassContainer", "NoContainer"]
RunAs
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. To minimize the risk of unintended changes or malicious attacks, we recommend that you avoid running as root unless absolutely necessary. To run as root, you must update config.json in `greengrass-root/config` to set `allowFunctionsToRunAsRoot` to `yes`.
type: object
Uid
The user ID whose permissions are used to run a Lambda function.
type: integer
Gid
The group ID whose permissions are used to run a Lambda function.
type: integer
FunctionRuntimeOverride
The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
type: string
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateFunctionDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateFunctionDefinitionVersion
Creates a version of a Lambda function definition that has already been defined.
URI: `POST /greengrass/definition/functions/FunctionDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-function-definition-version \
--function-definition-id \
[--default-config ] \
[--functions ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"FunctionDefinitionId": "string",
"DefaultConfig": {
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": "integer",
"Gid": "integer"
}
}
},
"Functions": [
{
"Id": "string",
"FunctionArn": "string",
"FunctionConfiguration": {
"Pinned": "boolean",
"Executable": "string",
"ExecArgs": "string",
"MemorySize": "integer",
"Timeout": "integer",
"EncodingType": "binary|json",
"Environment": {
"Variables": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"ResourceAccessPolicies": [
{
"ResourceId": "string",
"Permission": "ro|rw"
}
],
"AccessSysfs": "boolean",
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": "integer",
"Gid": "integer"
}
}
},
"FunctionRuntimeOverride": "string"
}
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**FunctionDefinitionId**](parameters-functiondefinitionidparam.md)
The ID of the function definition.
where used: path; required: true
type: string
[**CreateFunctionDefinitionVersionRequestBody**](parameters-createfunctiondefinitionversionrequestbody.md)
Information about the function definition version.
where used: body; required: true
```
{
"DefaultConfig": {
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"Functions": [
{
"Id": "string",
"FunctionArn": "string",
"FunctionConfiguration": {
"Pinned": true,
"Executable": "string",
"ExecArgs": "string",
"MemorySize": 0,
"Timeout": 0,
"EncodingType": "binary|json",
"Environment": {
"Variables": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"ResourceAccessPolicies": [
{
"ResourceId": "string",
"Permission": "ro|rw"
}
],
"AccessSysfs": true,
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"FunctionRuntimeOverride": "string"
}
}
]
}
```
schema:
FunctionDefinitionVersion
Information about a function definition version.
type: object
DefaultConfig
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
type: object
Execution
Configuration information that specifies how a Lambda function runs.
Functions
A list of Lambda functions in this function definition version.
type: array
items: [Function](definitions-function.md)
Information about a Lambda function.
type: object
required: ["Id"]
Id
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
FunctionArn
The ARN of the alias (recommended) or version of the target Lambda function.
type: string
FunctionConfiguration
The configuration of the Lambda function.
type: object
Pinned
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
type: boolean
Executable
The name of the function executable.
type: string
ExecArgs
The execution arguments.
type: string
MemorySize
The memory size, in KB, required by the function. This setting does not apply and should be cleared when you run the Lambda function without containerization.
type: integer
Timeout
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
type: integer
EncodingType
The expected encoding type of the input payload for the function. The default is `json`.
type: string
enum: ["binary", "json"]
Environment
The environment configuration of the function.
type: object
Variables
Environment variables for the Lambda function's configuration.
type: object
additionalProperties: An object with properties of type `string` that represent the environment variables.
ResourceAccessPolicies
A list of the resources, with their permissions, to which the Lambda function is granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies applies only when you run the Lambda function in a Greengrass container.
type: array
items: [ResourceAccessPolicy](definitions-resourceaccesspolicy.md)
ResourceAccessPolicy
A policy used by the function to access a resource.
type: object
required: ["ResourceId"]
ResourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
type: string
Permission
The type of permission a function has to access a resource.
type: string
enum: ["ro", "rw"]
AccessSysfs
If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
type: boolean
Execution
Configuration information that specifies how a Lambda function runs.
type: object
IsolationMode
Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
type: string
enum: ["GreengrassContainer", "NoContainer"]
RunAs
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. To minimize the risk of unintended changes or malicious attacks, we recommend that you avoid running as root unless absolutely necessary. To run as root, you must update config.json in `greengrass-root/config` to set `allowFunctionsToRunAsRoot` to `yes`.
type: object
Uid
The user ID whose permissions are used to run a Lambda function.
type: integer
Gid
The group ID whose permissions are used to run a Lambda function.
type: integer
FunctionRuntimeOverride
The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateFunctionDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateGroup
Creates a group. You can provide the initial version of the group or use `CreateGroupVersion` at a later time. Tip: You can use the `gg_group_setup` package (https://github.com/awslabs/aws-greengrass-group-setup) as a library or command-line application to create and deploy Greengrass groups.
URI: `POST /greengrass/groups`
Produces: application/json
## CLI:
```
aws greengrass create-group \
--name \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string"
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateGroupRequestBody**](parameters-creategrouprequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string"
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the group.
type: string
InitialVersion
Information about a group version.
type: object
CoreDefinitionVersionArn
The ARN of the core definition version for this group.
type: string
DeviceDefinitionVersionArn
The ARN of the client device definition version for this group.
type: string
FunctionDefinitionVersionArn
The ARN of the function definition version for this group.
type: string
SubscriptionDefinitionVersionArn
The ARN of the subscription definition version for this group.
type: string
LoggerDefinitionVersionArn
The ARN of the logger definition version for this group.
type: string
ResourceDefinitionVersionArn
The ARN of the resource definition version for this group.
type: string
ConnectorDefinitionVersionArn
The ARN of the connector definition version for this group.
type: string
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateGroupResponse)
Success. The group was created.
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateGroupCertificateAuthority
Creates a CA for the group. If a CA already exists, it rotates the existing CA.
URI: `POST /greengrass/groups/GroupId/certificateauthorities`
Produces: application/json
## CLI:
```
aws greengrass create-group-certificate-authority \
--group-id \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"AmznClientToken": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200**
Success. The response body contains the new, active CA ARN.
[ CreateGroupCertificateAuthorityResponse](definitions-creategroupcertificateauthorityresponse.md)
```
{
"GroupCertificateAuthorityArn": "string"
}
```
CreateGroupCertificateAuthorityResponse
type: object
GroupCertificateAuthorityArn
The ARN of the group certificate authority.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateGroupVersion
Creates a version of a group that has already been defined.
URI: `POST /greengrass/groups/GroupId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-group-version \
--group-id \
[--core-definition-version-arn ] \
[--device-definition-version-arn ] \
[--function-definition-version-arn ] \
[--subscription-definition-version-arn ] \
[--logger-definition-version-arn ] \
[--resource-definition-version-arn ] \
[--connector-definition-version-arn ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string",
"AmznClientToken": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**CreateGroupVersionRequestBody**](parameters-creategroupversionrequestbody.md)
where used: body; required: true
```
{
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string"
}
```
schema:
GroupVersion
Information about a group version.
type: object
CoreDefinitionVersionArn
The ARN of the core definition version for this group.
type: string
DeviceDefinitionVersionArn
The ARN of the client device definition version for this group.
type: string
FunctionDefinitionVersionArn
The ARN of the function definition version for this group.
type: string
SubscriptionDefinitionVersionArn
The ARN of the subscription definition version for this group.
type: string
LoggerDefinitionVersionArn
The ARN of the logger definition version for this group.
type: string
ResourceDefinitionVersionArn
The ARN of the resource definition version for this group.
type: string
ConnectorDefinitionVersionArn
The ARN of the connector definition version for this group.
type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateGroupVersionResponse)
Success. The response contains information about the group version.
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateLoggerDefinition
Creates a logger definition. You can provide the initial version of the logger definition now or use `CreateLoggerDefinitionVersion` later.
URI: `POST /greengrass/definition/loggers`
Produces: application/json
## CLI:
```
aws greengrass create-logger-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": "integer"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateLoggerDefinitionRequestBody**](parameters-createloggerdefinitionrequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": 0
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the logger definition.
type: string
InitialVersion
Information about a logger definition version.
type: object
Loggers
A list of loggers.
type: array
items: [Logger](definitions-logger.md)
Logger
Information about a logger
type: object
required: ["Id", "Type", "Component", "Level"]
Id
A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Type
type: string
enum: ["FileSystem", "AWSCloudWatch"]
Component
type: string
enum: ["GreengrassSystem", "Lambda"]
Level
type: string
enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]
Space
The amount of file space, in KB, to use if the local file system is used for logging purposes.
type: integer
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateLoggerDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateLoggerDefinitionVersion
Creates a version of a logger definition that has already been defined.
URI: `POST /greengrass/definition/loggers/LoggerDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-logger-definition-version \
--logger-definition-id \
[--loggers ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"LoggerDefinitionId": "string",
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": "integer"
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**LoggerDefinitionId**](parameters-loggerdefinitionidparam.md)
The ID of the logger definition.
where used: path; required: true
type: string
[**CreateLoggerDefinitionVersionRequestBody**](parameters-createloggerdefinitionversionrequestbody.md)
where used: body; required: true
```
{
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": 0
}
]
}
```
schema:
LoggerDefinitionVersion
Information about a logger definition version.
type: object
Loggers
A list of loggers.
type: array
items: [Logger](definitions-logger.md)
Logger
Information about a logger
type: object
required: ["Id", "Type", "Component", "Level"]
Id
A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Type
type: string
enum: ["FileSystem", "AWSCloudWatch"]
Component
type: string
enum: ["GreengrassSystem", "Lambda"]
Level
type: string
enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]
Space
The amount of file space, in KB, to use if the local file system is used for logging purposes.
type: integer
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateLoggerDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateResourceDefinition
Creates a resource definition that contains a list of resources to be used in a group. You can create an initial version of the definition by providing a list of resources now, or use `CreateResourceDefinitionVersion` later.
URI: `POST /greengrass/definition/resources`
Produces: application/json
## CLI:
```
aws greengrass create-resource-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Resources": [
{
"Id": "string",
"Name": "string",
"ResourceDataContainer": {
"*-- NOTE:": "choose one of the following --*",
"LocalDeviceResourceData": {
"SourcePath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": "boolean",
"GroupOwner": "string"
}
},
"LocalVolumeResourceData": {
"SourcePath": "string",
"DestinationPath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": "boolean",
"GroupOwner": "string"
}
},
"SageMakerMachineLearningModelResourceData": {
"SageMakerJobArn": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"S3MachineLearningModelResourceData": {
"S3Uri": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"SecretsManagerSecretResourceData": {
"ARN": "string",
"AdditionalStagingLabelsToDownload": [
"string"
]
}
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateResourceDefinitionRequestBody**](parameters-createresourcedefinitionrequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Resources": [
{
"Id": "string",
"Name": "string",
"ResourceDataContainer": {
"*-- NOTE:": "choose one of the following --*",
"LocalDeviceResourceData": {
"SourcePath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"LocalVolumeResourceData": {
"SourcePath": "string",
"DestinationPath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"SageMakerMachineLearningModelResourceData": {
"SageMakerJobArn": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"S3MachineLearningModelResourceData": {
"S3Uri": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"SecretsManagerSecretResourceData": {
"ARN": "string",
"AdditionalStagingLabelsToDownload": [
"string"
]
}
}
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the resource definition.
type: string
InitialVersion
Information about a resource definition version.
type: object
Resources
A list of resources.
type: array
items: [Resource](definitions-resource.md)
Resource
Information about a resource.
type: object
required: ["Id", "Name", "ResourceDataContainer"]
Id
The resource ID, used to refer to a resource in the Lambda function configuration. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
Name
The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
ResourceDataContainer
A container for resource data. The container takes only one of the following supported resource data types: `LocalDeviceResourceData`, `LocalVolumeResourceData`, `SageMakerMachineLearningModelResourceData`, `S3MachineLearningModelResourceData`, `SecretsManagerSecretResourceData`.
type: object
NOTE: oneOf
LocalDeviceResourceData
Attributes that define a local device resource.
type: object
SourcePath
The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under `/dev`.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
LocalVolumeResourceData
Attributes that define a local volume resource.
type: object
SourcePath
The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with `/sys`.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
SageMakerMachineLearningModelResourceData
Attributes that define an Amazon SageMaker machine learning resource.
type: object
SageMakerJobArn
The ARN of the Amazon SageMaker training job that represents the source model.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
S3MachineLearningModelResourceData
Attributes that define an Amazon S3 machine learning resource.
type: object
S3Uri
The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
SecretsManagerSecretResourceData
Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.
type: object
ARN
The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.
type: string
AdditionalStagingLabelsToDownload
Optional. The staging labels in addition to `AWSCURRENT` whose values you want to make available on the core.
type: array
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateResourceDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateResourceDefinitionVersion
Creates a version of a resource definition that has already been defined.
URI: `POST /greengrass/definition/resources/ResourceDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-resource-definition-version \
--resource-definition-id \
[--resources ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ResourceDefinitionId": "string",
"Resources": [
{
"Id": "string",
"Name": "string",
"ResourceDataContainer": {
"*-- NOTE:": "choose one of the following --*",
"LocalDeviceResourceData": {
"SourcePath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": "boolean",
"GroupOwner": "string"
}
},
"LocalVolumeResourceData": {
"SourcePath": "string",
"DestinationPath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": "boolean",
"GroupOwner": "string"
}
},
"SageMakerMachineLearningModelResourceData": {
"SageMakerJobArn": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"S3MachineLearningModelResourceData": {
"S3Uri": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"SecretsManagerSecretResourceData": {
"ARN": "string",
"AdditionalStagingLabelsToDownload": [
"string"
]
}
}
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**ResourceDefinitionId**](parameters-resourcedefinitionidparam.md)
The ID of the resource definition.
where used: path; required: true
type: string
[**CreateResourceDefinitionVersionRequestBody**](parameters-createresourcedefinitionversionrequestbody.md)
Information about the resource definition version.
where used: body; required: true
```
{
"Resources": [
{
"Id": "string",
"Name": "string",
"ResourceDataContainer": {
"*-- NOTE:": "choose one of the following --*",
"LocalDeviceResourceData": {
"SourcePath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"LocalVolumeResourceData": {
"SourcePath": "string",
"DestinationPath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"SageMakerMachineLearningModelResourceData": {
"SageMakerJobArn": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"S3MachineLearningModelResourceData": {
"S3Uri": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"SecretsManagerSecretResourceData": {
"ARN": "string",
"AdditionalStagingLabelsToDownload": [
"string"
]
}
}
}
]
}
```
schema:
ResourceDefinitionVersion
Information about a resource definition version.
type: object
Resources
A list of resources.
type: array
items: [Resource](definitions-resource.md)
Resource
Information about a resource.
type: object
required: ["Id", "Name", "ResourceDataContainer"]
Id
The resource ID, used to refer to a resource in the Lambda function configuration. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
Name
The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
ResourceDataContainer
A container for resource data. The container takes only one of the following supported resource data types: `LocalDeviceResourceData`, `LocalVolumeResourceData`, `SageMakerMachineLearningModelResourceData`, `S3MachineLearningModelResourceData`, `SecretsManagerSecretResourceData`.
type: object
NOTE: oneOf
LocalDeviceResourceData
Attributes that define a local device resource.
type: object
SourcePath
The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under `/dev`.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
LocalVolumeResourceData
Attributes that define a local volume resource.
type: object
SourcePath
The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with `/sys`.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
SageMakerMachineLearningModelResourceData
Attributes that define an Amazon SageMaker machine learning resource.
type: object
SageMakerJobArn
The ARN of the Amazon SageMaker training job that represents the source model.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
S3MachineLearningModelResourceData
Attributes that define an Amazon S3 machine learning resource.
type: object
S3Uri
The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
SecretsManagerSecretResourceData
Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.
type: object
ARN
The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.
type: string
AdditionalStagingLabelsToDownload
Optional. The staging labels in addition to `AWSCURRENT` whose values you want to make available on the core.
type: array
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateResourceDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateSoftwareUpdateJob
Creates a software update for a core or group of cores (specified as an IoT thing group.) Use this to update the OTA agent and the Greengrass core software. It uses the AWS IoT Jobs feature, which provides more commands for managing a Greengrass Core software update job.
URI: `POST /greengrass/updates`
Produces: application/json
## CLI:
```
aws greengrass create-software-update-job \
[--update-targets-architecture ] \
[--update-targets ] \
[--software-to-update ] \
[--s3-url-signer-role ] \
[--update-agent-log-level ] \
[--update-targets-operating-system ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"UpdateTargetsArchitecture": "armv6l|armv7l|x86_64|aarch64",
"UpdateTargets": [
"string"
],
"SoftwareToUpdate": "core|ota_agent",
"S3UrlSignerRole": "string",
"UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL",
"UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux|openwrt",
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateSoftwareUpdateJobRequestBody**](parameters-createsoftwareupdatejobrequestbody.md)
where used: body; required: true
```
{
"UpdateTargetsArchitecture": "armv6l|armv7l|x86_64|aarch64",
"UpdateTargets": [
"string"
],
"SoftwareToUpdate": "core|ota_agent",
"S3UrlSignerRole": "string",
"UpdateAgentLogLevel": "NONE|TRACE|DEBUG|VERBOSE|INFO|WARN|ERROR|FATAL",
"UpdateTargetsOperatingSystem": "ubuntu|raspbian|amazon_linux|openwrt"
}
```
schema:
CreateSoftwareUpdateJobRequest
Request for the CreateSoftwareUpdateJob API.
type: object
required: ["UpdateTargetsArchitecture", "UpdateTargets", "SoftwareToUpdate", "S3UrlSignerRole", "UpdateTargetsOperatingSystem"]
UpdateTargetsArchitecture
The architecture of the cores that are the targets of an update.
type: string
enum: ["armv6l", "armv7l", "x86\$164", "aarch64"]
UpdateTargets
The ARNs of the targets (IoT things or IoT thing groups) that this update is applied to.
type: array
SoftwareToUpdate
The piece of software on the Greengrass core that will be updated.
type: string
enum: ["core", "ota\$1agent"]
S3UrlSignerRole
The IAM role that Greengrass uses to create presigned URLs that point to the update artifact.
type: string
UpdateAgentLogLevel
The minimum level of log statements that should be logged by the OTA agent during an update.
type: string
enum: ["NONE", "TRACE", "DEBUG", "VERBOSE", "INFO", "WARN", "ERROR", "FATAL"]
UpdateTargetsOperatingSystem
The operating system of the cores that are the targets of an update.
type: string
enum: ["ubuntu", "raspbian", "amazon\$1linux", "openwrt"]
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200**
Success.
[ CreateSoftwareUpdateJobResponse](definitions-createsoftwareupdatejobresponse.md)
```
{
"IotJobId": "string",
"IotJobArn": "string",
"PlatformSoftwareVersion": "string"
}
```
CreateSoftwareUpdateJobResponse
type: object
IotJobId
The IoT job ID that corresponds to this update.
type: string
IotJobArn
The IoT job ARN that corresponds to this update.
type: string
PlatformSoftwareVersion
The software version installed on the device or devices after the update.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateSubscriptionDefinition
Creates a subscription definition. You can provide the initial version of the subscription definition now or use `CreateSubscriptionDefinitionVersion` later.
URI: `POST /greengrass/definition/subscriptions`
Produces: application/json
## CLI:
```
aws greengrass create-subscription-definition \
[--name ] \
[--initial-version ] \
[--tags ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"Name": "string",
"InitialVersion": {
"Subscriptions": [
{
"Id": "string",
"Source": "string",
"Subject": "string",
"Target": "string"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"AmznClientToken": "string"
}
```
## Parameters:
[**CreateSubscriptionDefinitionRequestBody**](parameters-createsubscriptiondefinitionrequestbody.md)
where used: body; required: true
```
{
"Name": "string",
"InitialVersion": {
"Subscriptions": [
{
"Id": "string",
"Source": "string",
"Subject": "string",
"Target": "string"
}
]
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
```
schema:
Name
The name of the subscription definition.
type: string
InitialVersion
Information about a subscription definition version.
type: object
Subscriptions
A list of subscriptions.
type: array
items: [Subscription](definitions-subscription.md)
Subscription
Information about a subscription.
type: object
required: ["Id", "Source", "Subject", "Target"]
Id
A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Source
The source of the subscription. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
Subject
The MQTT topic used to route the message.
type: string
Target
Where the message is sent. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateSubscriptionDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# CreateSubscriptionDefinitionVersion
Creates a version of a subscription definition that has already been defined.
URI: `POST /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass create-subscription-definition-version \
--subscription-definition-id \
[--subscriptions ] \
[--amzn-client-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"SubscriptionDefinitionId": "string",
"Subscriptions": [
{
"Id": "string",
"Source": "string",
"Subject": "string",
"Target": "string"
}
],
"AmznClientToken": "string"
}
```
## Parameters:
[**SubscriptionDefinitionId**](parameters-subscriptiondefinitionidparam.md)
The ID of the subscription definition.
where used: path; required: true
type: string
[**CreateSubscriptionDefinitionVersionRequestBody**](parameters-createsubscriptiondefinitionversionrequestbody.md)
where used: body; required: true
```
{
"Subscriptions": [
{
"Id": "string",
"Source": "string",
"Subject": "string",
"Target": "string"
}
]
}
```
schema:
SubscriptionDefinitionVersion
Information about a subscription definition version.
type: object
Subscriptions
A list of subscriptions.
type: array
items: [Subscription](definitions-subscription.md)
Subscription
Information about a subscription.
type: object
required: ["Id", "Source", "Subject", "Target"]
Id
A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Source
The source of the subscription. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
Subject
The MQTT topic used to route the message.
type: string
Target
Where the message is sent. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
[**X-Amzn-Client-Token**](parameters-clienttoken.md)
A client token used to correlate requests and responses.
where used: header; required: false
type: string
## Responses:
**200** (CreateSubscriptionDefinitionVersionResponse)
[ VersionInformation](definitions-versioninformation.md)
```
{
"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.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteConnectorDefinition
Deletes a connector definition.
URI: `DELETE /greengrass/definition/connectors/ConnectorDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-connector-definition \
--connector-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ConnectorDefinitionId": "string"
}
```
## Parameters:
[**ConnectorDefinitionId**](parameters-connectordefinitionidparam.md)
The ID of the connector definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteCoreDefinition
Deletes a core definition.
URI: `DELETE /greengrass/definition/cores/CoreDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-core-definition \
--core-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"CoreDefinitionId": "string"
}
```
## Parameters:
[**CoreDefinitionId**](parameters-coredefinitionidparam.md)
The ID of the core definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteDeviceDefinition
Deletes a device definition.
URI: `DELETE /greengrass/definition/devices/DeviceDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-device-definition \
--device-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"DeviceDefinitionId": "string"
}
```
## Parameters:
[**DeviceDefinitionId**](parameters-devicedefinitionidparam.md)
The ID of the device definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteFunctionDefinition
Deletes a Lambda function definition.
URI: `DELETE /greengrass/definition/functions/FunctionDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-function-definition \
--function-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"FunctionDefinitionId": "string"
}
```
## Parameters:
[**FunctionDefinitionId**](parameters-functiondefinitionidparam.md)
The ID of the function definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteGroup
Deletes a group. Before you delete a group that is deployed, we recommend that you [reset the group's deployments](resetdeployments-post.md). This step removes the group's information from the core, so you can use the core with another Greengrass group.
URI: `DELETE /greengrass/groups/GroupId`
Produces: application/json
## CLI:
```
aws greengrass delete-group \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteLoggerDefinition
Deletes a logger definition.
URI: `DELETE /greengrass/definition/loggers/LoggerDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-logger-definition \
--logger-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"LoggerDefinitionId": "string"
}
```
## Parameters:
[**LoggerDefinitionId**](parameters-loggerdefinitionidparam.md)
The ID of the logger definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteResourceDefinition
Deletes a resource definition.
URI: `DELETE /greengrass/definition/resources/ResourceDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-resource-definition \
--resource-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ResourceDefinitionId": "string"
}
```
## Parameters:
[**ResourceDefinitionId**](parameters-resourcedefinitionidparam.md)
The ID of the resource definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DeleteSubscriptionDefinition
Deletes a subscription definition.
URI: `DELETE /greengrass/definition/subscriptions/SubscriptionDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass delete-subscription-definition \
--subscription-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"SubscriptionDefinitionId": "string"
}
```
## Parameters:
[**SubscriptionDefinitionId**](parameters-subscriptiondefinitionidparam.md)
The ID of the subscription definition.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ Empty](definitions-empty.md)
```
{
}
```
Empty Schema
Empty
type: object
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DisassociateRoleFromGroup
Disassociates the role from a group.
URI: `DELETE /greengrass/groups/GroupId/role`
## CLI:
```
aws greengrass disassociate-role-from-group \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ DisassociateRoleFromGroupResponse](definitions-disassociaterolefromgroupresponse.md)
```
{
"DisassociatedAt": "string"
}
```
DisassociateRoleFromGroupResponse
type: object
DisassociatedAt
The time, in milliseconds since the epoch, when the role was disassociated from the group.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# DisassociateServiceRoleFromAccount
Disassociates the service role from your account. Without a service role, deployments do not work.
URI: `DELETE /greengrass/servicerole`
## CLI:
```
aws greengrass disassociate-service-role-from-account \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
## Responses:
**200**
Success.
[ DisassociateServiceRoleFromAccountResponse](definitions-disassociateservicerolefromaccountresponse.md)
```
{
"DisassociatedAt": "string"
}
```
DisassociateServiceRoleFromAccountResponse
type: object
DisassociatedAt
The time when the service role was disassociated from the account.
type: string
**500**
Server error.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetAssociatedRole
Retrieves the role associated with a group.
URI: `GET /greengrass/groups/GroupId/role`
## CLI:
```
aws greengrass get-associated-role \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ GetAssociatedRoleResponse](definitions-getassociatedroleresponse.md)
```
{
"AssociatedAt": "string",
"RoleArn": "string"
}
```
GetAssociatedRoleResponse
type: object
AssociatedAt
The time when the role was associated with the group.
type: string
RoleArn
The ARN of the role that is associated with the group.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetBulkDeploymentStatus
Returns the status of a bulk deployment.
URI: `GET /greengrass/bulk/deployments/BulkDeploymentId/status`
Produces: application/json
## CLI:
```
aws greengrass get-bulk-deployment-status \
--bulk-deployment-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"BulkDeploymentId": "string"
}
```
## Parameters:
[**BulkDeploymentId**](parameters-bulkdeploymentidparam.md)
The ID of the bulk deployment.
where used: path; required: true
type: string
## Responses:
**200**
Success. The response body contains the status of the bulk deployment.
[ GetBulkDeploymentStatusResponse](definitions-getbulkdeploymentstatusresponse.md)
```
{
"BulkDeploymentStatus": "Initializing|Running|Completed|Stopping|Stopped|Failed",
"BulkDeploymentMetrics": {
"RecordsProcessed": 0,
"InvalidInputRecords": 0,
"RetryAttempts": 0
},
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"CreatedAt": "string",
"ErrorMessage": "string",
"ErrorDetails": [
{
"DetailedErrorCode": "string",
"DetailedErrorMessage": "string"
}
]
}
```
GetBulkDeploymentStatusResponse
Information about the status of a bulk deployment at the time of the request.
type: object
BulkDeploymentStatus
The current status of the bulk deployment.
type: string
enum: ["Initializing", "Running", "Completed", "Stopping", "Stopped", "Failed"]
BulkDeploymentMetrics
Relevant metrics on input records processed during bulk deployment.
type: object
RecordsProcessed
The total number of group records from the input file that have been processed or attempted so far.
type: integer
InvalidInputRecords
The total number of records that returned a non-retryable error. For example, this can occur if a group record from the input file uses an invalid format or specifies a nonexistent group version, or if the execution role doesn't grant permission to deploy a group or group version.
type: integer
RetryAttempts
The total number of deployment attempts that returned a retryable error. For example, a retry is triggered if the attempt to deploy a group returns a throttling error. `StartBulkDeployment` retries a group deployment up to five times.
type: integer
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
CreatedAt
The time, in ISO format, when the deployment was created.
type: string
ErrorMessage
Error message
type: string
ErrorDetails
A list of error details.
type: array
items: [ErrorDetail](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetConnectivityInfo
Retrieves the connectivity information for a core.
URI: `GET /greengrass/things/ThingName/connectivityInfo`
Produces: application/json
## CLI:
```
aws greengrass get-connectivity-info \
--thing-name \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ThingName": "string"
}
```
## Parameters:
[**ThingName**](parameters-thingnameparam.md)
The thing name.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ GetConnectivityInfoResponse](definitions-getconnectivityinforesponse.md)
```
{
"message": "string",
"ConnectivityInfo": [
{
"Id": "string",
"HostAddress": "string",
"PortNumber": 0x01,
"Metadata": "string"
}
]
}
```
Information about a Greengrass core's connectivity.
message
A message about the connectivity info request.
type: string
ConnectivityInfo
Connectivity info list.
type: array
items: [ConnectivityInfo](definitions-connectivityinfo.md)
Information about a Greengrass core's connectivity.
required: ["Id", "HostAddress"]
Id
The ID of the connectivity information.
type: string
HostAddress
The endpoint for the Greengrass core. Can be an IP address or DNS address.
type: string
PortNumber
The port of the Greengrass core, usually 8883.
type: integer
format: int32
Metadata
Metadata for this endpoint.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetConnectorDefinition
Retrieves information about a connector definition.
URI: `GET /greengrass/definition/connectors/ConnectorDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-connector-definition \
--connector-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ConnectorDefinitionId": "string"
}
```
## Parameters:
[**ConnectorDefinitionId**](parameters-connectordefinitionidparam.md)
The ID of the connector definition.
where used: path; required: true
type: string
## Responses:
**200** (GetConnectorDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetConnectorDefinitionVersion
Retrieves information about a connector definition version, including the connectors that the version contains. Connectors are prebuilt modules that interact with local infrastructure, device protocols, AWS, and other cloud services.
URI: `GET /greengrass/definition/connectors/ConnectorDefinitionId/versions/ConnectorDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-connector-definition-version \
--connector-definition-id \
--connector-definition-version-id \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ConnectorDefinitionId": "string",
"ConnectorDefinitionVersionId": "string",
"NextToken": "string"
}
```
## Parameters:
[**ConnectorDefinitionId**](parameters-connectordefinitionidparam.md)
The ID of the connector definition.
where used: path; required: true
type: string
[**ConnectorDefinitionVersionId**](parameters-connectordefinitionversionidparam.md)
The ID of the connector definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListConnectorDefinitionVersions` requests. If the version is the last one that was associated with a connector definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (GetConnectorDefinitionVersionResponse)
[ GetConnectorDefinitionVersionResponse](definitions-getconnectordefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"Connectors": [
{
"Id": "string",
"ConnectorArn": "string",
"Parameters": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
}
}
]
},
"NextToken": "string"
}
```
GetConnectorDefinitionVersionResponse
Information about a connector definition version.
type: object
Arn
The ARN of the connector definition version.
type: string
Id
The ID of the connector definition version.
type: string
Version
The version of the connector definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the connector definition version was created.
type: string
Definition
Information about the connector definition version, which is a container for connectors.
type: object
Connectors
A list of references to connectors in this version, with their corresponding configuration settings.
type: array
items: [Connector](definitions-connector.md)
Connector
Information about a connector. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
type: object
required: ["Id", "ConnectorArn"]
Id
A descriptive or arbitrary ID for the connector. This value must be unique within the connector definition version. Maximum length is 128 characters with the pattern [a-zA-Z0-9:\$1-]\$1.
type: string
ConnectorArn
The ARN of the connector.
type: string
Parameters
The parameters or configuration used by the connector.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetCoreDefinition
Retrieves information about a core definition version.
URI: `GET /greengrass/definition/cores/CoreDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-core-definition \
--core-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"CoreDefinitionId": "string"
}
```
## Parameters:
[**CoreDefinitionId**](parameters-coredefinitionidparam.md)
The ID of the core definition.
where used: path; required: true
type: string
## Responses:
**200** (GetCoreDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# 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 \
--core-definition-version-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"CoreDefinitionId": "string",
"CoreDefinitionVersionId": "string"
}
```
## Parameters:
[**CoreDefinitionId**](parameters-coredefinitionidparam.md)
The ID of the core definition.
where used: path; required: true
type: string
[**CoreDefinitionVersionId**](parameters-coredefinitionversionidparam.md)
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](definitions-getcoredefinitionversionresponse.md)
```
{
"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](definitions-core.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetDeploymentStatus
Returns the status of a deployment.
URI: `GET /greengrass/groups/GroupId/deployments/DeploymentId/status`
Produces: application/json
## CLI:
```
aws greengrass get-deployment-status \
--group-id \
--deployment-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"DeploymentId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**DeploymentId**](parameters-deploymentidparam.md)
The ID of the deployment.
where used: path; required: true
type: string
## Responses:
**200**
Success. The response body contains the status of the deployment for the group.
[ GetDeploymentStatusResponse](definitions-getdeploymentstatusresponse.md)
```
{
"DeploymentStatus": "string",
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"UpdatedAt": "string",
"ErrorMessage": "string",
"ErrorDetails": [
{
"DetailedErrorCode": "string",
"DetailedErrorMessage": "string"
}
]
}
```
GetDeploymentStatusResponse
Information about the status of a deployment for a group.
type: object
DeploymentStatus
The status of the deployment: `Building`, `InProgress`, `Success`, or `Failure`.
type: string
DeploymentType
The type of deployment. When used for `CreateDeployment`, only `NewDeployment` and `Redeployment` are valid.
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
UpdatedAt
The time, in milliseconds since the epoch, when the deployment status was updated.
type: string
ErrorMessage
Error message
type: string
ErrorDetails
A list of error details.
type: array
items: [ErrorDetail](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetDeviceDefinition
Retrieves information about a device definition.
URI: `GET /greengrass/definition/devices/DeviceDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-device-definition \
--device-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"DeviceDefinitionId": "string"
}
```
## Parameters:
[**DeviceDefinitionId**](parameters-devicedefinitionidparam.md)
The ID of the device definition.
where used: path; required: true
type: string
## Responses:
**200** (GetDeviceDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetDeviceDefinitionVersion
Retrieves information about a device definition version.
URI: `GET /greengrass/definition/devices/DeviceDefinitionId/versions/DeviceDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-device-definition-version \
--device-definition-id \
--device-definition-version-id \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"DeviceDefinitionId": "string",
"DeviceDefinitionVersionId": "string",
"NextToken": "string"
}
```
## Parameters:
[**DeviceDefinitionId**](parameters-devicedefinitionidparam.md)
The ID of the device definition.
where used: path; required: true
type: string
[**DeviceDefinitionVersionId**](parameters-devicedefinitionversionidparam.md)
The ID of the device definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListDeviceDefinitionVersions` requests. If the version is the last one that was associated with a device definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (GetDeviceDefinitionVersionResponse)
[ GetDeviceDefinitionVersionResponse](definitions-getdevicedefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"Devices": [
{
"Id": "string",
"ThingArn": "string",
"CertificateArn": "string",
"SyncShadow": true
}
]
},
"NextToken": "string"
}
```
GetDeviceDefinitionVersionResponse
type: object
Arn
The ARN of the device definition version.
type: string
Id
The ID of the device definition version.
type: string
Version
The version of the device definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the device definition version was created.
type: string
Definition
Information about a device definition version.
type: object
Devices
A list of devices in the definition version.
type: array
items: [Device](definitions-device.md)
Device
Information about a device.
type: object
required: ["Id", "ThingArn", "CertificateArn"]
Id
A descriptive or arbitrary ID for the device. This value must be unique within the device definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
ThingArn
The thing ARN of the device.
type: string
CertificateArn
The ARN of the certificate associated with the device.
type: string
SyncShadow
If true, the device'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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetFunctionDefinition
Retrieves information about a Lambda function definition, including its creation time and latest version.
URI: `GET /greengrass/definition/functions/FunctionDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-function-definition \
--function-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"FunctionDefinitionId": "string"
}
```
## Parameters:
[**FunctionDefinitionId**](parameters-functiondefinitionidparam.md)
The ID of the function definition.
where used: path; required: true
type: string
## Responses:
**200** (GetFunctionDefinitionResponse)
Success.
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetFunctionDefinitionVersion
Retrieves information about a Lambda function definition version, including which Lambda functions are included in the version and their configurations.
URI: `GET /greengrass/definition/functions/FunctionDefinitionId/versions/FunctionDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-function-definition-version \
--function-definition-id \
--function-definition-version-id \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"FunctionDefinitionId": "string",
"FunctionDefinitionVersionId": "string",
"NextToken": "string"
}
```
## Parameters:
[**FunctionDefinitionId**](parameters-functiondefinitionidparam.md)
The ID of the function definition.
where used: path; required: true
type: string
[**FunctionDefinitionVersionId**](parameters-functiondefinitionversionidparam.md)
The ID of the function definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListFunctionDefinitionVersions` requests. If the version is the last one that was associated with a function definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200**
Success.
[ GetFunctionDefinitionVersionResponse](definitions-getfunctiondefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"DefaultConfig": {
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"Functions": [
{
"Id": "string",
"FunctionArn": "string",
"FunctionConfiguration": {
"Pinned": true,
"Executable": "string",
"ExecArgs": "string",
"MemorySize": 0,
"Timeout": 0,
"EncodingType": "binary|json",
"Environment": {
"Variables": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"ResourceAccessPolicies": [
{
"ResourceId": "string",
"Permission": "ro|rw"
}
],
"AccessSysfs": true,
"Execution": {
"IsolationMode": "GreengrassContainer|NoContainer",
"RunAs": {
"Uid": 1001,
"Gid": 1002
}
}
},
"FunctionRuntimeOverride": "string"
}
}
]
},
"NextToken": "string"
}
```
GetFunctionDefinitionVersionResponse
Information about a function definition version.
type: object
Arn
The ARN of the function definition version.
type: string
Id
The ID of the function definition version.
type: string
Version
The version of the function definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the function definition version was created.
type: string
Definition
Information about a function definition version.
type: object
DefaultConfig
The default configuration that applies to all Lambda functions in the group. Individual Lambda functions can override these settings.
type: object
Execution
Configuration information that specifies how a Lambda function runs.
Functions
A list of Lambda functions in this function definition version.
type: array
items: [Function](definitions-function.md)
Information about a Lambda function.
type: object
required: ["Id"]
Id
A descriptive or arbitrary ID for the function. This value must be unique within the function definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
FunctionArn
The ARN of the alias (recommended) or version of the target Lambda function.
type: string
FunctionConfiguration
The configuration of the Lambda function.
type: object
Pinned
True if the function is pinned. Pinned means the function is long-lived and starts when the core starts.
type: boolean
Executable
The name of the function executable.
type: string
ExecArgs
The execution arguments.
type: string
MemorySize
The memory size, in KB, required by the function. This setting does not apply and should be cleared when you run the Lambda function without containerization.
type: integer
Timeout
The allowed function execution time, after which Lambda should terminate the function. This timeout still applies to pinned Lambda functions for each request.
type: integer
EncodingType
The expected encoding type of the input payload for the function. The default is `json`.
type: string
enum: ["binary", "json"]
Environment
The environment configuration of the function.
type: object
Variables
Environment variables for the Lambda function's configuration.
type: object
additionalProperties: An object with properties of type `string` that represent the environment variables.
ResourceAccessPolicies
A list of the resources, with their permissions, to which the Lambda function is granted access. A Lambda function can have at most 10 resources. ResourceAccessPolicies applies only when you run the Lambda function in a Greengrass container.
type: array
items: [ResourceAccessPolicy](definitions-resourceaccesspolicy.md)
ResourceAccessPolicy
A policy used by the function to access a resource.
type: object
required: ["ResourceId"]
ResourceId
The ID of the resource. (This ID is assigned to the resource when you create the resource definiton.)
type: string
Permission
The type of permission a function has to access a resource.
type: string
enum: ["ro", "rw"]
AccessSysfs
If true, the Lambda function is allowed to access the host's /sys folder. Use this when the Lambda function needs to read device information from /sys. This setting applies only when you run the Lambda function in a Greengrass container.
type: boolean
Execution
Configuration information that specifies how a Lambda function runs.
type: object
IsolationMode
Specifies whether the Lambda function runs in a Greengrass container (default) or without containerization. Unless your scenario requires that you run without containerization, we recommend that you run in a Greengrass container. Omit this value to run the Lambda function with the default containerization for the group.
type: string
enum: ["GreengrassContainer", "NoContainer"]
RunAs
Specifies the user and group whose permissions are used when running the Lambda function. You can specify one or both values to override the default values. To minimize the risk of unintended changes or malicious attacks, we recommend that you avoid running as root unless absolutely necessary. To run as root, you must update config.json in `greengrass-root/config` to set `allowFunctionsToRunAsRoot` to `yes`.
type: object
Uid
The user ID whose permissions are used to run a Lambda function.
type: integer
Gid
The group ID whose permissions are used to run a Lambda function.
type: integer
FunctionRuntimeOverride
The Lambda runtime supported by Greengrass which is to be used instead of the one specified in the Lambda function.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetGroup
Retrieves information about a group.
URI: `GET /greengrass/groups/GroupId`
Produces: application/json
## CLI:
```
aws greengrass get-group \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200** (GetGroupResponse)
Success.
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# 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 \
--certificate-authority-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"CertificateAuthorityId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**CertificateAuthorityId**](parameters-certificateauthorityidparam.md)
The ID of the certificate authority.
where used: path; required: true
type: string
## Responses:
**200**
Success. The response body contains the PKI configuration.
[ GetGroupCertificateAuthorityResponse](definitions-getgroupcertificateauthorityresponse.md)
```
{
"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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetGroupCertificateConfiguration
Retrieves the current configuration for the CA used by the group.
URI: `GET /greengrass/groups/GroupId/certificateauthorities/configuration/expiry`
Produces: application/json
## CLI:
```
aws greengrass get-group-certificate-configuration \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200**
Success. The response body contains the PKI configuration.
[ GroupCertificateConfiguration](definitions-groupcertificateconfiguration.md)
```
{
"GroupId": "string",
"CertificateAuthorityExpiryInMilliseconds": "string",
"CertificateExpiryInMilliseconds": "string"
}
```
GroupCertificateConfiguration
Information about a group certificate configuration.
type: object
GroupId
The ID of the group certificate configuration.
type: string
CertificateAuthorityExpiryInMilliseconds
The amount of time, in milliseconds, before the certificate authority expires.
type: string
CertificateExpiryInMilliseconds
The amount of time, in milliseconds, before the certificate expires.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetGroupVersion
Retrieves information about a group version.
URI: `GET /greengrass/groups/GroupId/versions/GroupVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-group-version \
--group-id \
--group-version-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"GroupVersionId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**GroupVersionId**](parameters-groupversionidparam.md)
The ID of the group version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListGroupVersions` requests. If the version is the last one that was associated with a group, the value also maps to the `LatestVersion` property of the corresponding `GroupInformation` object.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ GetGroupVersionResponse](definitions-getgroupversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"CoreDefinitionVersionArn": "string",
"DeviceDefinitionVersionArn": "string",
"FunctionDefinitionVersionArn": "string",
"SubscriptionDefinitionVersionArn": "string",
"LoggerDefinitionVersionArn": "string",
"ResourceDefinitionVersionArn": "string",
"ConnectorDefinitionVersionArn": "string"
}
}
```
GetGroupVersionResponse
Information about a group version.
type: object
Arn
The ARN of the group version.
type: string
Id
The ID of the group that the version is associated with.
type: string
Version
The ID of the group version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the group version was created.
type: string
Definition
Information about a group version.
type: object
CoreDefinitionVersionArn
The ARN of the core definition version for this group.
type: string
DeviceDefinitionVersionArn
The ARN of the client device definition version for this group.
type: string
FunctionDefinitionVersionArn
The ARN of the function definition version for this group.
type: string
SubscriptionDefinitionVersionArn
The ARN of the subscription definition version for this group.
type: string
LoggerDefinitionVersionArn
The ARN of the logger definition version for this group.
type: string
ResourceDefinitionVersionArn
The ARN of the resource definition version for this group.
type: string
ConnectorDefinitionVersionArn
The ARN of the connector definition version for this group.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetLoggerDefinition
Retrieves information about a logger definition.
URI: `GET /greengrass/definition/loggers/LoggerDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-logger-definition \
--logger-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"LoggerDefinitionId": "string"
}
```
## Parameters:
[**LoggerDefinitionId**](parameters-loggerdefinitionidparam.md)
The ID of the logger definition.
where used: path; required: true
type: string
## Responses:
**200** (GetLoggerDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetLoggerDefinitionVersion
Retrieves information about a logger definition version.
URI: `GET /greengrass/definition/loggers/LoggerDefinitionId/versions/LoggerDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-logger-definition-version \
--logger-definition-version-id \
--logger-definition-id \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"LoggerDefinitionVersionId": "string",
"LoggerDefinitionId": "string",
"NextToken": "string"
}
```
## Parameters:
[**LoggerDefinitionVersionId**](parameters-loggerdefinitionversionidparam.md)
The ID of the logger definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListLoggerDefinitionVersions` requests. If the version is the last one that was associated with a logger definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
[**LoggerDefinitionId**](parameters-loggerdefinitionidparam.md)
The ID of the logger definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (GetLoggerDefinitionVersionResponse)
Success.
[ GetLoggerDefinitionVersionResponse](definitions-getloggerdefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"Loggers": [
{
"Id": "string",
"Type": "FileSystem|AWSCloudWatch",
"Component": "GreengrassSystem|Lambda",
"Level": "DEBUG|INFO|WARN|ERROR|FATAL",
"Space": 0
}
]
}
}
```
GetLoggerDefinitionVersionResponse
Information about a logger definition version.
type: object
Arn
The ARN of the logger definition version.
type: string
Id
The ID of the logger definition version.
type: string
Version
The version of the logger definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the logger definition version was created.
type: string
Definition
Information about a logger definition version.
type: object
Loggers
A list of loggers.
type: array
items: [Logger](definitions-logger.md)
Logger
Information about a logger
type: object
required: ["Id", "Type", "Component", "Level"]
Id
A descriptive or arbitrary ID for the logger. This value must be unique within the logger definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Type
type: string
enum: ["FileSystem", "AWSCloudWatch"]
Component
type: string
enum: ["GreengrassSystem", "Lambda"]
Level
type: string
enum: ["DEBUG", "INFO", "WARN", "ERROR", "FATAL"]
Space
The amount of file space, in KB, to use if the local file system is used for logging purposes.
type: integer
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetResourceDefinition
Retrieves information about a resource definition, including its creation time and latest version.
URI: `GET /greengrass/definition/resources/ResourceDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-resource-definition \
--resource-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ResourceDefinitionId": "string"
}
```
## Parameters:
[**ResourceDefinitionId**](parameters-resourcedefinitionidparam.md)
The ID of the resource definition.
where used: path; required: true
type: string
## Responses:
**200** (GetResourceDefinitionResponse)
Success.
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetResourceDefinitionVersion
Retrieves information about a resource definition version, including which resources are included in the version.
URI: `GET /greengrass/definition/resources/ResourceDefinitionId/versions/ResourceDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-resource-definition-version \
--resource-definition-id \
--resource-definition-version-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ResourceDefinitionId": "string",
"ResourceDefinitionVersionId": "string"
}
```
## Parameters:
[**ResourceDefinitionId**](parameters-resourcedefinitionidparam.md)
The ID of the resource definition.
where used: path; required: true
type: string
[**ResourceDefinitionVersionId**](parameters-resourcedefinitionversionidparam.md)
The ID of the resource definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListResourceDefinitionVersions` requests. If the version is the last one that was associated with a resource definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
## Responses:
**200**
Success.
[ GetResourceDefinitionVersionResponse](definitions-getresourcedefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"Resources": [
{
"Id": "string",
"Name": "string",
"ResourceDataContainer": {
"*-- NOTE:": "choose one of the following --*",
"LocalDeviceResourceData": {
"SourcePath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"LocalVolumeResourceData": {
"SourcePath": "string",
"DestinationPath": "string",
"GroupOwnerSetting": {
"AutoAddGroupOwner": true,
"GroupOwner": "string"
}
},
"SageMakerMachineLearningModelResourceData": {
"SageMakerJobArn": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"S3MachineLearningModelResourceData": {
"S3Uri": "string",
"DestinationPath": "string",
"OwnerSetting": {
"GroupOwner": "string",
"GroupPermission": "ro|rw"
}
},
"SecretsManagerSecretResourceData": {
"ARN": "string",
"AdditionalStagingLabelsToDownload": [
"string"
]
}
}
}
]
}
}
```
GetResourceDefinitionVersionResponse
Information about a resource definition version.
type: object
Arn
The ARN of the resource definition version.
type: string
Id
The ID of the resource definition version.
type: string
Version
The version of the resource definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the resource definition version was created.
type: string
Definition
Information about a resource definition version.
type: object
Resources
A list of resources.
type: array
items: [Resource](definitions-resource.md)
Resource
Information about a resource.
type: object
required: ["Id", "Name", "ResourceDataContainer"]
Id
The resource ID, used to refer to a resource in the Lambda function configuration. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
Name
The descriptive resource name, which is displayed on the AWS IoT Greengrass console. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`. This must be unique within a Greengrass group.
type: string
ResourceDataContainer
A container for resource data. The container takes only one of the following supported resource data types: `LocalDeviceResourceData`, `LocalVolumeResourceData`, `SageMakerMachineLearningModelResourceData`, `S3MachineLearningModelResourceData`, `SecretsManagerSecretResourceData`.
type: object
NOTE: oneOf
LocalDeviceResourceData
Attributes that define a local device resource.
type: object
SourcePath
The local absolute path of the device resource. The source path for a device resource can refer only to a character device or block device under `/dev`.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
LocalVolumeResourceData
Attributes that define a local volume resource.
type: object
SourcePath
The local absolute path of the volume resource on the host. The source path for a volume resource type cannot start with `/sys`.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
GroupOwnerSetting
Group owner related settings for local resources.
type: object
AutoAddGroupOwner
If true, AWS IoT Greengrass adds the specified Linux OS group owner of the resource to the Lambda process privileges. The Lambda process then has the file access permissions of the added Linux group.
type: boolean
GroupOwner
The name of the Linux OS group whose privileges are added to the Lambda process. This field is optional.
type: string
SageMakerMachineLearningModelResourceData
Attributes that define an Amazon SageMaker machine learning resource.
type: object
SageMakerJobArn
The ARN of the Amazon SageMaker training job that represents the source model.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
S3MachineLearningModelResourceData
Attributes that define an Amazon S3 machine learning resource.
type: object
S3Uri
The URI of the source model in an S3 bucket. The model package must be in tar.gz or .zip format.
type: string
DestinationPath
The absolute local path of the resource inside the Lambda environment.
type: string
OwnerSetting
The owner setting for the downloaded machine learning resource.
type: object
required: ["GroupOwner", "GroupPermission"]
GroupOwner
The group owner of the resource. This is the group ID (GID) of an existing Linux OS group on the system. The group's permissions are added to the Lambda process.
type: string
GroupPermission
The permissions that the group owner has to the resource. Valid values are `rw` (read-write) or `ro` (read-only).
type: string
enum: ["ro", "rw"]
SecretsManagerSecretResourceData
Attributes that define a secret resource, which references a secret from AWS Secrets Manager. AWS IoT Greengrass stores a local, encrypted copy of the secret on the Greengrass core, where it can be securely accessed by connectors and Lambda functions.
type: object
ARN
The ARN of the Secrets Manager secret to make available on the core. The value of the secret's latest version (represented by the `AWSCURRENT` staging label) is included by default.
type: string
AdditionalStagingLabelsToDownload
Optional. The staging labels in addition to `AWSCURRENT` whose values you want to make available on the core.
type: array
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetServiceRoleForAccount
Retrieves the service role that is attached to your account.
URI: `GET /greengrass/servicerole`
## CLI:
```
aws greengrass get-service-role-for-account \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
## Responses:
**200**
Success.
[ GetServiceRoleForAccountResponse](definitions-getserviceroleforaccountresponse.md)
```
{
"AssociatedAt": "string",
"RoleArn": "string"
}
```
GetServiceRoleForAccountResponse
type: object
AssociatedAt
The time when the service role was associated with the account.
type: string
RoleArn
The ARN of the role associated with the account.
type: string
**500**
Server error.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetSubscriptionDefinition
Retrieves information about a subscription definition.
URI: `GET /greengrass/definition/subscriptions/SubscriptionDefinitionId`
Produces: application/json
## CLI:
```
aws greengrass get-subscription-definition \
--subscription-definition-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"SubscriptionDefinitionId": "string"
}
```
## Parameters:
[**SubscriptionDefinitionId**](parameters-subscriptiondefinitionidparam.md)
The ID of the subscription definition.
where used: path; required: true
type: string
## Responses:
**200** (GetSubscriptionDefinitionResponse)
[ DefinitionInformation](definitions-definitioninformation.md)
```
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetSubscriptionDefinitionVersion
Retrieves information about a subscription definition version.
URI: `GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId`
Produces: application/json
## CLI:
```
aws greengrass get-subscription-definition-version \
--subscription-definition-id \
--subscription-definition-version-id \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"SubscriptionDefinitionId": "string",
"SubscriptionDefinitionVersionId": "string",
"NextToken": "string"
}
```
## Parameters:
[**SubscriptionDefinitionId**](parameters-subscriptiondefinitionidparam.md)
The ID of the subscription definition.
where used: path; required: true
type: string
[**SubscriptionDefinitionVersionId**](parameters-subscriptiondefinitionversionidparam.md)
The ID of the subscription definition version. This value maps to the `Version` property of the corresponding `VersionInformation` object, which is returned by `ListSubscriptionDefinitionVersions` requests. If the version is the last one that was associated with a subscription definition, the value also maps to the `LatestVersion` property of the corresponding `DefinitionInformation` object.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (GetSubscriptionDefinitionVersionResponse)
[ GetSubscriptionDefinitionVersionResponse](definitions-getsubscriptiondefinitionversionresponse.md)
```
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string",
"Definition": {
"Subscriptions": [
{
"Id": "string",
"Source": "string",
"Subject": "string",
"Target": "string"
}
]
},
"NextToken": "string"
}
```
GetSubscriptionDefinitionVersionResponse
Information about a subscription definition version.
type: object
Arn
The ARN of the subscription definition version.
type: string
Id
The ID of the subscription definition version.
type: string
Version
The version of the subscription definition version.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the subscription definition version was created.
type: string
Definition
Information about a subscription definition version.
type: object
Subscriptions
A list of subscriptions.
type: array
items: [Subscription](definitions-subscription.md)
Subscription
Information about a subscription.
type: object
required: ["Id", "Source", "Subject", "Target"]
Id
A descriptive or arbitrary ID for the subscription. This value must be unique within the subscription definition version. Maximum length is 128 characters with the pattern `[a‑zA‑Z0‑9:_‑]+`.
type: string
Source
The source of the subscription. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
Subject
The MQTT topic used to route the message.
type: string
Target
Where the message is sent. Can be a thing ARN, the ARN of a Lambda function alias (recommended) or version, a connector ARN, 'cloud' (which represents AWS IoT), or 'GGShadowService'. If you specify a Lambda function, this ARN should match the ARN used to add the function to the Greengrass group.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# GetThingRuntimeConfiguration
Retrieves the runtime configuration of a Greengrass core. Before you can retrieve the runtime configuration, you must use [UpdateThingRuntimeConfiguration](updatethingruntimeconfiguration-put.md) to create a runtime configuration for the core.
URI: `GET /greengrass/things/{ThingName}/runtimeconfig`
Produces: application/json
## CLI:
```
aws greengrass get-thing-runtime-configuration \
--thing-name \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ThingName": ""
}
```
## Parameters:
[ThingName](parameters-thingnameparam.md)
The thing name.
where used: path; required: true
type: string
## Responses:
**200**
200 response
[ GetThingRuntimeConfigurationResponse](definitions-getthingruntimeconfigurationresponse.md)
```
{
"RuntimeConfiguration": {
"TelemetryConfiguration": {
"Telemetry": "On|Off",
"ConfigurationSyncStatus": "InSync|OutOfSync"
}
}
}
```
GetThingRuntimeConfigurationResponse
Information about the runtime configuration for a thing.
type: object
RuntimeConfiguration
The runtime configuration for a thing.
type: object
TelemetryConfiguration
The configuration setting to run telemetry.
type: object
required: ["Telemetry"]
Telemetry
The configuration setting to turn on or turn off telemetry.
type: string
enum: ["On", "Off"]
ConfigurationSyncStatus
The synchronization status of the device-reported configuration with the desired configuration.
type: string
enum: ["InSync", "OutOfSync"]
**400**
400 response
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
**500**
500 response
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListBulkDeploymentDetailedReports
Gets a paginated list of the deployments that have been started in a bulk deployment operation, and their current deployment status.
URI: `GET /greengrass/bulk/deployments/BulkDeploymentId/detailed-reports`
Produces: application/json
## CLI:
```
aws greengrass list-bulk-deployment-detailed-reports \
--bulk-deployment-id \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"BulkDeploymentId": "string",
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**BulkDeploymentId**](parameters-bulkdeploymentidparam.md)
The ID of the bulk deployment.
where used: path; required: true
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200**
Success. The response body contains the list of deployments for the given group.
[ ListBulkDeploymentDetailedReportsResponse](definitions-listbulkdeploymentdetailedreportsresponse.md)
```
{
"Deployments": [
{
"DeploymentId": "string",
"DeploymentArn": "string",
"GroupArn": "string",
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"CreatedAt": "string",
"DeploymentStatus": "string",
"ErrorMessage": "string",
"ErrorDetails": [
{
"DetailedErrorCode": "string",
"DetailedErrorMessage": "string"
}
]
}
],
"NextToken": "string"
}
```
ListBulkDeploymentDetailedReportsResponse
type: object
Deployments
type: array
items: [BulkDeploymentResult](definitions-bulkdeploymentresult.md)
BulkDeploymentResult
Information about an individual group deployment in a bulk deployment operation.
type: object
DeploymentId
The ID of the group deployment.
type: string
DeploymentArn
The ARN of the group deployment.
type: string
GroupArn
The ARN of the Greengrass group.
type: string
DeploymentType
The type of deployment. When used for `CreateDeployment`, only `NewDeployment` and `Redeployment` are valid.
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
CreatedAt
The time, in ISO format, when the deployment was created.
type: string
DeploymentStatus
The current status of the group deployment: ` `Building`, `InProgress `, `Success `, or `Failure``.
type: string
ErrorMessage
The error message for a failed deployment.
type: string
ErrorDetails
A list of error details.
type: array
items: [ErrorDetail](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
in: query
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListBulkDeployments
Returns a list of bulk deployments.
URI: `GET /greengrass/bulk/deployments`
Produces: application/json
## CLI:
```
aws greengrass list-bulk-deployments \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200**
Success. The response body contains the list of bulk deployments.
[ ListBulkDeploymentsResponse](definitions-listbulkdeploymentsresponse.md)
```
{
"BulkDeployments": [
{
"BulkDeploymentId": "string",
"BulkDeploymentArn": "string",
"CreatedAt": "string"
}
],
"NextToken": "string"
}
```
ListBulkDeploymentsResponse
type: object
BulkDeployments
type: array
items: [BulkDeployment](definitions-bulkdeployment.md)
BulkDeployment
Information about a bulk deployment. You cannot start a new bulk deployment while another one is still running or in a non-terminal state.
type: object
BulkDeploymentId
The ID of the bulk deployment.
type: string
BulkDeploymentArn
The ARN of the bulk deployment.
type: string
CreatedAt
The time, in ISO format, when the deployment was created.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
in: query
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListConnectorDefinitionVersions
Lists the versions of a connector definition, which are containers for connectors. Connectors run on the Greengrass core and contain built-in integration with local infrastructure, device protocols, AWS, and other cloud services.
URI: `GET /greengrass/definition/connectors/ConnectorDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-connector-definition-versions \
--connector-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ConnectorDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**ConnectorDefinitionId**](parameters-connectordefinitionidparam.md)
The ID of the connector definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListConnectorDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListConnectorDefinitions
Retrieves a list of connector definitions.
URI: `GET /greengrass/definition/connectors`
Produces: application/json
## CLI:
```
aws greengrass list-connector-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListConnectorDefinitionsResponse)
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListCoreDefinitionVersions
Lists the versions of a core definition.
URI: `GET /greengrass/definition/cores/CoreDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-core-definition-versions \
--core-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"CoreDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**CoreDefinitionId**](parameters-coredefinitionidparam.md)
The ID of the core definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListCoreDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListCoreDefinitions
Retrieves a list of core definitions.
URI: `GET /greengrass/definition/cores`
Produces: application/json
## CLI:
```
aws greengrass list-core-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListCoreDefinitionsResponse)
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListDeployments
Returns a history of deployments for the group.
URI: `GET /greengrass/groups/GroupId/deployments`
Produces: application/json
## CLI:
```
aws greengrass list-deployments \
--group-id \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200**
Success. The response body contains the list of deployments for the given group.
[ ListDeploymentsResponse](definitions-listdeploymentsresponse.md)
```
{
"Deployments": [
{
"GroupArn": "string",
"DeploymentId": "string",
"DeploymentArn": "string",
"DeploymentType": "NewDeployment|Redeployment|ResetDeployment|ForceResetDeployment",
"CreatedAt": "string"
}
],
"NextToken": "string"
}
```
ListDeploymentsResponse
type: object
Deployments
type: array
items: [Deployment](definitions-deployment.md)
Deployment
Information about a deployment.
type: object
GroupArn
The ARN of the group for this deployment.
type: string
DeploymentId
The ID of the deployment.
type: string
DeploymentArn
The ARN of the deployment.
type: string
DeploymentType
The type of deployment. When used for `CreateDeployment`, only `NewDeployment` and `Redeployment` are valid.
type: string
enum: ["NewDeployment", "Redeployment", "ResetDeployment", "ForceResetDeployment"]
CreatedAt
The time, in milliseconds since the epoch, when the deployment was created.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
in: query
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListDeviceDefinitionVersions
Lists the versions of a device definition.
URI: `GET /greengrass/definition/devices/DeviceDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-device-definition-versions \
--device-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"DeviceDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**DeviceDefinitionId**](parameters-devicedefinitionidparam.md)
The ID of the device definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListDeviceDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListDeviceDefinitions
Retrieves a list of device definitions.
URI: `GET /greengrass/definition/devices`
Produces: application/json
## CLI:
```
aws greengrass list-device-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListDeviceDefinitionsResponse)
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListFunctionDefinitionVersions
Lists the versions of a Lambda function definition.
URI: `GET /greengrass/definition/functions/FunctionDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-function-definition-versions \
--function-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"FunctionDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**FunctionDefinitionId**](parameters-functiondefinitionidparam.md)
The ID of the function definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListFunctionDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListFunctionDefinitions
Retrieves a list of Lambda function definitions.
URI: `GET /greengrass/definition/functions`
Produces: application/json
## CLI:
```
aws greengrass list-function-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListFunctionDefinitionsResponse)
Success. The response contains the IDs of all of the Greengrass Lambda function definitions in this account.
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListGroupCertificateAuthorities
Retrieves the current CAs for a group.
URI: `GET /greengrass/groups/GroupId/certificateauthorities`
Produces: application/json
## CLI:
```
aws greengrass list-group-certificate-authorities \
--group-id \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
## Responses:
**200**
Success. The response body contains the PKI configuration.
[ ListGroupCertificateAuthoritiesResponse](definitions-listgroupcertificateauthoritiesresponse.md)
```
{
"GroupCertificateAuthorities": [
{
"GroupCertificateAuthorityId": "string",
"GroupCertificateAuthorityArn": "string"
}
]
}
```
ListGroupCertificateAuthoritiesResponse
type: object
GroupCertificateAuthorities
A list of certificate authorities associated with the group.
type: array
items: [GroupCertificateAuthorityProperties](definitions-groupcertificateauthorityproperties.md)
Group Certificate Authority Properties
Information about a certificate authority for a group.
type: object
GroupCertificateAuthorityId
The ID of the certificate authority for the group.
type: string
GroupCertificateAuthorityArn
The ARN of the certificate authority for the group.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
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](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListGroupVersions
Lists the versions of a group.
URI: `GET /greengrass/groups/GroupId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-group-versions \
--group-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"GroupId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**GroupId**](parameters-groupidparam.md)
The ID of the Greengrass group.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListGroupVersionsResponse)
Success. The response contains the list of versions and metadata for the given group.
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListGroups
Retrieves a list of groups.
URI: `GET /greengrass/groups`
Produces: application/json
## CLI:
```
aws greengrass list-groups \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListGroupsResponse)
[ ListGroupsResponse](definitions-listgroupsresponse.md)
```
{
"Groups": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListGroupsResponse
type: object
Groups
Information about a group.
type: array
items: [GroupInformation](definitions-groupinformation.md)
GroupInformation
Information about a group.
type: object
Name
The name of the group.
type: string
Id
The ID of the group.
type: string
Arn
The ARN of the group.
type: string
LastUpdatedTimestamp
The time, in milliseconds since the epoch, when the group was last updated.
type: string
CreationTimestamp
The time, in milliseconds since the epoch, when the group was created.
type: string
LatestVersion
The ID of the latest version associated with the group.
type: string
LatestVersionArn
The ARN of the latest version associated with the group.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListLoggerDefinitionVersions
Lists the versions of a logger definition.
URI: `GET /greengrass/definition/loggers/LoggerDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-logger-definition-versions \
--logger-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"LoggerDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**LoggerDefinitionId**](parameters-loggerdefinitionidparam.md)
The ID of the logger definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListLoggerDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListLoggerDefinitions
Retrieves a list of logger definitions.
URI: `GET /greengrass/definition/loggers`
Produces: application/json
## CLI:
```
aws greengrass list-logger-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListLoggerDefinitionsResponse)
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListResourceDefinitionVersions
Lists the versions of a resource definition.
URI: `GET /greengrass/definition/resources/ResourceDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-resource-definition-versions \
--resource-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"ResourceDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**ResourceDefinitionId**](parameters-resourcedefinitionidparam.md)
The ID of the resource definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListResourceDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListResourceDefinitions
Retrieves a list of resource definitions.
URI: `GET /greengrass/definition/resources`
Produces: application/json
## CLI:
```
aws greengrass list-resource-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListResourceDefinitionsResponse)
The IDs of all the Greengrass resource definitions in this account.
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListSubscriptionDefinitionVersions
Lists the versions of a subscription definition.
URI: `GET /greengrass/definition/subscriptions/SubscriptionDefinitionId/versions`
Produces: application/json
## CLI:
```
aws greengrass list-subscription-definition-versions \
--subscription-definition-id \
[--next-token ] \
[--max-results ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"SubscriptionDefinitionId": "string",
"NextToken": "string",
"MaxResults": "integer"
}
```
## Parameters:
[**SubscriptionDefinitionId**](parameters-subscriptiondefinitionidparam.md)
The ID of the subscription definition.
where used: path; required: true
type: string
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
## Responses:
**200** (ListSubscriptionDefinitionVersionsResponse)
[ ListVersionsResponse](definitions-listversionsresponse.md)
```
{
"Versions": [
{
"Arn": "string",
"Id": "string",
"Version": "string",
"CreationTimestamp": "string"
}
],
"NextToken": "string"
}
```
ListVersionsResponse
A list of versions.
type: object
Versions
Information about a version.
type: array
items: [VersionInformation](definitions-versioninformation.md)
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
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ListSubscriptionDefinitions
Retrieves a list of subscription definitions.
URI: `GET /greengrass/definition/subscriptions`
Produces: application/json
## CLI:
```
aws greengrass list-subscription-definitions \
[--max-results ] \
[--next-token ] \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
cli-input-json format:
```
{
"MaxResults": "integer",
"NextToken": "string"
}
```
## Parameters:
[**MaxResults**](parameters-maxresultsparam.md)
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
[**NextToken**](parameters-nexttokenparam.md)
The token for the next set of results, or `null` if there are no more results.
where used: query; required: false
type: string
## Responses:
**200** (ListSubscriptionDefinitionsResponse)
[ ListDefinitionsResponse](definitions-listdefinitionsresponse.md)
```
{
"Definitions": [
{
"Name": "string",
"Id": "string",
"Arn": "string",
"tags": {
"additionalProperty0": "string",
"additionalProperty1": "string",
"additionalProperty2": "string"
},
"LastUpdatedTimestamp": "string",
"CreationTimestamp": "string",
"LatestVersion": "string",
"LatestVersionArn": "string"
}
],
"NextToken": "string"
}
```
ListDefinitionsResponse
A list of definitions.
type: object
Definitions
Information about a definition.
type: array
items: [DefinitionInformation](definitions-definitioninformation.md)
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
tags
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. 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 ID of the latest version associated with the definition.
type: string
LatestVersionArn
The ARN of the latest version associated with the definition.
type: string
NextToken
The token for the next set of results, or `null` if there are no more results.
type: string
# ListTagsForResource
Lists tags for a Greengrass resource. Valid resources are `Group`, `ConnectorDefinition`, `CoreDefinition`, `DeviceDefinition`, `FunctionDefinition`, `LoggerDefinition`, `ResourceDefinition`, `SubscriptionDefinition`, and `BulkDeployment`.
URI: `GET /tags/resource-arn`
Produces: application/json
## CLI:
```
aws greengrass list-tags-for-resource \
[--cli-input-json ] \
[--generate-cli-skeleton]
```
## Parameters:
[**ResourceArn**](parameters-resourcearnparam.md)
The Amazon Resource Name (ARN) of the resource whose tags you want to retrieve.
where used: path; required: true
type: string
## Responses:
**200**
HTTP Status Code 200: OK.
[ tags](definitions-tags.md)
```
{
"tags": {
"keyName0": "value0",
"keyName1": "value1",
"keyName2": "value2"
}
}
```
The resource tags.
type: object
additionalProperties: The key-value pair for the resource tag. Type: string
**400**
Invalid request.
[ GeneralError](definitions-generalerror.md)
```
{
"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](definitions-errordetail.md)
ErrorDetail
Details about the error.
type: object
DetailedErrorCode
A detailed error code.
type: string
DetailedErrorMessage
A detailed error message.
type: string
# ResetDeployments
Resets a group's deployments.
URI: `POST /greengrass/groups/GroupId/deployments/$reset`
Produces: application/json
## CLI:
```
aws greengrass reset-deployments \
--group-id \
[--force | --no-force] \
[--amzn-client-token