libZSservicesZSamazonka-lightsailZSamazonka-lightsail
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Lightsail.GetCertificates

Description

Returns information about one or more Amazon Lightsail SSL/TLS certificates.

To get a summary of a certificate, ommit includeCertificateDetails from your request. The response will include only the certificate Amazon Resource Name (ARN), certificate name, domain name, and tags.

Synopsis

Creating a Request

data GetCertificates Source #

See: newGetCertificates smart constructor.

Constructors

GetCertificates' 

Fields

  • certificateStatuses :: Maybe [CertificateStatus]

    The status of the certificates for which to return information.

    For example, specify ISSUED to return only certificates with an ISSUED status.

    When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.

  • certificateName :: Maybe Text

    The name for the certificate for which to return information.

    When omitted, the response includes all of your certificates in the AWS Region where the request is made.

  • includeCertificateDetails :: Maybe Bool

    Indicates whether to include detailed information about the certificates in the response.

    When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Instances

Instances details
Eq GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

(==) :: GetCertificates -> GetCertificates -> Bool #

(/=) :: GetCertificates -> GetCertificates -> Bool #

Read GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

readsPrec :: Int -> ReadS GetCertificates #

readList :: ReadS [GetCertificates] #

readPrec :: ReadPrec GetCertificates #

readListPrec :: ReadPrec [GetCertificates] #

Show GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

showsPrec :: Int -> GetCertificates -> ShowS #

show :: GetCertificates -> String #

showList :: [GetCertificates] -> ShowS #

Generic GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Associated Types

type Rep GetCertificates :: Type -> Type #

Methods

from :: GetCertificates -> Rep GetCertificates x #

to :: Rep GetCertificates x -> GetCertificates #

NFData GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

rnf :: GetCertificates -> () #

Hashable GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

hashWithSalt :: Int -> GetCertificates -> Int #

hash :: GetCertificates -> Int #

ToJSON GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

toJSON :: GetCertificates -> Value #

toEncoding :: GetCertificates -> Encoding #

toJSONList :: [GetCertificates] -> Value #

toEncodingList :: [GetCertificates] -> Encoding #

AWSRequest GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Associated Types

type AWSResponse GetCertificates #

Methods

request :: GetCertificates -> Request GetCertificates #

response :: MonadResource m => Logger -> Service -> Proxy GetCertificates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetCertificates))) #

ToHeaders GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

toHeaders :: GetCertificates -> [Header] #

ToPath GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

toPath :: GetCertificates -> ByteString #

ToQuery GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

toQuery :: GetCertificates -> QueryString #

type Rep GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

type Rep GetCertificates = D1 ('MetaData "GetCertificates" "Amazonka.Lightsail.GetCertificates" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetCertificates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateStatuses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CertificateStatus])) :*: (S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "includeCertificateDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))
type AWSResponse GetCertificates Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

type AWSResponse GetCertificates = GetCertificatesResponse

newGetCertificates :: GetCertificates Source #

Create a value of GetCertificates 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:certificateStatuses:GetCertificates', getCertificates_certificateStatuses - The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.

$sel:certificateName:GetCertificates', getCertificates_certificateName - The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the AWS Region where the request is made.

$sel:includeCertificateDetails:GetCertificates', getCertificates_includeCertificateDetails - Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Request Lenses

getCertificates_certificateStatuses :: Lens' GetCertificates (Maybe [CertificateStatus]) Source #

The status of the certificates for which to return information.

For example, specify ISSUED to return only certificates with an ISSUED status.

When omitted, the response includes all of your certificates in the AWS Region where the request is made, regardless of their current status.

getCertificates_certificateName :: Lens' GetCertificates (Maybe Text) Source #

The name for the certificate for which to return information.

When omitted, the response includes all of your certificates in the AWS Region where the request is made.

getCertificates_includeCertificateDetails :: Lens' GetCertificates (Maybe Bool) Source #

Indicates whether to include detailed information about the certificates in the response.

When omitted, the response includes only the certificate names, Amazon Resource Names (ARNs), domain names, and tags.

Destructuring the Response

data GetCertificatesResponse Source #

See: newGetCertificatesResponse smart constructor.

Constructors

GetCertificatesResponse' 

Fields

Instances

Instances details
Eq GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

(==) :: GetCertificatesResponse -> GetCertificatesResponse -> Bool #

(/=) :: GetCertificatesResponse -> GetCertificatesResponse -> Bool #

Read GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

readsPrec :: Int -> ReadS GetCertificatesResponse #

readList :: ReadS [GetCertificatesResponse] #

readPrec :: ReadPrec GetCertificatesResponse #

readListPrec :: ReadPrec [GetCertificatesResponse] #

Show GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

showsPrec :: Int -> GetCertificatesResponse -> ShowS #

show :: GetCertificatesResponse -> String #

showList :: [GetCertificatesResponse] -> ShowS #

Generic GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Associated Types

type Rep GetCertificatesResponse :: Type -> Type #

Methods

from :: GetCertificatesResponse -> Rep GetCertificatesResponse x #

to :: Rep GetCertificatesResponse x -> GetCertificatesResponse #

NFData GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

Methods

rnf :: GetCertificatesResponse -> () #

type Rep GetCertificatesResponse Source # 
Instance details

Defined in Amazonka.Lightsail.GetCertificates

type Rep GetCertificatesResponse = D1 ('MetaData "GetCertificatesResponse" "Amazonka.Lightsail.GetCertificates" "libZSservicesZSamazonka-lightsailZSamazonka-lightsail" 'False) (C1 ('MetaCons "GetCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CertificateSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetCertificatesResponse Source #

Arguments

:: Int

$sel:httpStatus:GetCertificatesResponse'

-> GetCertificatesResponse 

Create a value of GetCertificatesResponse 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:GetCertificatesResponse', getCertificatesResponse_certificates - An object that describes certificates.

$sel:httpStatus:GetCertificatesResponse', getCertificatesResponse_httpStatus - The response's http status code.

Response Lenses

getCertificatesResponse_certificates :: Lens' GetCertificatesResponse (Maybe [CertificateSummary]) Source #

An object that describes certificates.

getCertificatesResponse_httpStatus :: Lens' GetCertificatesResponse Int Source #

The response's http status code.