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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Provides a description of the certificate.

This operation returns paginated results.

Synopsis

data DescribeCertificates = DescribeCertificates' {
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeCertificates :: DescribeCertificates
describeCertificates_filters :: Lens' DescribeCertificates (Maybe [Filter])
describeCertificates_marker :: Lens' DescribeCertificates (Maybe Text)
describeCertificates_maxRecords :: Lens' DescribeCertificates (Maybe Int)
data DescribeCertificatesResponse = DescribeCertificatesResponse' {
- certificates :: Maybe [Certificate]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeCertificatesResponse :: Int -> DescribeCertificatesResponse
describeCertificatesResponse_certificates :: Lens' DescribeCertificatesResponse (Maybe [Certificate])
describeCertificatesResponse_marker :: Lens' DescribeCertificatesResponse (Maybe Text)
describeCertificatesResponse_httpStatus :: Lens' DescribeCertificatesResponse Int

Creating a Request

data DescribeCertificates Source #

See: newDescribeCertificates smart constructor.

Constructors

DescribeCertificates'

Fields

filters :: Maybe [Filter]
Filters applied to the certificates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.
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: 10

Instances

Instances details

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

newDescribeCertificates :: DescribeCertificates Source #

Create a value of DescribeCertificates 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:DescribeCertificates', describeCertificates_filters - Filters applied to the certificates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.

DescribeCertificates, describeCertificates_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:DescribeCertificates', describeCertificates_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: 10

Request Lenses

describeCertificates_filters :: Lens' DescribeCertificates (Maybe [Filter]) Source #

Filters applied to the certificates described in the form of key-value pairs. Valid values are certificate-arn and certificate-id.

describeCertificates_marker :: Lens' DescribeCertificates (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.

describeCertificates_maxRecords :: Lens' DescribeCertificates (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: 10

Destructuring the Response

data DescribeCertificatesResponse Source #

See: newDescribeCertificatesResponse smart constructor.

Constructors

DescribeCertificatesResponse'
Fields certificates :: Maybe [Certificate] The Secure Sockets Layer (SSL) certificates associated with the replication instance. marker :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates Associated Types type Rep DescribeCertificatesResponse :: Type -> Type # Methods from :: DescribeCertificatesResponse -> Rep DescribeCertificatesResponse x # to :: Rep DescribeCertificatesResponse x -> DescribeCertificatesResponse #
Read DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates Methods readsPrec :: Int -> ReadS DescribeCertificatesResponse # readList :: ReadS [DescribeCertificatesResponse] # readPrec :: ReadPrec DescribeCertificatesResponse # readListPrec :: ReadPrec [DescribeCertificatesResponse] #
Show DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates Methods showsPrec :: Int -> DescribeCertificatesResponse -> ShowS # show :: DescribeCertificatesResponse -> String # showList :: [DescribeCertificatesResponse] -> ShowS #
NFData DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates Methods rnf :: DescribeCertificatesResponse -> () #
Eq DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates Methods (==) :: DescribeCertificatesResponse -> DescribeCertificatesResponse -> Bool # (/=) :: DescribeCertificatesResponse -> DescribeCertificatesResponse -> Bool #
type Rep DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DMS.DescribeCertificates type Rep DescribeCertificatesResponse = D1 ('MetaData "DescribeCertificatesResponse" "Amazonka.DMS.DescribeCertificates" "amazonka-dms-2.0-LVCLJv4CY4nJuf0WXCDs3O" 'False) (C1 ('MetaCons "DescribeCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Certificate])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCertificatesResponse Source #

Arguments

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

Create a value of DescribeCertificatesResponse 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:certificates:DescribeCertificatesResponse', describeCertificatesResponse_certificates - The Secure Sockets Layer (SSL) certificates associated with the replication instance.

DescribeCertificates, describeCertificatesResponse_marker - The pagination token.

$sel:httpStatus:DescribeCertificatesResponse', describeCertificatesResponse_httpStatus - The response's http status code.

Response Lenses

describeCertificatesResponse_certificates :: Lens' DescribeCertificatesResponse (Maybe [Certificate]) Source #

The Secure Sockets Layer (SSL) certificates associated with the replication instance.

describeCertificatesResponse_marker :: Lens' DescribeCertificatesResponse (Maybe Text) Source #

The pagination token.

describeCertificatesResponse_httpStatus :: Lens' DescribeCertificatesResponse Int Source #

The response's http status code.