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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns all of the properties of a topic. Topic properties returned might differ based on the authorization of the user.

Creating a Request

data GetTopicAttributes Source #

Input for GetTopicAttributes action.

See: newGetTopicAttributes smart constructor.

Constructors

GetTopicAttributes'
Fields topicArn :: Text The ARN of the topic whose properties you want to get.

Instances

Instances details

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

newGetTopicAttributes Source #

Arguments

:: Text	`GetTopicAttributes`
-> GetTopicAttributes

Create a value of GetTopicAttributes 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:

GetTopicAttributes, getTopicAttributes_topicArn - The ARN of the topic whose properties you want to get.

Request Lenses

getTopicAttributes_topicArn :: Lens' GetTopicAttributes Text Source #

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

Destructuring the Response

data GetTopicAttributesResponse Source #

Response for GetTopicAttributes action.

See: newGetTopicAttributesResponse smart constructor.

Constructors

GetTopicAttributesResponse'

Fields

attributes :: Maybe (HashMap Text Text)
A map of the topic's attributes. Attributes in this map include the following:
- DeliveryPolicy – The JSON serialization of the topic's delivery policy.
- DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
- EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
- Owner – The Amazon Web Services account ID of the topic's owner.
- Policy – The JSON serialization of the topic's access control policy.
- SignatureVersion – The version of the Amazon SNS signature used for the topic.
  - By default, SignatureVersion is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
  - When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
    If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
- SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
- SubscriptionsDeleted – The number of deleted subscriptions for the topic.
- SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
- TopicArn – The topic's ARN.
- TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.
The following attribute applies only to server-side-encryption:
- KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.
The following attributes apply only to FIFO topics:
- FifoTopic – When this is set to true, a FIFO topic is created.
- ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
  - By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
  - When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
    (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newGetTopicAttributesResponse Source #

Arguments

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

Create a value of GetTopicAttributesResponse 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:

GetTopicAttributesResponse, getTopicAttributesResponse_attributes - A map of the topic's attributes. Attributes in this map include the following:

DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner – The Amazon Web Services account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SignatureVersion – The version of the Amazon SNS signature used for the topic.
- By default, SignatureVersion is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
- When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
  If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

The following attribute applies only to server-side-encryption:

KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attributes apply only to FIFO topics:

FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
- By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
- When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

$sel:httpStatus:GetTopicAttributesResponse', getTopicAttributesResponse_httpStatus - The response's http status code.

Response Lenses

getTopicAttributesResponse_attributes :: Lens' GetTopicAttributesResponse (Maybe (HashMap Text Text)) Source #

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

DeliveryPolicy – The JSON serialization of the topic's delivery policy.
DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.
EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.
Owner – The Amazon Web Services account ID of the topic's owner.
Policy – The JSON serialization of the topic's access control policy.
SignatureVersion – The version of the Amazon SNS signature used for the topic.
- By default, SignatureVersion is set to 1. The signature is a Base64-encoded SHA1withRSA signature.
- When you set SignatureVersion to 2. Amazon SNS uses a Base64-encoded SHA256withRSA signature.
  If the API response does not include the SignatureVersion attribute, it means that the SignatureVersion for the topic has value 1.
SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.
SubscriptionsDeleted – The number of deleted subscriptions for the topic.
SubscriptionsPending – The number of subscriptions pending confirmation for the topic.
TopicArn – The topic's ARN.
TracingConfig – Tracing mode of an Amazon SNS topic. By default TracingConfig is set to PassThrough, and the topic passes through the tracing header it receives from an Amazon SNS publisher to its subscriptions. If set to Active, Amazon SNS will vend X-Ray segment data to topic owner account if the sampled flag in the tracing header is true. This is only supported on standard topics.

The following attribute applies only to server-side-encryption:

KmsMasterKeyId - The ID of an Amazon Web Services managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the Key Management Service API Reference.

The following attributes apply only to FIFO topics:

FifoTopic – When this is set to true, a FIFO topic is created.
ContentBasedDeduplication – Enables content-based deduplication for FIFO topics.
- By default, ContentBasedDeduplication is set to false. If you create a FIFO topic and this attribute is false, you must specify a value for the MessageDeduplicationId parameter for the Publish action.
- When you set ContentBasedDeduplication to true, Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).
  (Optional) To override the generated value, you can specify a value for the MessageDeduplicationId parameter for the Publish action.

getTopicAttributesResponse_httpStatus :: Lens' GetTopicAttributesResponse Int Source #

The response's http status code.