Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DMS.DescribeConnections

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

ToJSON DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods toJSON :: DescribeConnections -> Value # toEncoding :: DescribeConnections -> Encoding # toJSONList :: [DescribeConnections] -> Value # toEncodingList :: [DescribeConnections] -> Encoding #
ToHeaders DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods toHeaders :: DescribeConnections -> [Header] #
ToPath DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods toPath :: DescribeConnections -> ByteString #
ToQuery DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods toQuery :: DescribeConnections -> QueryString #
AWSPager DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods page :: DescribeConnections -> AWSResponse DescribeConnections -> Maybe DescribeConnections #
AWSRequest DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Associated Types type AWSResponse DescribeConnections # Methods request :: (Service -> Service) -> DescribeConnections -> Request DescribeConnections # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeConnections -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeConnections))) #
Generic DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Associated Types type Rep DescribeConnections :: Type -> Type # Methods from :: DescribeConnections -> Rep DescribeConnections x # to :: Rep DescribeConnections x -> DescribeConnections #
Read DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods readsPrec :: Int -> ReadS DescribeConnections # readList :: ReadS [DescribeConnections] # readPrec :: ReadPrec DescribeConnections # readListPrec :: ReadPrec [DescribeConnections] #
Show DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods showsPrec :: Int -> DescribeConnections -> ShowS # show :: DescribeConnections -> String # showList :: [DescribeConnections] -> ShowS #
NFData DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods rnf :: DescribeConnections -> () #
Eq DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods (==) :: DescribeConnections -> DescribeConnections -> Bool # (/=) :: DescribeConnections -> DescribeConnections -> Bool #
Hashable DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods hashWithSalt :: Int -> DescribeConnections -> Int # hash :: DescribeConnections -> Int #
type AWSResponse DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections type AWSResponse DescribeConnections = DescribeConnectionsResponse
type Rep DescribeConnections Source #
Instance details Defined in Amazonka.DMS.DescribeConnections type Rep DescribeConnections = D1 ('MetaData "DescribeConnections" "Amazonka.DMS.DescribeConnections" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" '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)))))

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

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

Generic DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Associated Types type Rep DescribeConnectionsResponse :: Type -> Type # Methods from :: DescribeConnectionsResponse -> Rep DescribeConnectionsResponse x # to :: Rep DescribeConnectionsResponse x -> DescribeConnectionsResponse #
Read DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods readsPrec :: Int -> ReadS DescribeConnectionsResponse # readList :: ReadS [DescribeConnectionsResponse] # readPrec :: ReadPrec DescribeConnectionsResponse # readListPrec :: ReadPrec [DescribeConnectionsResponse] #
Show DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods showsPrec :: Int -> DescribeConnectionsResponse -> ShowS # show :: DescribeConnectionsResponse -> String # showList :: [DescribeConnectionsResponse] -> ShowS #
NFData DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods rnf :: DescribeConnectionsResponse -> () #
Eq DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections Methods (==) :: DescribeConnectionsResponse -> DescribeConnectionsResponse -> Bool # (/=) :: DescribeConnectionsResponse -> DescribeConnectionsResponse -> Bool #
type Rep DescribeConnectionsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeConnections type Rep DescribeConnectionsResponse = D1 ('MetaData "DescribeConnectionsResponse" "Amazonka.DMS.DescribeConnections" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" '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 #

Arguments

:: Int	`$sel:httpStatus:DescribeConnectionsResponse'`
-> DescribeConnectionsResponse

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.

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_connections :: Lens' DescribeConnectionsResponse (Maybe [Connection]) Source #

A description of the connections.

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.

describeConnectionsResponse_httpStatus :: Lens' DescribeConnectionsResponse Int Source #

The response's http status code.