Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.SNS.GetSubscriptionAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns all of the properties of a subscription.

Creating a Request

data GetSubscriptionAttributes Source #

Input for GetSubscriptionAttributes.

See: newGetSubscriptionAttributes smart constructor.

Constructors

GetSubscriptionAttributes'
Fields subscriptionArn :: Text The ARN of the subscription whose properties you want to get.

Instances

Instances details

ToHeaders GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods toHeaders :: GetSubscriptionAttributes -> [Header] #
ToPath GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods toPath :: GetSubscriptionAttributes -> ByteString #
ToQuery GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods toQuery :: GetSubscriptionAttributes -> QueryString #
AWSRequest GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Associated Types type AWSResponse GetSubscriptionAttributes # Methods request :: (Service -> Service) -> GetSubscriptionAttributes -> Request GetSubscriptionAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSubscriptionAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSubscriptionAttributes))) #
Generic GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Associated Types type Rep GetSubscriptionAttributes :: Type -> Type # Methods from :: GetSubscriptionAttributes -> Rep GetSubscriptionAttributes x # to :: Rep GetSubscriptionAttributes x -> GetSubscriptionAttributes #
Read GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods readsPrec :: Int -> ReadS GetSubscriptionAttributes # readList :: ReadS [GetSubscriptionAttributes] # readPrec :: ReadPrec GetSubscriptionAttributes # readListPrec :: ReadPrec [GetSubscriptionAttributes] #
Show GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods showsPrec :: Int -> GetSubscriptionAttributes -> ShowS # show :: GetSubscriptionAttributes -> String # showList :: [GetSubscriptionAttributes] -> ShowS #
NFData GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods rnf :: GetSubscriptionAttributes -> () #
Eq GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods (==) :: GetSubscriptionAttributes -> GetSubscriptionAttributes -> Bool # (/=) :: GetSubscriptionAttributes -> GetSubscriptionAttributes -> Bool #
Hashable GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods hashWithSalt :: Int -> GetSubscriptionAttributes -> Int # hash :: GetSubscriptionAttributes -> Int #
type AWSResponse GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes type AWSResponse GetSubscriptionAttributes = GetSubscriptionAttributesResponse
type Rep GetSubscriptionAttributes Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes type Rep GetSubscriptionAttributes = D1 ('MetaData "GetSubscriptionAttributes" "Amazonka.SNS.GetSubscriptionAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "GetSubscriptionAttributes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subscriptionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetSubscriptionAttributes Source #

Arguments

:: Text	`GetSubscriptionAttributes`
-> GetSubscriptionAttributes

Create a value of GetSubscriptionAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSubscriptionAttributes, getSubscriptionAttributes_subscriptionArn - The ARN of the subscription whose properties you want to get.

Request Lenses

getSubscriptionAttributes_subscriptionArn :: Lens' GetSubscriptionAttributes Text Source #

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

Destructuring the Response

data GetSubscriptionAttributesResponse Source #

Response for GetSubscriptionAttributes action.

See: newGetSubscriptionAttributesResponse smart constructor.

Constructors

GetSubscriptionAttributesResponse'

Fields

attributes :: Maybe (HashMap Text Text)
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 Kinesis Data Firehose delivery stream subscriptions:
- SubscriptionRoleArn – The ARN of the IAM role that has the following:
  - Permission to write to the Kinesis Data Firehose delivery stream
  - Amazon SNS listed as a trusted entity
  Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Associated Types type Rep GetSubscriptionAttributesResponse :: Type -> Type # Methods from :: GetSubscriptionAttributesResponse -> Rep GetSubscriptionAttributesResponse x # to :: Rep GetSubscriptionAttributesResponse x -> GetSubscriptionAttributesResponse #
Read GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods readsPrec :: Int -> ReadS GetSubscriptionAttributesResponse # readList :: ReadS [GetSubscriptionAttributesResponse] # readPrec :: ReadPrec GetSubscriptionAttributesResponse # readListPrec :: ReadPrec [GetSubscriptionAttributesResponse] #
Show GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods showsPrec :: Int -> GetSubscriptionAttributesResponse -> ShowS # show :: GetSubscriptionAttributesResponse -> String # showList :: [GetSubscriptionAttributesResponse] -> ShowS #
NFData GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods rnf :: GetSubscriptionAttributesResponse -> () #
Eq GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes Methods (==) :: GetSubscriptionAttributesResponse -> GetSubscriptionAttributesResponse -> Bool # (/=) :: GetSubscriptionAttributesResponse -> GetSubscriptionAttributesResponse -> Bool #
type Rep GetSubscriptionAttributesResponse Source #
Instance details Defined in Amazonka.SNS.GetSubscriptionAttributes type Rep GetSubscriptionAttributesResponse = D1 ('MetaData "GetSubscriptionAttributesResponse" "Amazonka.SNS.GetSubscriptionAttributes" "amazonka-sns-2.0-4k7AiJI7DyqhOUy5o4qb9" 'False) (C1 ('MetaCons "GetSubscriptionAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetSubscriptionAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSubscriptionAttributesResponse'`
-> GetSubscriptionAttributesResponse

Create a value of GetSubscriptionAttributesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSubscriptionAttributesResponse, getSubscriptionAttributesResponse_attributes - 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 Kinesis Data Firehose delivery stream subscriptions:

SubscriptionRoleArn – The ARN of the IAM role that has the following:
- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

$sel:httpStatus:GetSubscriptionAttributesResponse', getSubscriptionAttributesResponse_httpStatus - The response's http status code.

Response Lenses

getSubscriptionAttributesResponse_attributes :: Lens' GetSubscriptionAttributesResponse (Maybe (HashMap Text Text)) Source #

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 Kinesis Data Firehose delivery stream subscriptions:

SubscriptionRoleArn – The ARN of the IAM role that has the following:
- Permission to write to the Kinesis Data Firehose delivery stream
- Amazon SNS listed as a trusted entity
Specifying a valid ARN for this attribute is required for Kinesis Data Firehose delivery stream subscriptions. For more information, see Fanout to Kinesis Data Firehose delivery streams in the Amazon SNS Developer Guide.

getSubscriptionAttributesResponse_httpStatus :: Lens' GetSubscriptionAttributesResponse Int Source #

The response's http status code.