| 1 | |||
| 2 | package Paws::SNS::SetSubscriptionAttributes; | ||
| 3 | use Moose; | ||
| 4 | has AttributeName => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has AttributeValue => (is => 'ro', isa => 'Str'); | ||
| 6 | has SubscriptionArn => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'SetSubscriptionAttributes'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::API::Response'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::SNS::SetSubscriptionAttributes - Arguments for method SetSubscriptionAttributes on L<Paws::SNS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method SetSubscriptionAttributes on the | ||
| 24 | L<Amazon Simple Notification Service|Paws::SNS> service. Use the attributes of this class | ||
| 25 | as arguments to method SetSubscriptionAttributes. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SetSubscriptionAttributes. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $sns = Paws->service('SNS'); | ||
| 32 | $sns->SetSubscriptionAttributes( | ||
| 33 | AttributeName => 'MyattributeName', | ||
| 34 | SubscriptionArn => 'MysubscriptionARN', | ||
| 35 | AttributeValue => 'MyattributeValue', # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 39 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/sns/SetSubscriptionAttributes> | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> AttributeName => Str | ||
| 45 | |||
| 46 | A map of attributes with their corresponding values. | ||
| 47 | |||
| 48 | The following lists the names, descriptions, and values of the special | ||
| 49 | request parameters that this action uses: | ||
| 50 | |||
| 51 | =over | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | C<DeliveryPolicy> E<ndash> The policy that defines how Amazon SNS | ||
| 56 | retries failed deliveries to HTTP/S endpoints. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | C<FilterPolicy> E<ndash> The simple JSON object that lets your | ||
| 61 | subscriber receive only a subset of messages, rather than receiving | ||
| 62 | every message published to the topic. | ||
| 63 | |||
| 64 | =item * | ||
| 65 | |||
| 66 | C<RawMessageDelivery> E<ndash> When set to C<true>, enables raw message | ||
| 67 | delivery to Amazon SQS or HTTP/S endpoints. This eliminates the need | ||
| 68 | for the endpoints to process JSON formatting, which is otherwise | ||
| 69 | created for Amazon SNS metadata. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | C<RedrivePolicy> E<ndash> When specified, sends undeliverable messages | ||
| 74 | to the specified Amazon SQS dead-letter queue. Messages that can't be | ||
| 75 | delivered due to client errors (for example, when the subscribed | ||
| 76 | endpoint is unreachable) or server errors (for example, when the | ||
| 77 | service that powers the subscribed endpoint becomes unavailable) are | ||
| 78 | held in the dead-letter queue for further analysis or reprocessing. | ||
| 79 | |||
| 80 | =back | ||
| 81 | |||
| 82 | The following attribute applies only to Amazon Kinesis Data Firehose | ||
| 83 | delivery stream subscriptions: | ||
| 84 | |||
| 85 | =over | ||
| 86 | |||
| 87 | =item * | ||
| 88 | |||
| 89 | C<SubscriptionRoleArn> E<ndash> The ARN of the IAM role that has the | ||
| 90 | following: | ||
| 91 | |||
| 92 | =over | ||
| 93 | |||
| 94 | =item * | ||
| 95 | |||
| 96 | Permission to write to the Kinesis Data Firehose delivery stream | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | Amazon SNS listed as a trusted entity | ||
| 101 | |||
| 102 | =back | ||
| 103 | |||
| 104 | Specifying a valid ARN for this attribute is required for Kinesis Data | ||
| 105 | Firehose delivery stream subscriptions. For more information, see | ||
| 106 | Fanout to Kinesis Data Firehose delivery streams | ||
| 107 | (https://docs.aws.amazon.com/sns/latest/dg/sns-firehose-as-subscriber.html) | ||
| 108 | in the I<Amazon SNS Developer Guide>. | ||
| 109 | |||
| 110 | =back | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 AttributeValue => Str | ||
| 116 | |||
| 117 | The new value for the attribute in JSON format. | ||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head2 B<REQUIRED> SubscriptionArn => Str | ||
| 122 | |||
| 123 | The ARN of the subscription to modify. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head1 SEE ALSO | ||
| 129 | |||
| 130 | This class forms part of L<Paws>, documenting arguments for method SetSubscriptionAttributes in L<Paws::SNS> | ||
| 131 | |||
| 132 | =head1 BUGS and CONTRIBUTIONS | ||
| 133 | |||
| 134 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 135 | |||
| 136 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 137 | |||
| 138 | =cut | ||
| 139 |