AWS Greengrass
API Reference

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 <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" }

Parameters:

SubscriptionDefinitionId

The ID of the subscription definition.

where used: path; required: true

type: string

SubscriptionDefinitionVersionId

The ID of the subscription definition version.

where used: path; required: true

type: string

NextToken

The token for the next set of results, or null if there are no additional results.

where used: query; required: false

type: 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. Max length is 128 characters with pattern [a‑zA‑Z0‑9:_‑]+.

type: string

Source

The source of the subscription. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

type: string

Subject

The subject of the message.

type: string

Target

Where the message is sent to. Can be a thing ARN, a Lambda function ARN, a connector ARN, 'cloud' (which represents the AWS IoT cloud), or 'GGShadowService'.

type: string

NextToken

The token for the next set of results, or null if there are no additional results.

type: string

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string