AWS IoT Greengrass Version 1 no longer receives feature updates, and will receive only security patches and bug fixes until June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
POST
POST
/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
Operation ID: CreateSubscriptionDefinitionVersion
Creates a version of a subscription definition that has already been defined.
Produces: application/json
Body Parameters
- CreateSubscriptionDefinitionVersionRequestBody
-
where used: body; required: true
{ "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ] }- SubscriptionDefinitionVersion
-
Information about a subscription definition version.
type: object
- Subscriptions
-
A list of subscriptions.
type: array
items: Subscription
- 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
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
- SubscriptionDefinitionId
-
The ID of the subscription definition.
where used: path; required: true
type: string
CLI
aws greengrass create-subscription-definition-version \ --subscription-definition-id <value> \ [--subscriptions <value>] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "string" } ], "AmznClientToken": "string" }
Responses
- 200 (CreateSubscriptionDefinitionVersionResponse)
-
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string" }- VersionInformation
-
Information about a version.
type: object
- Arn
-
The ARN of the version.
type: string
- Id
-
The ID of the parent definition that the version is associated with.
type: string
- Version
-
The ID of the version.
type: string
- CreationTimestamp
-
The time, in milliseconds since the epoch, when the version was created.
type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
GET
GET
/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions
Operation ID: ListSubscriptionDefinitionVersions
Lists the versions of a subscription definition.
Produces: application/json
Path Parameters
- SubscriptionDefinitionId
-
The ID of the subscription definition.
where used: path; required: true
type: string
Query Parameters
- NextToken
-
The token for the next set of results, or
nullif there are no more results.where used: query; required: false
type: string
- MaxResults
-
The maximum number of results to be returned per request.
where used: query; required: false
type: integer
CLI
aws greengrass list-subscription-definition-versions \ --subscription-definition-id <value> \ [--next-token <value>] \ [--max-results <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "SubscriptionDefinitionId": "string", "NextToken": "string", "MaxResults": "integer" }
Responses
- 200 (ListSubscriptionDefinitionVersionsResponse)
-
{ "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
- 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
nullif there are no more results.type: string
- 400
-
Invalid request.
{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }- GeneralError
-
General error information.
type: object
required: ["Message"]
- Message
-
A message that contains information about the error.
type: string
- ErrorDetails
-
A list of error details.
type: array
items: ErrorDetail
- ErrorDetail
-
Details about the error.
type: object
- DetailedErrorCode
-
A detailed error code.
type: string
- DetailedErrorMessage
-
A detailed error message.
type: string
