Sign In to the Console
Amazon Simple Notification Service
API Reference (API Version 2010-03-31)

AWS Documentation » Amazon SNS » API Reference » Actions » GetTopicAttributes

GetTopicAttributes

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

TopicArn

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

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

Attributes
Attributes.entry.N.key (key)
Attributes.entry.N.value (value)

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

  • TopicArn – the topic's ARN

  • Owner – the AWS account ID of the topic's owner

  • Policy – the JSON serialization of the topic's access control policy

  • DisplayName – the human-readable name used in the "From" field for notifications to email and email-json endpoints

  • SubscriptionsPending – the number of subscriptions pending confirmation on this topic

  • SubscriptionsConfirmed – the number of confirmed subscriptions on this topic

  • SubscriptionsDeleted – the number of deleted subscriptions on this topic

  • DeliveryPolicy – the JSON serialization of the topic's delivery policy

  • EffectiveDeliveryPolicy – the JSON serialization of the effective delivery policy that takes into account system defaults

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Errors.

AuthorizationError

Indicates that the user has been denied access to the requested resource.

HTTP Status Code: 403

InternalError

Indicates an internal service error.

HTTP Status Code: 500

InvalidParameter

Indicates that a request parameter does not comply with the associated constraints.

HTTP Status Code: 400

InvalidSecurity

The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.

HTTP Status Code: 403

NotFound

Indicates that the requested resource does not exist.

HTTP Status Code: 404

Example

The structure of AUTHPARAMS depends on the signature of the API request. For more information, see Examples of Signed Signature Version 4 Requests in the Amazon Web Services General Reference.

Example

Sample Request

https://sns.us-east-2.amazonaws.com/?Action=GetTopicAttributes
&TopicArn=arn%3Aaws%3Asns%3Aus-east-2%3A123456789012%3AMy-Topic
&Version=2010-03-31
&AUTHPARAMS

Sample Response

<GetTopicAttributesResponse xmlns="https://sns.amazonaws.com/doc/2010-03-31/">
    <GetTopicAttributesResult>
        <Attributes>
            <entry>
                <key>Owner</key>
                <value>123456789012</value>
            </entry>
            <entry>
                <key>Policy</key>
                <value>{&quot;Version&quot;:&quot;2008-10-17&quot;,&quot;Id&quot;:&quot;us-east-2/698519295917/test__default_policy_ID&quot;,&quot;Statement&quot;:[{&quot;Effect&quot;:&quot;Allow&quot;,&quot;Sid&quot;:&quot;us-east-2/698519295917/test__default_statement_ID&quot;,&quot;Principal&quot;:{&quot;AWS&quot;:&quot;*&quot;},&quot;Action&quot;:[&quot;SNS:GetTopicAttributes&quot;,&quot;SNS:SetTopicAttributes&quot;,&quot;SNS:AddPermission&quot;,&quot;SNS:RemovePermission&quot;,&quot;SNS:DeleteTopic&quot;,&quot;SNS:Subscribe&quot;,&quot;SNS:ListSubscriptionsByTopic&quot;,&quot;SNS:Publish&quot;,&quot;SNS:Receive&quot;],&quot;Resource&quot;:&quot;arn:aws:sns:us-east-2:698519295917:test&quot;,&quot;Condition&quot;:{&quot;StringLike&quot;:{&quot;AWS:SourceArn&quot;:&quot;arn:aws:*:*:698519295917:*&quot;}}}]}</value>
            </entry>
            <entry>
                <key>TopicArn</key>
                <value>arn:aws:sns:us-east-2:123456789012:My-Topic</value>
            </entry>
        </Attributes>
    </GetTopicAttributesResult>
    <ResponseMetadata>
        <RequestId>057f074c-33a7-11df-9540-99d0768312d3</RequestId>
    </ResponseMetadata>
</GetTopicAttributesResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: