| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.DMS.DescribeReplicationTasks
Description
Returns information about replication tasks for your account in the current region.
This operation returns paginated results.
Synopsis
- data DescribeReplicationTasks = DescribeReplicationTasks' {}
- newDescribeReplicationTasks :: DescribeReplicationTasks
- describeReplicationTasks_filters :: Lens' DescribeReplicationTasks (Maybe [Filter])
- describeReplicationTasks_withoutSettings :: Lens' DescribeReplicationTasks (Maybe Bool)
- describeReplicationTasks_marker :: Lens' DescribeReplicationTasks (Maybe Text)
- describeReplicationTasks_maxRecords :: Lens' DescribeReplicationTasks (Maybe Int)
- data DescribeReplicationTasksResponse = DescribeReplicationTasksResponse' {
- replicationTasks :: Maybe [ReplicationTask]
- marker :: Maybe Text
- httpStatus :: Int
- newDescribeReplicationTasksResponse :: Int -> DescribeReplicationTasksResponse
- describeReplicationTasksResponse_replicationTasks :: Lens' DescribeReplicationTasksResponse (Maybe [ReplicationTask])
- describeReplicationTasksResponse_marker :: Lens' DescribeReplicationTasksResponse (Maybe Text)
- describeReplicationTasksResponse_httpStatus :: Lens' DescribeReplicationTasksResponse Int
Creating a Request
data DescribeReplicationTasks Source #
See: newDescribeReplicationTasks smart constructor.
Constructors
| DescribeReplicationTasks' | |
Fields
| |
Instances
newDescribeReplicationTasks :: DescribeReplicationTasks Source #
Create a value of DescribeReplicationTasks with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:filters:DescribeReplicationTasks', describeReplicationTasks_filters - Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
$sel:withoutSettings:DescribeReplicationTasks', describeReplicationTasks_withoutSettings - An option to set to avoid returning information about settings. Use this
to reduce overhead when setting information is too large. To use this
option, choose true; otherwise, choose false (the default).
$sel:marker:DescribeReplicationTasks', describeReplicationTasks_marker - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
$sel:maxRecords:DescribeReplicationTasks', describeReplicationTasks_maxRecords - The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
Request Lenses
describeReplicationTasks_filters :: Lens' DescribeReplicationTasks (Maybe [Filter]) Source #
Filters applied to replication tasks.
Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn
describeReplicationTasks_withoutSettings :: Lens' DescribeReplicationTasks (Maybe Bool) Source #
An option to set to avoid returning information about settings. Use this
to reduce overhead when setting information is too large. To use this
option, choose true; otherwise, choose false (the default).
describeReplicationTasks_marker :: Lens' DescribeReplicationTasks (Maybe Text) Source #
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
describeReplicationTasks_maxRecords :: Lens' DescribeReplicationTasks (Maybe Int) Source #
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords value, a pagination token
called a marker is included in the response so that the remaining
results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
Destructuring the Response
data DescribeReplicationTasksResponse Source #
See: newDescribeReplicationTasksResponse smart constructor.
Constructors
| DescribeReplicationTasksResponse' | |
Fields
| |
Instances
newDescribeReplicationTasksResponse Source #
Create a value of DescribeReplicationTasksResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:replicationTasks:DescribeReplicationTasksResponse', describeReplicationTasksResponse_replicationTasks - A description of the replication tasks.
$sel:marker:DescribeReplicationTasks', describeReplicationTasksResponse_marker - An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
$sel:httpStatus:DescribeReplicationTasksResponse', describeReplicationTasksResponse_httpStatus - The response's http status code.
Response Lenses
describeReplicationTasksResponse_replicationTasks :: Lens' DescribeReplicationTasksResponse (Maybe [ReplicationTask]) Source #
A description of the replication tasks.
describeReplicationTasksResponse_marker :: Lens' DescribeReplicationTasksResponse (Maybe Text) Source #
An optional pagination token provided by a previous request. If this
parameter is specified, the response includes only records beyond the
marker, up to the value specified by MaxRecords.
describeReplicationTasksResponse_httpStatus :: Lens' DescribeReplicationTasksResponse Int Source #
The response's http status code.