« blib/lib/Paws/DMS/DescribeCertificatesResponse.pm
↑ Summary
blib/lib/Paws/DMS/DescribeConnectionsResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::DescribeConnections; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DMS::Filter]'); | ||
| 5 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 6 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeConnections'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::DescribeConnectionsResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::DMS::DescribeConnections - Arguments for method DescribeConnections on L<Paws::DMS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeConnections on the | ||
| 24 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeConnections. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeConnections. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $dms = Paws->service('DMS'); | ||
| 32 | # Describe connections | ||
| 33 | # Describes the status of the connections that have been made between the | ||
| 34 | # replication instance and an endpoint. Connections are created when you test an | ||
| 35 | # endpoint. | ||
| 36 | my $DescribeConnectionsResponse = $dms->DescribeConnections( | ||
| 37 | 'Filters' => [ | ||
| 38 | |||
| 39 | { | ||
| 40 | 'Name' => 'string', | ||
| 41 | 'Values' => [ 'string', 'string' ] | ||
| 42 | } | ||
| 43 | ], | ||
| 44 | 'Marker' => '', | ||
| 45 | 'MaxRecords' => 123 | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Connections = $DescribeConnectionsResponse->Connections; | ||
| 50 | my $Marker = $DescribeConnectionsResponse->Marker; | ||
| 51 | |||
| 52 | # Returns a L<Paws::DMS::DescribeConnectionsResponse> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/DescribeConnections> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 Filters => ArrayRef[L<Paws::DMS::Filter>] | ||
| 61 | |||
| 62 | The filters applied to the connection. | ||
| 63 | |||
| 64 | Valid filter names: endpoint-arn | replication-instance-arn | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Marker => Str | ||
| 69 | |||
| 70 | An optional pagination token provided by a previous request. If this | ||
| 71 | parameter is specified, the response includes only records beyond the | ||
| 72 | marker, up to the value specified by C<MaxRecords>. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 MaxRecords => Int | ||
| 77 | |||
| 78 | The maximum number of records to include in the response. If more | ||
| 79 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 80 | token called a marker is included in the response so that the remaining | ||
| 81 | results can be retrieved. | ||
| 82 | |||
| 83 | Default: 100 | ||
| 84 | |||
| 85 | Constraints: Minimum 20, maximum 100. | ||
| 86 | |||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head1 SEE ALSO | ||
| 91 | |||
| 92 | This class forms part of L<Paws>, documenting arguments for method DescribeConnections in L<Paws::DMS> | ||
| 93 | |||
| 94 | =head1 BUGS and CONTRIBUTIONS | ||
| 95 | |||
| 96 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 97 | |||
| 98 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 99 | |||
| 100 | =cut | ||
| 101 |