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.Transfer.ListCertificates

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of the current certificates that have been imported into Transfer Family. If you want to limit the results to a certain number, supply a value for the MaxResults parameter. If you ran the command previously and received a value for the NextToken parameter, you can supply that value to continue listing certificates from where you left off.

This operation returns paginated results.

Creating a Request

data ListCertificates Source #

See: newListCertificates smart constructor.

Constructors

ListCertificates'
Fields maxResults :: Maybe Natural The maximum number of certificates to return. nextToken :: Maybe Text When you can get additional results from the `ListCertificates` call, a `NextToken` parameter is returned in the output. You can then pass in a subsequent command to the `NextToken` parameter to continue listing additional certificates.

Instances

Instances details

ToJSON ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods toJSON :: ListCertificates -> Value # toEncoding :: ListCertificates -> Encoding # toJSONList :: [ListCertificates] -> Value # toEncodingList :: [ListCertificates] -> Encoding #
ToHeaders ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods toHeaders :: ListCertificates -> [Header] #
ToPath ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods toPath :: ListCertificates -> ByteString #
ToQuery ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods toQuery :: ListCertificates -> QueryString #
AWSPager ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods page :: ListCertificates -> AWSResponse ListCertificates -> Maybe ListCertificates #
AWSRequest ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Associated Types type AWSResponse ListCertificates # Methods request :: (Service -> Service) -> ListCertificates -> Request ListCertificates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListCertificates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListCertificates))) #
Generic ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Associated Types type Rep ListCertificates :: Type -> Type # Methods from :: ListCertificates -> Rep ListCertificates x # to :: Rep ListCertificates x -> ListCertificates #
Read ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods readsPrec :: Int -> ReadS ListCertificates # readList :: ReadS [ListCertificates] # readPrec :: ReadPrec ListCertificates # readListPrec :: ReadPrec [ListCertificates] #
Show ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods showsPrec :: Int -> ListCertificates -> ShowS # show :: ListCertificates -> String # showList :: [ListCertificates] -> ShowS #
NFData ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods rnf :: ListCertificates -> () #
Eq ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods (==) :: ListCertificates -> ListCertificates -> Bool # (/=) :: ListCertificates -> ListCertificates -> Bool #
Hashable ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates Methods hashWithSalt :: Int -> ListCertificates -> Int # hash :: ListCertificates -> Int #
type AWSResponse ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates type AWSResponse ListCertificates = ListCertificatesResponse
type Rep ListCertificates Source #
Instance details Defined in Amazonka.Transfer.ListCertificates type Rep ListCertificates = D1 ('MetaData "ListCertificates" "Amazonka.Transfer.ListCertificates" "amazonka-transfer-2.0-JiqKYJwOo427yDlzvkXGLY" 'False) (C1 ('MetaCons "ListCertificates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newListCertificates :: ListCertificates Source #

Create a value of ListCertificates 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:maxResults:ListCertificates', listCertificates_maxResults - The maximum number of certificates to return.

ListCertificates, listCertificates_nextToken - When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

Request Lenses

listCertificates_maxResults :: Lens' ListCertificates (Maybe Natural) Source #

The maximum number of certificates to return.

listCertificates_nextToken :: Lens' ListCertificates (Maybe Text) Source #

When you can get additional results from the ListCertificates call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional certificates.

Destructuring the Response

data ListCertificatesResponse Source #

See: newListCertificatesResponse smart constructor.

Constructors

ListCertificatesResponse'
Fields nextToken :: Maybe Text Returns the next token, which you can use to list the next certificate. httpStatus :: Int The response's http status code. certificates :: [ListedCertificate] Returns an array of the certificates that are specified in the `ListCertificates` call.

Instances

Instances details

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

newListCertificatesResponse Source #

Arguments

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

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

ListCertificates, listCertificatesResponse_nextToken - Returns the next token, which you can use to list the next certificate.

$sel:httpStatus:ListCertificatesResponse', listCertificatesResponse_httpStatus - The response's http status code.

$sel:certificates:ListCertificatesResponse', listCertificatesResponse_certificates - Returns an array of the certificates that are specified in the ListCertificates call.

Response Lenses

listCertificatesResponse_nextToken :: Lens' ListCertificatesResponse (Maybe Text) Source #

Returns the next token, which you can use to list the next certificate.

listCertificatesResponse_httpStatus :: Lens' ListCertificatesResponse Int Source #

The response's http status code.

listCertificatesResponse_certificates :: Lens' ListCertificatesResponse [ListedCertificate] Source #

Returns an array of the certificates that are specified in the ListCertificates call.