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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of certificate authority (CA) certificates provided by Amazon DocumentDB for this account.

This operation returns paginated results.

Synopsis

data DescribeCertificates = DescribeCertificates' {
- filters :: Maybe [Filter]
- certificateIdentifier :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeCertificates :: DescribeCertificates
describeCertificates_filters :: Lens' DescribeCertificates (Maybe [Filter])
describeCertificates_certificateIdentifier :: Lens' DescribeCertificates (Maybe Text)
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]
This parameter is not currently supported.
certificateIdentifier :: Maybe Text
The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.
Constraints
- Must match an existing CertificateIdentifier.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeCertificates 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 DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods (==) :: DescribeCertificates -> DescribeCertificates -> Bool # (/=) :: DescribeCertificates -> DescribeCertificates -> Bool #
Read DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods readsPrec :: Int -> ReadS DescribeCertificates # readList :: ReadS [DescribeCertificates] # readPrec :: ReadPrec DescribeCertificates # readListPrec :: ReadPrec [DescribeCertificates] #
Show DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods showsPrec :: Int -> DescribeCertificates -> ShowS # show :: DescribeCertificates -> String # showList :: [DescribeCertificates] -> ShowS #
Generic DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Associated Types type Rep DescribeCertificates :: Type -> Type # Methods from :: DescribeCertificates -> Rep DescribeCertificates x # to :: Rep DescribeCertificates x -> DescribeCertificates #
NFData DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods rnf :: DescribeCertificates -> () #
Hashable DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods hashWithSalt :: Int -> DescribeCertificates -> Int # hash :: DescribeCertificates -> Int #
AWSPager DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods page :: DescribeCertificates -> AWSResponse DescribeCertificates -> Maybe DescribeCertificates #
AWSRequest DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Associated Types type AWSResponse DescribeCertificates # Methods request :: DescribeCertificates -> Request DescribeCertificates # response :: MonadResource m => Logger -> Service -> Proxy DescribeCertificates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCertificates))) #
ToHeaders DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods toHeaders :: DescribeCertificates -> [Header] #
ToPath DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods toPath :: DescribeCertificates -> ByteString #
ToQuery DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods toQuery :: DescribeCertificates -> QueryString #
type Rep DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates type Rep DescribeCertificates = D1 ('MetaData "DescribeCertificates" "Amazonka.DocumentDB.DescribeCertificates" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeCertificates'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "certificateIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeCertificates Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates type AWSResponse DescribeCertificates = DescribeCertificatesResponse

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 - This parameter is not currently supported.

$sel:certificateIdentifier:DescribeCertificates', describeCertificates_certificateIdentifier - The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

Must match an existing CertificateIdentifier.

$sel:marker:DescribeCertificates', describeCertificates_marker - An optional pagination token provided by a previous DescribeCertificates 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: 100

Constraints:

Minimum: 20
Maximum: 100

Request Lenses

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

This parameter is not currently supported.

describeCertificates_certificateIdentifier :: Lens' DescribeCertificates (Maybe Text) Source #

The user-supplied certificate identifier. If this parameter is specified, information for only the specified certificate is returned. If this parameter is omitted, a list of up to MaxRecords certificates is returned. This parameter is not case sensitive.

Constraints

Must match an existing CertificateIdentifier.

describeCertificates_marker :: Lens' DescribeCertificates (Maybe Text) Source #

An optional pagination token provided by a previous DescribeCertificates 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: 100

Constraints:

Minimum: 20
Maximum: 100

Destructuring the Response

data DescribeCertificatesResponse Source #

See: newDescribeCertificatesResponse smart constructor.

Constructors

DescribeCertificatesResponse'

Fields

certificates :: Maybe [Certificate]
A list of certificates for this account.
marker :: Maybe Text
An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods (==) :: DescribeCertificatesResponse -> DescribeCertificatesResponse -> Bool # (/=) :: DescribeCertificatesResponse -> DescribeCertificatesResponse -> Bool #
Read DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods readsPrec :: Int -> ReadS DescribeCertificatesResponse # readList :: ReadS [DescribeCertificatesResponse] # readPrec :: ReadPrec DescribeCertificatesResponse # readListPrec :: ReadPrec [DescribeCertificatesResponse] #
Show DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods showsPrec :: Int -> DescribeCertificatesResponse -> ShowS # show :: DescribeCertificatesResponse -> String # showList :: [DescribeCertificatesResponse] -> ShowS #
Generic DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Associated Types type Rep DescribeCertificatesResponse :: Type -> Type # Methods from :: DescribeCertificatesResponse -> Rep DescribeCertificatesResponse x # to :: Rep DescribeCertificatesResponse x -> DescribeCertificatesResponse #
NFData DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates Methods rnf :: DescribeCertificatesResponse -> () #
type Rep DescribeCertificatesResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeCertificates type Rep DescribeCertificatesResponse = D1 ('MetaData "DescribeCertificatesResponse" "Amazonka.DocumentDB.DescribeCertificates" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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 - A list of certificates for this account.

$sel:marker:DescribeCertificates', describeCertificatesResponse_marker - An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

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

Response Lenses

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

A list of certificates for this account.

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

An optional pagination token provided if the number of records retrieved is greater than MaxRecords. If this parameter is specified, the marker specifies the next record in the list. Including the value of Marker in the next call to DescribeCertificates results in the next page of certificates.

describeCertificatesResponse_httpStatus :: Lens' DescribeCertificatesResponse Int Source #

The response's http status code.