Amazonka.DMS.DescribeReplicationTasks

Returns information about replication tasks for your account in the current region.

This operation returns paginated results.

Creating a Request

data DescribeReplicationTasks

See: newDescribeReplicationTasks smart constructor.

Constructors

DescribeReplicationTasks'

Fields

• filters :: Maybe [Filter]

  Filters applied to replication tasks.

  Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

• marker :: Maybe Text

  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.

• maxRecords :: Maybe Int

  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.

• withoutSettings :: Maybe Bool

  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).

Instances

ToJSON DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

toJSON :: DescribeReplicationTasks -> Value

toEncoding :: DescribeReplicationTasks -> Encoding

toJSONList :: [DescribeReplicationTasks] -> Value

toEncodingList :: [DescribeReplicationTasks] -> Encoding

ToHeaders DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

toHeaders :: DescribeReplicationTasks -> [Header]

ToPath DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

toPath :: DescribeReplicationTasks -> ByteString

ToQuery DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

toQuery :: DescribeReplicationTasks -> QueryString

AWSPager DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

page :: DescribeReplicationTasks -> AWSResponse DescribeReplicationTasks -> Maybe DescribeReplicationTasks

AWSRequest DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Associated Types

type AWSResponse DescribeReplicationTasks

Methods

request :: (Service -> Service) -> DescribeReplicationTasks -> Request DescribeReplicationTasks

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReplicationTasks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReplicationTasks)))

Generic DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Associated Types

type Rep DescribeReplicationTasks :: Type -> Type

Methods

from :: DescribeReplicationTasks -> Rep DescribeReplicationTasks x

to :: Rep DescribeReplicationTasks x -> DescribeReplicationTasks

Read DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

readsPrec :: Int -> ReadS DescribeReplicationTasks

readList :: ReadS [DescribeReplicationTasks]

readPrec :: ReadPrec DescribeReplicationTasks

readListPrec :: ReadPrec [DescribeReplicationTasks]

Show DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

showsPrec :: Int -> DescribeReplicationTasks -> ShowS

show :: DescribeReplicationTasks -> String

showList :: [DescribeReplicationTasks] -> ShowS

NFData DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

rnf :: DescribeReplicationTasks -> ()

Eq DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

(==) :: DescribeReplicationTasks -> DescribeReplicationTasks -> Bool

(/=) :: DescribeReplicationTasks -> DescribeReplicationTasks -> Bool

Hashable DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

hashWithSalt :: Int -> DescribeReplicationTasks -> Int

hash :: DescribeReplicationTasks -> Int

type AWSResponse DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

type AWSResponse DescribeReplicationTasks = DescribeReplicationTasksResponse

type Rep DescribeReplicationTasks

Defined in Amazonka.DMS.DescribeReplicationTasks

type Rep DescribeReplicationTasks = D1 ('MetaData "DescribeReplicationTasks" "Amazonka.DMS.DescribeReplicationTasks" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeReplicationTasks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "withoutSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDescribeReplicationTasks :: DescribeReplicationTasks

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

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.

$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).

Request Lenses

describeReplicationTasks_filters :: Lens' DescribeReplicationTasks (Maybe [Filter])

Filters applied to replication tasks.

Valid filter names: replication-task-arn | replication-task-id | migration-type | endpoint-arn | replication-instance-arn

describeReplicationTasks_marker :: Lens' DescribeReplicationTasks (Maybe Text)

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)

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.

describeReplicationTasks_withoutSettings :: Lens' DescribeReplicationTasks (Maybe Bool)

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).

Destructuring the Response

data DescribeReplicationTasksResponse

See: newDescribeReplicationTasksResponse smart constructor.

Constructors

DescribeReplicationTasksResponse'

Fields

• marker :: Maybe Text

  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.

• replicationTasks :: Maybe [ReplicationTask]

  A description of the replication tasks.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

Associated Types

type Rep DescribeReplicationTasksResponse :: Type -> Type

Methods

from :: DescribeReplicationTasksResponse -> Rep DescribeReplicationTasksResponse x

to :: Rep DescribeReplicationTasksResponse x -> DescribeReplicationTasksResponse

Read DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

readsPrec :: Int -> ReadS DescribeReplicationTasksResponse

readList :: ReadS [DescribeReplicationTasksResponse]

readPrec :: ReadPrec DescribeReplicationTasksResponse

readListPrec :: ReadPrec [DescribeReplicationTasksResponse]

Show DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

showsPrec :: Int -> DescribeReplicationTasksResponse -> ShowS

show :: DescribeReplicationTasksResponse -> String

showList :: [DescribeReplicationTasksResponse] -> ShowS

NFData DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

rnf :: DescribeReplicationTasksResponse -> ()

Eq DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

Methods

(==) :: DescribeReplicationTasksResponse -> DescribeReplicationTasksResponse -> Bool

(/=) :: DescribeReplicationTasksResponse -> DescribeReplicationTasksResponse -> Bool

type Rep DescribeReplicationTasksResponse

Defined in Amazonka.DMS.DescribeReplicationTasks

type Rep DescribeReplicationTasksResponse = D1 ('MetaData "DescribeReplicationTasksResponse" "Amazonka.DMS.DescribeReplicationTasks" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeReplicationTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "replicationTasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReplicationTask])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReplicationTasksResponse

Arguments

:: Int

$sel:httpStatus:DescribeReplicationTasksResponse'

-> DescribeReplicationTasksResponse

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:

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:replicationTasks:DescribeReplicationTasksResponse', describeReplicationTasksResponse_replicationTasks - A description of the replication tasks.

$sel:httpStatus:DescribeReplicationTasksResponse', describeReplicationTasksResponse_httpStatus - The response's http status code.

Response Lenses

describeReplicationTasksResponse_marker :: Lens' DescribeReplicationTasksResponse (Maybe Text)

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_replicationTasks :: Lens' DescribeReplicationTasksResponse (Maybe [ReplicationTask])

A description of the replication tasks.

describeReplicationTasksResponse_httpStatus :: Lens' DescribeReplicationTasksResponse Int

The response's http status code.