« blib/lib/Paws/DocDB/DescribeDBEngineVersions.pm
↑ Summary
blib/lib/Paws/DocDB/DescribeDBSubnetGroups.pm »
| 1 | |||
| 2 | package Paws::DocDB::DescribeDBInstances; | ||
| 3 | use Moose; | ||
| 4 | has DBInstanceIdentifier => (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 => 'DescribeDBInstances'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DocDB::DBInstanceMessage'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'DescribeDBInstancesResult'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::DocDB::DescribeDBInstances - Arguments for method DescribeDBInstances on L<Paws::DocDB> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeDBInstances on the | ||
| 25 | L<Amazon DocumentDB with MongoDB compatibility|Paws::DocDB> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeDBInstances. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeDBInstances. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $rds = Paws->service('DocDB'); | ||
| 33 | my $DBInstanceMessage = $rds->DescribeDBInstances( | ||
| 34 | DBInstanceIdentifier => '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 $DBInstances = $DBInstanceMessage->DBInstances; | ||
| 49 | my $Marker = $DBInstanceMessage->Marker; | ||
| 50 | |||
| 51 | # Returns a L<Paws::DocDB::DBInstanceMessage> 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/DescribeDBInstances> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 DBInstanceIdentifier => Str | ||
| 60 | |||
| 61 | The user-provided instance identifier. If this parameter is specified, | ||
| 62 | information from only the specific instance is returned. This parameter | ||
| 63 | isn't case sensitive. | ||
| 64 | |||
| 65 | Constraints: | ||
| 66 | |||
| 67 | =over | ||
| 68 | |||
| 69 | =item * | ||
| 70 | |||
| 71 | If provided, must match the identifier of an existing C<DBInstance>. | ||
| 72 | |||
| 73 | =back | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Filters => ArrayRef[L<Paws::DocDB::Filter>] | ||
| 79 | |||
| 80 | A filter that specifies one or more instances to describe. | ||
| 81 | |||
| 82 | Supported filters: | ||
| 83 | |||
| 84 | =over | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<db-cluster-id> - Accepts cluster identifiers and cluster Amazon | ||
| 89 | Resource Names (ARNs). The results list includes only the information | ||
| 90 | about the instances that are associated with the clusters that are | ||
| 91 | identified by these ARNs. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<db-instance-id> - Accepts instance identifiers and instance ARNs. The | ||
| 96 | results list includes only the information about the instances that are | ||
| 97 | identified by these ARNs. | ||
| 98 | |||
| 99 | =back | ||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | |||
| 104 | =head2 Marker => Str | ||
| 105 | |||
| 106 | An optional pagination token provided by a previous request. If this | ||
| 107 | parameter is specified, the response includes only records beyond the | ||
| 108 | marker, up to the value specified by C<MaxRecords>. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 MaxRecords => Int | ||
| 113 | |||
| 114 | The maximum number of records to include in the response. If more | ||
| 115 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 116 | token (marker) is included in the response so that the remaining | ||
| 117 | results can be retrieved. | ||
| 118 | |||
| 119 | Default: 100 | ||
| 120 | |||
| 121 | Constraints: Minimum 20, maximum 100. | ||
| 122 | |||
| 123 | |||
| 124 | |||
| 125 | |||
| 126 | =head1 SEE ALSO | ||
| 127 | |||
| 128 | This class forms part of L<Paws>, documenting arguments for method DescribeDBInstances in L<Paws::DocDB> | ||
| 129 | |||
| 130 | =head1 BUGS and CONTRIBUTIONS | ||
| 131 | |||
| 132 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 133 | |||
| 134 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 135 | |||
| 136 | =cut | ||
| 137 |