com.amazonaws.services.sns.model

Class GetSubscriptionAttributesResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.sns.model.GetSubscriptionAttributesResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSubscriptionAttributesResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Response for GetSubscriptionAttributes action.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetSubscriptionAttributesResult()

Method Summary

Modifier and Type	Method and Description
GetSubscriptionAttributesResult	addAttributesEntry(String key, String value) Add a single Attributes entry
GetSubscriptionAttributesResult	clearAttributesEntries() Removes all the entries added into Attributes.
GetSubscriptionAttributesResult	clone()
boolean	equals(Object obj)
Map<String,String>	getAttributes() A map of the subscription's attributes.
int	hashCode()
void	setAttributes(Map<String,String> attributes) A map of the subscription's attributes.
String	toString() Returns a string representation of this object.
GetSubscriptionAttributesResult	withAttributes(Map<String,String> attributes) A map of the subscription's attributes.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSubscriptionAttributesResult

public GetSubscriptionAttributesResult()

Method Detail

getAttributes

public Map<String,String> getAttributes()

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.

Returns:

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.

setAttributes

public void setAttributes(Map<String,String> 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.

Parameters:

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.

withAttributes

public GetSubscriptionAttributesResult withAttributes(Map<String,String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

addAttributesEntry

public GetSubscriptionAttributesResult addAttributesEntry(String key,
                                                          String value)

Add a single Attributes entry

See Also:

withAttributes(java.util.Map<java.lang.String, java.lang.String>)

clearAttributesEntries

public GetSubscriptionAttributesResult clearAttributesEntries()

Removes all the entries added into Attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetSubscriptionAttributesResult clone()

Overrides:

clone in class Object