Greengrass / Client / get_subscription_definition_version

get_subscription_definition_version#

Greengrass.Client.get_subscription_definition_version(**kwargs)#

Retrieves information about a subscription definition version.

See also: AWS API Documentation

Request Syntax

response = client.get_subscription_definition_version(
    NextToken='string',
    SubscriptionDefinitionId='string',
    SubscriptionDefinitionVersionId='string'
)
Parameters:

  • NextToken (string) – The token for the next set of results, or ‘’null’’ if there are no additional results.

  • SubscriptionDefinitionId (string) – [REQUIRED] The ID of the subscription definition.

  • SubscriptionDefinitionVersionId (string) – [REQUIRED] 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.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'CreationTimestamp': 'string',
    'Definition': {
        'Subscriptions': [
            {
                'Id': 'string',
                'Source': 'string',
                'Subject': 'string',
                'Target': 'string'
            },
        ]
    },
    'Id': 'string',
    'NextToken': 'string',
    'Version': 'string'
}

Response Structure

  • (dict) –

    • 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 (dict) – Information about the subscription definition version.

      • Subscriptions (list) – A list of subscriptions.

        • (dict) – 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.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException