« blib/lib/Paws/CloudSearch/DescribeServiceAccessPoliciesResponse.pm
↑ Summary
blib/lib/Paws/CloudSearch/DescribeSuggestersResponse.pm »
| 1 | |||
| 2 | package Paws::CloudSearch::DescribeSuggesters; | ||
| 3 | use Moose; | ||
| 4 | has Deployed => (is => 'ro', isa => 'Bool'); | ||
| 5 | has DomainName => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has SuggesterNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSuggesters'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudSearch::DescribeSuggestersResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeSuggestersResult'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CloudSearch::DescribeSuggesters - Arguments for method DescribeSuggesters on L<Paws::CloudSearch> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeSuggesters on the | ||
| 24 | L<Amazon CloudSearch|Paws::CloudSearch> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeSuggesters. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSuggesters. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $cloudsearch = Paws->service('CloudSearch'); | ||
| 32 | my $DescribeSuggestersResponse = $cloudsearch->DescribeSuggesters( | ||
| 33 | DomainName => 'MyDomainName', | ||
| 34 | Deployed => 1, # OPTIONAL | ||
| 35 | SuggesterNames => [ | ||
| 36 | 'MyStandardName', ... # min: 1, max: 64 | ||
| 37 | ], # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Suggesters = $DescribeSuggestersResponse->Suggesters; | ||
| 42 | |||
| 43 | # Returns a L<Paws::CloudSearch::DescribeSuggestersResponse> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudsearch/DescribeSuggesters> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 Deployed => Bool | ||
| 52 | |||
| 53 | Whether to display the deployed configuration (C<true>) or include any | ||
| 54 | pending changes (C<false>). Defaults to C<false>. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> DomainName => Str | ||
| 59 | |||
| 60 | The name of the domain you want to describe. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 SuggesterNames => ArrayRef[Str|Undef] | ||
| 65 | |||
| 66 | The suggesters you want to describe. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head1 SEE ALSO | ||
| 72 | |||
| 73 | This class forms part of L<Paws>, documenting arguments for method DescribeSuggesters in L<Paws::CloudSearch> | ||
| 74 | |||
| 75 | =head1 BUGS and CONTRIBUTIONS | ||
| 76 | |||
| 77 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 78 | |||
| 79 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 80 | |||
| 81 | =cut | ||
| 82 |