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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about the endpoints for your account in the current region.

This operation returns paginated results.

Creating a Request

data DescribeEndpoints Source #

See: newDescribeEndpoints smart constructor.

Constructors

DescribeEndpoints'

Fields

filters :: Maybe [Filter]
Filters applied to the endpoints.
Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name
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 DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods (==) :: DescribeEndpoints -> DescribeEndpoints -> Bool # (/=) :: DescribeEndpoints -> DescribeEndpoints -> Bool #
Read DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods readsPrec :: Int -> ReadS DescribeEndpoints # readList :: ReadS [DescribeEndpoints] # readPrec :: ReadPrec DescribeEndpoints # readListPrec :: ReadPrec [DescribeEndpoints] #
Show DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods showsPrec :: Int -> DescribeEndpoints -> ShowS # show :: DescribeEndpoints -> String # showList :: [DescribeEndpoints] -> ShowS #
Generic DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Associated Types type Rep DescribeEndpoints :: Type -> Type # Methods from :: DescribeEndpoints -> Rep DescribeEndpoints x # to :: Rep DescribeEndpoints x -> DescribeEndpoints #
NFData DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods rnf :: DescribeEndpoints -> () #
Hashable DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods hashWithSalt :: Int -> DescribeEndpoints -> Int # hash :: DescribeEndpoints -> Int #
ToJSON DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods toJSON :: DescribeEndpoints -> Value # toEncoding :: DescribeEndpoints -> Encoding # toJSONList :: [DescribeEndpoints] -> Value # toEncodingList :: [DescribeEndpoints] -> Encoding #
AWSPager DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods page :: DescribeEndpoints -> AWSResponse DescribeEndpoints -> Maybe DescribeEndpoints #
AWSRequest DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Associated Types type AWSResponse DescribeEndpoints # Methods request :: DescribeEndpoints -> Request DescribeEndpoints # response :: MonadResource m => Logger -> Service -> Proxy DescribeEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeEndpoints))) #
ToHeaders DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods toHeaders :: DescribeEndpoints -> [Header] #
ToPath DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods toPath :: DescribeEndpoints -> ByteString #
ToQuery DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods toQuery :: DescribeEndpoints -> QueryString #
type Rep DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints type Rep DescribeEndpoints = D1 ('MetaData "DescribeEndpoints" "Amazonka.DMS.DescribeEndpoints" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeEndpoints'" '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 DescribeEndpoints Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints type AWSResponse DescribeEndpoints = DescribeEndpointsResponse

newDescribeEndpoints :: DescribeEndpoints Source #

Create a value of DescribeEndpoints 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:DescribeEndpoints', describeEndpoints_filters - Filters applied to the endpoints.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

$sel:marker:DescribeEndpoints', describeEndpoints_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:DescribeEndpoints', describeEndpoints_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

describeEndpoints_filters :: Lens' DescribeEndpoints (Maybe [Filter]) Source #

Filters applied to the endpoints.

Valid filter names: endpoint-arn | endpoint-type | endpoint-id | engine-name

describeEndpoints_marker :: Lens' DescribeEndpoints (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.

describeEndpoints_maxRecords :: Lens' DescribeEndpoints (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 DescribeEndpointsResponse Source #

See: newDescribeEndpointsResponse smart constructor.

Constructors

DescribeEndpointsResponse'
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`. endpoints :: Maybe [Endpoint] Endpoint description. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods (==) :: DescribeEndpointsResponse -> DescribeEndpointsResponse -> Bool # (/=) :: DescribeEndpointsResponse -> DescribeEndpointsResponse -> Bool #
Show DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods showsPrec :: Int -> DescribeEndpointsResponse -> ShowS # show :: DescribeEndpointsResponse -> String # showList :: [DescribeEndpointsResponse] -> ShowS #
Generic DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Associated Types type Rep DescribeEndpointsResponse :: Type -> Type # Methods from :: DescribeEndpointsResponse -> Rep DescribeEndpointsResponse x # to :: Rep DescribeEndpointsResponse x -> DescribeEndpointsResponse #
NFData DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints Methods rnf :: DescribeEndpointsResponse -> () #
type Rep DescribeEndpointsResponse Source #
Instance details Defined in Amazonka.DMS.DescribeEndpoints type Rep DescribeEndpointsResponse = D1 ('MetaData "DescribeEndpointsResponse" "Amazonka.DMS.DescribeEndpoints" "libZSservicesZSamazonka-dmsZSamazonka-dms" 'False) (C1 ('MetaCons "DescribeEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "endpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Endpoint])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeEndpointsResponse Source #

Arguments

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

Create a value of DescribeEndpointsResponse 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:marker:DescribeEndpoints', describeEndpointsResponse_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:endpoints:DescribeEndpointsResponse', describeEndpointsResponse_endpoints - Endpoint description.

$sel:httpStatus:DescribeEndpointsResponse', describeEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointsResponse_marker :: Lens' DescribeEndpointsResponse (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.

describeEndpointsResponse_endpoints :: Lens' DescribeEndpointsResponse (Maybe [Endpoint]) Source #

Endpoint description.

describeEndpointsResponse_httpStatus :: Lens' DescribeEndpointsResponse Int Source #

The response's http status code.