« blib/lib/Paws/IoT/UpdateThingResponse.pm
↑ Summary
blib/lib/Paws/IoT/UpdateTopicRuleDestinationResponse.pm »
| 1 | |||
| 2 | package Paws::IoT::UpdateTopicRuleDestination; | ||
| 3 | use Moose; | ||
| 4 | has Arn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'arn', required => 1); | ||
| 5 | has Status => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'status', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTopicRuleDestination'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/destinations'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::IoT::UpdateTopicRuleDestinationResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::IoT::UpdateTopicRuleDestination - Arguments for method UpdateTopicRuleDestination on L<Paws::IoT> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UpdateTopicRuleDestination on the | ||
| 24 | L<AWS IoT|Paws::IoT> service. Use the attributes of this class | ||
| 25 | as arguments to method UpdateTopicRuleDestination. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTopicRuleDestination. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $iot = Paws->service('IoT'); | ||
| 32 | my $UpdateTopicRuleDestinationResponse = $iot->UpdateTopicRuleDestination( | ||
| 33 | Arn => 'MyAwsArn', | ||
| 34 | Status => 'ENABLED', | ||
| 35 | |||
| 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/iot/UpdateTopicRuleDestination> | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> Arn => Str | ||
| 45 | |||
| 46 | The ARN of the topic rule destination. | ||
| 47 | |||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> Status => Str | ||
| 51 | |||
| 52 | The status of the topic rule destination. Valid values are: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item IN_PROGRESS | ||
| 57 | |||
| 58 | A topic rule destination was created but has not been confirmed. You | ||
| 59 | can set C<status> to C<IN_PROGRESS> by calling | ||
| 60 | C<UpdateTopicRuleDestination>. Calling C<UpdateTopicRuleDestination> | ||
| 61 | causes a new confirmation challenge to be sent to your confirmation | ||
| 62 | endpoint. | ||
| 63 | |||
| 64 | =item ENABLED | ||
| 65 | |||
| 66 | Confirmation was completed, and traffic to this destination is allowed. | ||
| 67 | You can set C<status> to C<DISABLED> by calling | ||
| 68 | C<UpdateTopicRuleDestination>. | ||
| 69 | |||
| 70 | =item DISABLED | ||
| 71 | |||
| 72 | Confirmation was completed, and traffic to this destination is not | ||
| 73 | allowed. You can set C<status> to C<ENABLED> by calling | ||
| 74 | C<UpdateTopicRuleDestination>. | ||
| 75 | |||
| 76 | =item ERROR | ||
| 77 | |||
| 78 | Confirmation could not be completed, for example if the confirmation | ||
| 79 | timed out. You can call C<GetTopicRuleDestination> for details about | ||
| 80 | the error. You can set C<status> to C<IN_PROGRESS> by calling | ||
| 81 | C<UpdateTopicRuleDestination>. Calling C<UpdateTopicRuleDestination> | ||
| 82 | causes a new confirmation challenge to be sent to your confirmation | ||
| 83 | endpoint. | ||
| 84 | |||
| 85 | =back | ||
| 86 | |||
| 87 | |||
| 88 | Valid values are: C<"ENABLED">, C<"IN_PROGRESS">, C<"DISABLED">, C<"ERROR">, C<"DELETING"> | ||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method UpdateTopicRuleDestination in L<Paws::IoT> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |