Amazonka.DMS.DescribeEndpointSettings

Returns information about the possible endpoint settings available when you create an endpoint for a specific database engine.

Creating a Request

data DescribeEndpointSettings

See: newDescribeEndpointSettings smart constructor.

Constructors

DescribeEndpointSettings'

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.

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

• engineName :: Text

  The databse engine used for your source or target endpoint.

Instances

ToJSON DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

toJSON :: DescribeEndpointSettings -> Value

toEncoding :: DescribeEndpointSettings -> Encoding

toJSONList :: [DescribeEndpointSettings] -> Value

toEncodingList :: [DescribeEndpointSettings] -> Encoding

ToHeaders DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

toHeaders :: DescribeEndpointSettings -> [Header]

ToPath DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

toPath :: DescribeEndpointSettings -> ByteString

ToQuery DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

toQuery :: DescribeEndpointSettings -> QueryString

AWSRequest DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Associated Types

type AWSResponse DescribeEndpointSettings

Methods

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

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

Generic DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Associated Types

type Rep DescribeEndpointSettings :: Type -> Type

Methods

from :: DescribeEndpointSettings -> Rep DescribeEndpointSettings x

to :: Rep DescribeEndpointSettings x -> DescribeEndpointSettings

Read DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

readsPrec :: Int -> ReadS DescribeEndpointSettings

readList :: ReadS [DescribeEndpointSettings]

readPrec :: ReadPrec DescribeEndpointSettings

readListPrec :: ReadPrec [DescribeEndpointSettings]

Show DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

showsPrec :: Int -> DescribeEndpointSettings -> ShowS

show :: DescribeEndpointSettings -> String

showList :: [DescribeEndpointSettings] -> ShowS

NFData DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

rnf :: DescribeEndpointSettings -> ()

Eq DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

(==) :: DescribeEndpointSettings -> DescribeEndpointSettings -> Bool

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

Hashable DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

hashWithSalt :: Int -> DescribeEndpointSettings -> Int

hash :: DescribeEndpointSettings -> Int

type AWSResponse DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

type AWSResponse DescribeEndpointSettings = DescribeEndpointSettingsResponse

type Rep DescribeEndpointSettings

Defined in Amazonka.DMS.DescribeEndpointSettings

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

newDescribeEndpointSettings

Arguments

:: Text

DescribeEndpointSettings

-> DescribeEndpointSettings

Create a value of DescribeEndpointSettings 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:

DescribeEndpointSettings, describeEndpointSettings_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:DescribeEndpointSettings', describeEndpointSettings_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.

DescribeEndpointSettings, describeEndpointSettings_engineName - The databse engine used for your source or target endpoint.

Request Lenses

describeEndpointSettings_marker :: Lens' DescribeEndpointSettings (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.

describeEndpointSettings_maxRecords :: Lens' DescribeEndpointSettings (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.

describeEndpointSettings_engineName :: Lens' DescribeEndpointSettings Text

The databse engine used for your source or target endpoint.

Destructuring the Response

data DescribeEndpointSettingsResponse

See: newDescribeEndpointSettingsResponse smart constructor.

Constructors

DescribeEndpointSettingsResponse'

Fields

• endpointSettings :: Maybe [EndpointSetting]

  Descriptions of the endpoint settings available for your source or target database engine.

• 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

Generic DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

Associated Types

type Rep DescribeEndpointSettingsResponse :: Type -> Type

Methods

from :: DescribeEndpointSettingsResponse -> Rep DescribeEndpointSettingsResponse x

to :: Rep DescribeEndpointSettingsResponse x -> DescribeEndpointSettingsResponse

Read DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

readsPrec :: Int -> ReadS DescribeEndpointSettingsResponse

readList :: ReadS [DescribeEndpointSettingsResponse]

readPrec :: ReadPrec DescribeEndpointSettingsResponse

readListPrec :: ReadPrec [DescribeEndpointSettingsResponse]

Show DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

showsPrec :: Int -> DescribeEndpointSettingsResponse -> ShowS

show :: DescribeEndpointSettingsResponse -> String

showList :: [DescribeEndpointSettingsResponse] -> ShowS

NFData DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

rnf :: DescribeEndpointSettingsResponse -> ()

Eq DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

Methods

(==) :: DescribeEndpointSettingsResponse -> DescribeEndpointSettingsResponse -> Bool

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

type Rep DescribeEndpointSettingsResponse

Defined in Amazonka.DMS.DescribeEndpointSettings

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

newDescribeEndpointSettingsResponse

Arguments

:: Int

$sel:httpStatus:DescribeEndpointSettingsResponse'

-> DescribeEndpointSettingsResponse

Create a value of DescribeEndpointSettingsResponse 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:endpointSettings:DescribeEndpointSettingsResponse', describeEndpointSettingsResponse_endpointSettings - Descriptions of the endpoint settings available for your source or target database engine.

DescribeEndpointSettings, describeEndpointSettingsResponse_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:DescribeEndpointSettingsResponse', describeEndpointSettingsResponse_httpStatus - The response's http status code.

Response Lenses

describeEndpointSettingsResponse_endpointSettings :: Lens' DescribeEndpointSettingsResponse (Maybe [EndpointSetting])

Descriptions of the endpoint settings available for your source or target database engine.

describeEndpointSettingsResponse_marker :: Lens' DescribeEndpointSettingsResponse (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.

describeEndpointSettingsResponse_httpStatus :: Lens' DescribeEndpointSettingsResponse Int

The response's http status code.