« blib/lib/Paws/DocDB/DeleteGlobalClusterResult.pm
↑ Summary
blib/lib/Paws/DocDB/DescribeDBClusterParameterGroups.pm »
| 1 | |||
| 2 | package Paws::DocDB::DescribeCertificates; | ||
| 3 | use Moose; | ||
| 4 | has CertificateIdentifier => (is => 'ro', isa => 'Str'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DocDB::Filter]'); | ||
| 6 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 7 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCertificates'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::CertificateMessage'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeCertificatesResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DocDB::DescribeCertificates - Arguments for method DescribeCertificates on L<Paws::DocDB> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeCertificates on the | ||
| 25 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeCertificates. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCertificates. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('DocDB'); | ||
| 33 | my $CertificateMessage = $rds->DescribeCertificates( | ||
| 34 | CertificateIdentifier => 'MyString', # OPTIONAL | ||
| 35 | Filters => [ | ||
| 36 | { | ||
| 37 | Name => 'MyString', | ||
| 38 | Values => [ 'MyString', ... ], | ||
| 39 | |||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], # OPTIONAL | ||
| 43 | Marker => 'MyString', # OPTIONAL | ||
| 44 | MaxRecords => 1, # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $Certificates = $CertificateMessage->Certificates; | ||
| 49 | my $Marker = $CertificateMessage->Marker; | ||
| 50 | |||
| 51 | # Returns a L<Paws::DocDB::CertificateMessage> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/rds/DescribeCertificates> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 CertificateIdentifier => Str | ||
| 60 | |||
| 61 | The user-supplied certificate identifier. If this parameter is | ||
| 62 | specified, information for only the specified certificate is returned. | ||
| 63 | If this parameter is omitted, a list of up to C<MaxRecords> | ||
| 64 | certificates is returned. This parameter is not case sensitive. | ||
| 65 | |||
| 66 | Constraints | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | Must match an existing C<CertificateIdentifier>. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | |||
| 79 | =head2 Filters => ArrayRef[L<Paws::DocDB::Filter>] | ||
| 80 | |||
| 81 | This parameter is not currently supported. | ||
| 82 | |||
| 83 | |||
| 84 | |||
| 85 | =head2 Marker => Str | ||
| 86 | |||
| 87 | An optional pagination token provided by a previous | ||
| 88 | C<DescribeCertificates> request. If this parameter is specified, the | ||
| 89 | response includes only records beyond the marker, up to the value | ||
| 90 | specified by C<MaxRecords>. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 MaxRecords => Int | ||
| 95 | |||
| 96 | The maximum number of records to include in the response. If more | ||
| 97 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 98 | token called a marker is included in the response so that the remaining | ||
| 99 | results can be retrieved. | ||
| 100 | |||
| 101 | Default: 100 | ||
| 102 | |||
| 103 | Constraints: | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | Minimum: 20 | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | Maximum: 100 | ||
| 114 | |||
| 115 | =back | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method DescribeCertificates in L<Paws::DocDB> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |