« blib/lib/Paws/DS/DescribeDomainControllersResult.pm
↑ Summary
blib/lib/Paws/DS/DescribeEventTopicsResult.pm »
| 1 | |||
| 2 | package Paws::DS::DescribeEventTopics; | ||
| 3 | use Moose; | ||
| 4 | has DirectoryId => (is => 'ro', isa => 'Str'); | ||
| 5 | has TopicNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEventTopics'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DS::DescribeEventTopicsResult'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::DS::DescribeEventTopics - Arguments for method DescribeEventTopics on L<Paws::DS> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeEventTopics on the | ||
| 23 | L<AWS Directory Service|Paws::DS> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeEventTopics. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEventTopics. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $ds = Paws->service('DS'); | ||
| 31 | my $DescribeEventTopicsResult = $ds->DescribeEventTopics( | ||
| 32 | DirectoryId => 'MyDirectoryId', # OPTIONAL | ||
| 33 | TopicNames => [ | ||
| 34 | 'MyTopicName', ... # min: 1, max: 256 | ||
| 35 | ], # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $EventTopics = $DescribeEventTopicsResult->EventTopics; | ||
| 40 | |||
| 41 | # Returns a L<Paws::DS::DescribeEventTopicsResult> object. | ||
| 42 | |||
| 43 | 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. | ||
| 44 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ds/DescribeEventTopics> | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 DirectoryId => Str | ||
| 50 | |||
| 51 | The Directory ID for which to get the list of associated SNS topics. If | ||
| 52 | this member is null, associations for all Directory IDs are returned. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 TopicNames => ArrayRef[Str|Undef] | ||
| 57 | |||
| 58 | A list of SNS topic names for which to obtain the information. If this | ||
| 59 | member is null, all associations for the specified Directory ID are | ||
| 60 | returned. | ||
| 61 | |||
| 62 | An empty list results in an C<InvalidParameterException> being thrown. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head1 SEE ALSO | ||
| 68 | |||
| 69 | This class forms part of L<Paws>, documenting arguments for method DescribeEventTopics in L<Paws::DS> | ||
| 70 | |||
| 71 | =head1 BUGS and CONTRIBUTIONS | ||
| 72 | |||
| 73 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 74 | |||
| 75 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 76 | |||
| 77 | =cut | ||
| 78 |