« blib/lib/Paws/DMS/DescribeConnectionsResponse.pm
↑ Summary
blib/lib/Paws/DMS/DescribeEndpointSettingsResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::DescribeEndpointSettings; | ||
| 3 | use Moose; | ||
| 4 | has EngineName => (is => 'ro', isa => 'Str', required => 1); | ||
| 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 => 'DescribeEndpointSettings'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::DescribeEndpointSettingsResponse'); | ||
| 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::DescribeEndpointSettings - Arguments for method DescribeEndpointSettings on L<Paws::DMS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method DescribeEndpointSettings on the | ||
| 24 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 25 | as arguments to method DescribeEndpointSettings. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEndpointSettings. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $dms = Paws->service('DMS'); | ||
| 32 | my $DescribeEndpointSettingsResponse = $dms->DescribeEndpointSettings( | ||
| 33 | EngineName => 'MyString', | ||
| 34 | Marker => 'MyString', # OPTIONAL | ||
| 35 | MaxRecords => 1, # OPTIONAL | ||
| 36 | ); | ||
| 37 | |||
| 38 | # Results: | ||
| 39 | my $EndpointSettings = $DescribeEndpointSettingsResponse->EndpointSettings; | ||
| 40 | my $Marker = $DescribeEndpointSettingsResponse->Marker; | ||
| 41 | |||
| 42 | # Returns a L<Paws::DMS::DescribeEndpointSettingsResponse> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/DescribeEndpointSettings> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> EngineName => Str | ||
| 51 | |||
| 52 | The databse engine used for your source or target endpoint. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 Marker => Str | ||
| 57 | |||
| 58 | An optional pagination token provided by a previous request. If this | ||
| 59 | parameter is specified, the response includes only records beyond the | ||
| 60 | marker, up to the value specified by C<MaxRecords>. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxRecords => Int | ||
| 65 | |||
| 66 | The maximum number of records to include in the response. If more | ||
| 67 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 68 | token called a marker is included in the response so that the remaining | ||
| 69 | results can be retrieved. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, documenting arguments for method DescribeEndpointSettings in L<Paws::DMS> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |