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

Description

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

This operation returns paginated results.

Synopsis

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

Read DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Show DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Generic DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Associated Types

type Rep DescribeEndpoints :: Type -> Type #

NFData DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Methods

rnf :: DescribeEndpoints -> () #

Hashable DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

ToJSON DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

AWSPager DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

AWSRequest DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Associated Types

type AWSResponse DescribeEndpoints #

ToHeaders DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

ToPath DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

ToQuery DescribeEndpoints Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

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

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

Show DescribeEndpointsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Generic DescribeEndpointsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

Associated Types

type Rep DescribeEndpointsResponse :: Type -> Type #

NFData DescribeEndpointsResponse Source # 
Instance details

Defined in Amazonka.DMS.DescribeEndpoints

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 #

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.