libZSservicesZSamazonka-dmsZSamazonka-dms
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.DMS.DescribeConnections

Description

Describes the status of the connections that have been made between the replication instance and an endpoint. Connections are created when you test an endpoint.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeConnections Source #

See: newDescribeConnections smart constructor.

Constructors

DescribeConnections' 

Fields

  • filters :: Maybe [Filter]

    The filters applied to the connection.

    Valid filter names: 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.

Instances

Instances details
Eq DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Read DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Show DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Generic DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Associated Types

type Rep DescribeConnections :: Type -> Type #

NFData DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Methods

rnf :: DescribeConnections -> () #

Hashable DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

ToJSON DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

AWSPager DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

AWSRequest DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Associated Types

type AWSResponse DescribeConnections #

ToHeaders DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

ToPath DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

ToQuery DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

type Rep DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

type Rep DescribeConnections = D1 ('MetaData "DescribeConnections" "Amazonka.DMS.DescribeConnections" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeConnections'" '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)))))
type AWSResponse DescribeConnections Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

newDescribeConnections :: DescribeConnections Source #

Create a value of DescribeConnections 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:DescribeConnections', describeConnections_filters - The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn

$sel:marker:DescribeConnections', describeConnections_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:DescribeConnections', describeConnections_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

describeConnections_filters :: Lens' DescribeConnections (Maybe [Filter]) Source #

The filters applied to the connection.

Valid filter names: endpoint-arn | replication-instance-arn

describeConnections_marker :: Lens' DescribeConnections (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.

describeConnections_maxRecords :: Lens' DescribeConnections (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 DescribeConnectionsResponse Source #

See: newDescribeConnectionsResponse smart constructor.

Constructors

DescribeConnectionsResponse' 

Fields

  • connections :: Maybe [Connection]

    A description of the connections.

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Read DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Show DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Generic DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

Associated Types

type Rep DescribeConnectionsResponse :: Type -> Type #

NFData DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

type Rep DescribeConnectionsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeConnections

type Rep DescribeConnectionsResponse = D1 ('MetaData "DescribeConnectionsResponse" "Amazonka.DMS.DescribeConnections" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeConnectionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "connections") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Connection])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeConnectionsResponse Source #

Create a value of DescribeConnectionsResponse 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:connections:DescribeConnectionsResponse', describeConnectionsResponse_connections - A description of the connections.

$sel:marker:DescribeConnections', describeConnectionsResponse_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:DescribeConnectionsResponse', describeConnectionsResponse_httpStatus - The response's http status code.

Response Lenses

describeConnectionsResponse_marker :: Lens' DescribeConnectionsResponse (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.