Table Of Contents

Feedback

User Guide

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

[ aws . sns ]

get-subscription-attributes

Description

Returns all of the properties of a subscription.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-subscription-attributes
--subscription-arn <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--subscription-arn (string)

The ARN of the subscription whose properties you want to get.

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

The following command gets the attributes of a subscription to a topic named my-topic:

aws sns get-subscription-attributes --subscription-arn "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f"

The subscription-arn is available in the output of aws sns list-subscriptions.

Output:

{
    "Attributes": {
        "Endpoint": "my-email@example.com",
        "Protocol": "email",
        "RawMessageDelivery": "false",
        "ConfirmationWasAuthenticated": "false",
        "Owner": "0123456789012",
        "SubscriptionArn": "arn:aws:sns:us-west-2:0123456789012:my-topic:8a21d249-4329-4871-acc6-7be709c6ea7f",
        "TopicArn": "arn:aws:sns:us-west-2:0123456789012:my-topic"
    }
}

Output

Attributes -> (map)

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticatedtrue if the subscription confirmation request was authenticated.
  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.
  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.
  • FilterPolicy – The filter policy JSON that is assigned to the subscription.
  • Owner – The AWS account ID of the subscription's owner.
  • PendingConfirmationtrue if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.
  • RawMessageDeliverytrue if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.
  • SubscriptionArn – The subscription's ARN.
  • TopicArn – The topic ARN that the subscription is associated with.

key -> (string)

value -> (string)