Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . greengrass ]

get-subscription-definition-version

Description

Retrieves information about a subscription definition version.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-subscription-definition-version
[--next-token <value>]
--subscription-definition-id <value>
--subscription-definition-version-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--next-token (string) The token for the next set of results, or ''null'' if there are no additional results.

--subscription-definition-id (string) The ID of the subscription definition.

--subscription-definition-version-id (string) 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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To retrieve information about a specific version of a subscription definition

The following get-subscription-definition-version example retrieves retrieves information about the specified version of the specified subscription definition. To retrieve the IDs of all versions of the subscription definition, use the list-subscription-definition-versions command. To retrieve the ID of the last version added to the subscription definition, use the get-subscription-definition command and check the LatestVersion property.

aws greengrass get-subscription-definition-version \
    --subscription-definition-id "70e49321-83d5-45d2-bc09-81f4917ae152" \
    --subscription-definition-version-id "88ae8699-12ac-4663-ba3f-4d7f0519140b"

Output:

{
    "Arn": "arn:aws:greengrass:us-west-2:123456789012:/greengrass/definition/subscriptions/70e49321-83d5-45d2-bc09-81f4917ae152/versions/88ae8699-12ac-4663-ba3f-4d7f0519140b",
    "CreationTimestamp": "2019-06-18T17:03:52.499Z",
    "Definition": {
        "Subscriptions": [
            {
                "Id": "692c4484-d89f-4f64-8edd-1a041a65e5b6",
                "Source": "arn:aws:lambda:us-west-2:123456789012:function:Greengrass_HelloWorld:GG_HelloWorld",
                "Subject": "hello/world",
                "Target": "cloud"
            }
        ]
    },
    "Id": "70e49321-83d5-45d2-bc09-81f4917ae152",
    "Version": "88ae8699-12ac-4663-ba3f-4d7f0519140b"
}

Output

Arn -> (string)

The ARN of the subscription definition version.

CreationTimestamp -> (string)

The time, in milliseconds since the epoch, when the subscription definition version was created.

Definition -> (structure)

Information about the subscription definition version.

Subscriptions -> (list)

A list of subscriptions.

(structure)

Information about a subscription.

Id -> (string)

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:_-]+''.

Source -> (string)

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

Subject -> (string)

The MQTT topic used to route the message.

Target -> (string)

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

Id -> (string)

The ID of the subscription definition version.

NextToken -> (string)

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

Version -> (string)

The version of the subscription definition version.