AWS IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the AWS IoT Greengrass V1 maintenance policy. After this date, AWS IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on AWS IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to AWS IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
GET
GET
/greengrass/definition/subscriptions/SubscriptionDefinitionId/versions/SubscriptionDefinitionVersionId
Operation ID: GetSubscriptionDefinitionVersion
Retrieves information about a subscription definition version.
Produces: application/json
Path Parameters
- SubscriptionDefinitionId
-
The ID of the subscription definition.
where used: path; required: true
type: string
- SubscriptionDefinitionVersionId
-
The ID of the subscription definition version. This value maps to the
Versionproperty of the correspondingVersionInformationobject, which is returned byListSubscriptionDefinitionVersionsrequests. If the version is the last one that was associated with a subscription definition, the value also maps to theLatestVersionproperty of the correspondingDefinitionInformationobject.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
CLI
aws greengrass get-subscription-definition-version \ --subscription-definition-id <value> \ --subscription-definition-version-id <value> \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{
"SubscriptionDefinitionId": "string",
"SubscriptionDefinitionVersionId": "string",
"NextToken": "string"
}Responses
- 200 (GetSubscriptionDefinitionVersionResponse)
-
GetSubscriptionDefinitionVersionResponse
{ "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
- 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
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
