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.IoT.ListCertificatesByCA

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

List the device certificates signed by the specified CA certificate.

Requires permission to access the ListCertificatesByCA action.

This operation returns paginated results.

Synopsis

data ListCertificatesByCA = ListCertificatesByCA' {
- marker :: Maybe Text
- ascendingOrder :: Maybe Bool
- pageSize :: Maybe Natural
- caCertificateId :: Text
}
newListCertificatesByCA :: Text -> ListCertificatesByCA
listCertificatesByCA_marker :: Lens' ListCertificatesByCA (Maybe Text)
listCertificatesByCA_ascendingOrder :: Lens' ListCertificatesByCA (Maybe Bool)
listCertificatesByCA_pageSize :: Lens' ListCertificatesByCA (Maybe Natural)
listCertificatesByCA_caCertificateId :: Lens' ListCertificatesByCA Text
data ListCertificatesByCAResponse = ListCertificatesByCAResponse' {
- certificates :: Maybe [Certificate]
- nextMarker :: Maybe Text
- httpStatus :: Int
}
newListCertificatesByCAResponse :: Int -> ListCertificatesByCAResponse
listCertificatesByCAResponse_certificates :: Lens' ListCertificatesByCAResponse (Maybe [Certificate])
listCertificatesByCAResponse_nextMarker :: Lens' ListCertificatesByCAResponse (Maybe Text)
listCertificatesByCAResponse_httpStatus :: Lens' ListCertificatesByCAResponse Int

Creating a Request

data ListCertificatesByCA Source #

The input to the ListCertificatesByCA operation.

See: newListCertificatesByCA smart constructor.

Constructors

ListCertificatesByCA'

Fields

marker :: Maybe Text
The marker for the next set of results.
ascendingOrder :: Maybe Bool
Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.
pageSize :: Maybe Natural
The result page size.
caCertificateId :: Text
The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

Instances

Instances details

Eq ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods (==) :: ListCertificatesByCA -> ListCertificatesByCA -> Bool # (/=) :: ListCertificatesByCA -> ListCertificatesByCA -> Bool #
Read ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods readsPrec :: Int -> ReadS ListCertificatesByCA # readList :: ReadS [ListCertificatesByCA] # readPrec :: ReadPrec ListCertificatesByCA # readListPrec :: ReadPrec [ListCertificatesByCA] #
Show ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods showsPrec :: Int -> ListCertificatesByCA -> ShowS # show :: ListCertificatesByCA -> String # showList :: [ListCertificatesByCA] -> ShowS #
Generic ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Associated Types type Rep ListCertificatesByCA :: Type -> Type # Methods from :: ListCertificatesByCA -> Rep ListCertificatesByCA x # to :: Rep ListCertificatesByCA x -> ListCertificatesByCA #
NFData ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods rnf :: ListCertificatesByCA -> () #
Hashable ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods hashWithSalt :: Int -> ListCertificatesByCA -> Int # hash :: ListCertificatesByCA -> Int #
AWSPager ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods page :: ListCertificatesByCA -> AWSResponse ListCertificatesByCA -> Maybe ListCertificatesByCA #
AWSRequest ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Associated Types type AWSResponse ListCertificatesByCA # Methods request :: ListCertificatesByCA -> Request ListCertificatesByCA # response :: MonadResource m => Logger -> Service -> Proxy ListCertificatesByCA -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCertificatesByCA))) #
ToHeaders ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods toHeaders :: ListCertificatesByCA -> [Header] #
ToPath ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods toPath :: ListCertificatesByCA -> ByteString #
ToQuery ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA Methods toQuery :: ListCertificatesByCA -> QueryString #
type Rep ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA type Rep ListCertificatesByCA = D1 ('MetaData "ListCertificatesByCA" "Amazonka.IoT.ListCertificatesByCA" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListCertificatesByCA'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "ascendingOrder") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "pageSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "caCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse ListCertificatesByCA Source #
Instance details Defined in Amazonka.IoT.ListCertificatesByCA type AWSResponse ListCertificatesByCA = ListCertificatesByCAResponse

newListCertificatesByCA Source #

Arguments

:: Text	`$sel:caCertificateId:ListCertificatesByCA'`
-> ListCertificatesByCA

Create a value of ListCertificatesByCA 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:ListCertificatesByCA', listCertificatesByCA_marker - The marker for the next set of results.

$sel:ascendingOrder:ListCertificatesByCA', listCertificatesByCA_ascendingOrder - Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

$sel:pageSize:ListCertificatesByCA', listCertificatesByCA_pageSize - The result page size.

$sel:caCertificateId:ListCertificatesByCA', listCertificatesByCA_caCertificateId - The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

Request Lenses

listCertificatesByCA_marker :: Lens' ListCertificatesByCA (Maybe Text) Source #

The marker for the next set of results.

listCertificatesByCA_ascendingOrder :: Lens' ListCertificatesByCA (Maybe Bool) Source #

Specifies the order for results. If True, the results are returned in ascending order, based on the creation date.

listCertificatesByCA_pageSize :: Lens' ListCertificatesByCA (Maybe Natural) Source #

The result page size.

listCertificatesByCA_caCertificateId :: Lens' ListCertificatesByCA Text Source #

The ID of the CA certificate. This operation will list all registered device certificate that were signed by this CA certificate.

Destructuring the Response

data ListCertificatesByCAResponse Source #

The output of the ListCertificatesByCA operation.

See: newListCertificatesByCAResponse smart constructor.

Constructors

ListCertificatesByCAResponse'
Fields certificates :: Maybe [Certificate] The device certificates signed by the specified CA certificate. nextMarker :: Maybe Text The marker for the next set of results, or null if there are no additional results. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListCertificatesByCAResponse Source #

Arguments

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

Create a value of ListCertificatesByCAResponse 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:ListCertificatesByCAResponse', listCertificatesByCAResponse_certificates - The device certificates signed by the specified CA certificate.

$sel:nextMarker:ListCertificatesByCAResponse', listCertificatesByCAResponse_nextMarker - The marker for the next set of results, or null if there are no additional results.

$sel:httpStatus:ListCertificatesByCAResponse', listCertificatesByCAResponse_httpStatus - The response's http status code.

Response Lenses

listCertificatesByCAResponse_certificates :: Lens' ListCertificatesByCAResponse (Maybe [Certificate]) Source #

The device certificates signed by the specified CA certificate.

listCertificatesByCAResponse_nextMarker :: Lens' ListCertificatesByCAResponse (Maybe Text) Source #

The marker for the next set of results, or null if there are no additional results.

listCertificatesByCAResponse_httpStatus :: Lens' ListCertificatesByCAResponse Int Source #

The response's http status code.