« blib/lib/Paws/DMS/DescribeEventSubscriptionsResponse.pm
↑ Summary
blib/lib/Paws/DMS/DescribeEventsResponse.pm »
| 1 | |||
| 2 | package Paws::DMS::DescribeEvents; | ||
| 3 | use Moose; | ||
| 4 | has Duration => (is => 'ro', isa => 'Int'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has EventCategories => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 7 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::DMS::Filter]'); | ||
| 8 | has Marker => (is => 'ro', isa => 'Str'); | ||
| 9 | has MaxRecords => (is => 'ro', isa => 'Int'); | ||
| 10 | has SourceIdentifier => (is => 'ro', isa => 'Str'); | ||
| 11 | has SourceType => (is => 'ro', isa => 'Str'); | ||
| 12 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeEvents'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DMS::DescribeEventsResponse'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::DMS::DescribeEvents - Arguments for method DescribeEvents on L<Paws::DMS> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method DescribeEvents on the | ||
| 30 | L<AWS Database Migration Service|Paws::DMS> service. Use the attributes of this class | ||
| 31 | as arguments to method DescribeEvents. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeEvents. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $dms = Paws->service('DMS'); | ||
| 38 | my $DescribeEventsResponse = $dms->DescribeEvents( | ||
| 39 | Duration => 1, # OPTIONAL | ||
| 40 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 41 | EventCategories => [ 'MyString', ... ], # OPTIONAL | ||
| 42 | Filters => [ | ||
| 43 | { | ||
| 44 | Name => 'MyString', | ||
| 45 | Values => [ 'MyString', ... ], | ||
| 46 | |||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | Marker => 'MyString', # OPTIONAL | ||
| 51 | MaxRecords => 1, # OPTIONAL | ||
| 52 | SourceIdentifier => 'MyString', # OPTIONAL | ||
| 53 | SourceType => 'replication-instance', # OPTIONAL | ||
| 54 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 55 | ); | ||
| 56 | |||
| 57 | # Results: | ||
| 58 | my $Events = $DescribeEventsResponse->Events; | ||
| 59 | my $Marker = $DescribeEventsResponse->Marker; | ||
| 60 | |||
| 61 | # Returns a L<Paws::DMS::DescribeEventsResponse> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dms/DescribeEvents> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Duration => Int | ||
| 70 | |||
| 71 | The duration of the events to be listed. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 EndTime => Str | ||
| 76 | |||
| 77 | The end time for the events to be listed. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 EventCategories => ArrayRef[Str|Undef] | ||
| 82 | |||
| 83 | A list of event categories for the source type that you've chosen. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 Filters => ArrayRef[L<Paws::DMS::Filter>] | ||
| 88 | |||
| 89 | Filters applied to events. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 Marker => Str | ||
| 94 | |||
| 95 | An optional pagination token provided by a previous request. If this | ||
| 96 | parameter is specified, the response includes only records beyond the | ||
| 97 | marker, up to the value specified by C<MaxRecords>. | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 MaxRecords => Int | ||
| 102 | |||
| 103 | The maximum number of records to include in the response. If more | ||
| 104 | records exist than the specified C<MaxRecords> value, a pagination | ||
| 105 | token called a marker is included in the response so that the remaining | ||
| 106 | results can be retrieved. | ||
| 107 | |||
| 108 | Default: 100 | ||
| 109 | |||
| 110 | Constraints: Minimum 20, maximum 100. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 SourceIdentifier => Str | ||
| 115 | |||
| 116 | The identifier of an event source. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 SourceType => Str | ||
| 121 | |||
| 122 | The type of AWS DMS resource that generates events. | ||
| 123 | |||
| 124 | Valid values: replication-instance | replication-task | ||
| 125 | |||
| 126 | Valid values are: C<"replication-instance"> | ||
| 127 | |||
| 128 | =head2 StartTime => Str | ||
| 129 | |||
| 130 | The start time for the events to be listed. | ||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head1 SEE ALSO | ||
| 136 | |||
| 137 | This class forms part of L<Paws>, documenting arguments for method DescribeEvents in L<Paws::DMS> | ||
| 138 | |||
| 139 | =head1 BUGS and CONTRIBUTIONS | ||
| 140 | |||
| 141 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 142 | |||
| 143 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 144 | |||
| 145 | =cut | ||
| 146 |