Skip to content

get_subscription_attributes

Operation

get_subscription_attributes

get_subscription_attributes(request: GetSubscriptionAttributesInput | GetSubscriptionAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSubscriptionAttributesInputDict]) -> GetSubscriptionAttributesOutput

Returns all of the properties of a subscription.

Parameters:

Name Type Description Default
request GetSubscriptionAttributesInput | GetSubscriptionAttributesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetSubscriptionAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSubscriptionAttributesOutput

An instance of GetSubscriptionAttributesOutput.

get_subscription_attributes async

get_subscription_attributes(request: GetSubscriptionAttributesInput | GetSubscriptionAttributesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetSubscriptionAttributesInputDict]) -> GetSubscriptionAttributesOutput

Returns all of the properties of a subscription.

Parameters:

Name Type Description Default
request GetSubscriptionAttributesInput | GetSubscriptionAttributesInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetSubscriptionAttributesInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetSubscriptionAttributesOutput

An instance of GetSubscriptionAttributesOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetSubscriptionAttributesInputDict

Bases: TypedDict

Dictionary form of GetSubscriptionAttributesInput.

Attributes

subscription_arn instance-attribute
subscription_arn: Required[str]

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

GetSubscriptionAttributesInput dataclass

Bases: _SerdeShape

Input for GetSubscriptionAttributes.

Attributes

subscription_arn class-attribute instance-attribute
subscription_arn: str | None = ...

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

Output

GetSubscriptionAttributesOutput dataclass

Bases: _SerdeShape

Response for GetSubscriptionAttributes action.

Attributes

attributes class-attribute instance-attribute
attributes: dict[str, str] | None = ...

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

  • ConfirmationWasAuthenticated -- true 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. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • FilterPolicyScope -- This attribute lets you choose the filtering scope by using one of the following string value types:

  • MessageAttributes (default) -- The filter is applied on the message attributes.

  • MessageBody -- The filter is applied on the message body.

  • Owner -- The Amazon Web Services account ID of the subscription's owner.

  • PendingConfirmation -- true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDelivery -- true 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.

  • RedrivePolicy -- When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  • SubscriptionArn -- The subscription's ARN.

  • TopicArn -- The topic ARN that the subscription is associated with.

The following attribute applies only to Amazon Data Firehose delivery stream subscriptions:

  • SubscriptionRoleArn -- The ARN of the IAM role that has the following:

  • Permission to write to the Firehose delivery stream

  • Amazon SNS listed as a trusted entity

Specifying a valid ARN for this attribute is required for Firehose delivery stream subscriptions. For more information, see Fanout to Firehose delivery streams in the Amazon SNS Developer Guide.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.