Menu
AWS Greengrass
API Reference

/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.

where used: path; required: true

type: string

CLI

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

cli-input-json format:

Copy
{ "SubscriptionDefinitionId": "string", "SubscriptionDefinitionVersionId": "string" }

Responses

200 (GetSubscriptionDefinitionVersionResponse)

GetSubscriptionDefinitionVersionResponse

Copy
{ "Arn": "string", "Id": "string", "Version": "string", "CreationTimestamp": "string", "Definition": { "Subscriptions": [ { "Id": "string", "Source": "string", "Subject": "string", "Target": "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

The id of the subscription.

type: string

Source

The source of the subscription. Can be a thing ARN, lambda ARN or the word 'cloud'.

type: string

Subject

The subject of the message.

type: string

Target

Where the message is sent to. Can be a thing ARN, lambda ARN or the word 'cloud'.

type: string

400

invalid request

GeneralError

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

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

On this page: