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.CertificateManagerPCA.DescribeCertificateAuthority

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists information about your private certificate authority (CA) or one that has been shared with you. You specify the private CA on input by its ARN (Amazon Resource Name). The output contains the status of your CA. This can be any of the following:

CREATING - ACM Private CA is creating your private certificate authority.
PENDING_CERTIFICATE - The certificate is pending. You must use your ACM Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into PCA.
ACTIVE - Your private CA is active.
DISABLED - Your private CA has been disabled.
EXPIRED - Your private CA certificate has expired.
FAILED - Your private CA has failed. Your CA can fail because of problems such a network outage or back-end AWS failure or other errors. A failed CA can never return to the pending state. You must create a new CA.
DELETED - Your private CA is within the restoration period, after which it is permanently deleted. The length of time remaining in the CA's restoration period is also included in this action's output.

Creating a Request

data DescribeCertificateAuthority Source #

See: newDescribeCertificateAuthority smart constructor.

Constructors

DescribeCertificateAuthority'
Fields certificateAuthorityArn :: Text The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form: `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` .

Instances

Instances details

Eq DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods (==) :: DescribeCertificateAuthority -> DescribeCertificateAuthority -> Bool # (/=) :: DescribeCertificateAuthority -> DescribeCertificateAuthority -> Bool #
Read DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods readsPrec :: Int -> ReadS DescribeCertificateAuthority # readList :: ReadS [DescribeCertificateAuthority] # readPrec :: ReadPrec DescribeCertificateAuthority # readListPrec :: ReadPrec [DescribeCertificateAuthority] #
Show DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods showsPrec :: Int -> DescribeCertificateAuthority -> ShowS # show :: DescribeCertificateAuthority -> String # showList :: [DescribeCertificateAuthority] -> ShowS #
Generic DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Associated Types type Rep DescribeCertificateAuthority :: Type -> Type # Methods from :: DescribeCertificateAuthority -> Rep DescribeCertificateAuthority x # to :: Rep DescribeCertificateAuthority x -> DescribeCertificateAuthority #
NFData DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods rnf :: DescribeCertificateAuthority -> () #
Hashable DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods hashWithSalt :: Int -> DescribeCertificateAuthority -> Int # hash :: DescribeCertificateAuthority -> Int #
ToJSON DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods toJSON :: DescribeCertificateAuthority -> Value # toEncoding :: DescribeCertificateAuthority -> Encoding # toJSONList :: [DescribeCertificateAuthority] -> Value # toEncodingList :: [DescribeCertificateAuthority] -> Encoding #
AWSRequest DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Associated Types type AWSResponse DescribeCertificateAuthority # Methods request :: DescribeCertificateAuthority -> Request DescribeCertificateAuthority # response :: MonadResource m => Logger -> Service -> Proxy DescribeCertificateAuthority -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCertificateAuthority))) #
ToHeaders DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods toHeaders :: DescribeCertificateAuthority -> [Header] #
ToPath DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods toPath :: DescribeCertificateAuthority -> ByteString #
ToQuery DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods toQuery :: DescribeCertificateAuthority -> QueryString #
type Rep DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority type Rep DescribeCertificateAuthority = D1 ('MetaData "DescribeCertificateAuthority" "Amazonka.CertificateManagerPCA.DescribeCertificateAuthority" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DescribeCertificateAuthority'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeCertificateAuthority Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority type AWSResponse DescribeCertificateAuthority = DescribeCertificateAuthorityResponse

newDescribeCertificateAuthority Source #

Arguments

:: Text	`$sel:certificateAuthorityArn:DescribeCertificateAuthority'`
-> DescribeCertificateAuthority

Create a value of DescribeCertificateAuthority 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:certificateAuthorityArn:DescribeCertificateAuthority', describeCertificateAuthority_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Request Lenses

describeCertificateAuthority_certificateAuthorityArn :: Lens' DescribeCertificateAuthority Text Source #

The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:

arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .

Destructuring the Response

data DescribeCertificateAuthorityResponse Source #

See: newDescribeCertificateAuthorityResponse smart constructor.

Constructors

DescribeCertificateAuthorityResponse'
Fields certificateAuthority :: Maybe CertificateAuthority A CertificateAuthority structure that contains information about your private CA. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods (==) :: DescribeCertificateAuthorityResponse -> DescribeCertificateAuthorityResponse -> Bool # (/=) :: DescribeCertificateAuthorityResponse -> DescribeCertificateAuthorityResponse -> Bool #
Read DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods readsPrec :: Int -> ReadS DescribeCertificateAuthorityResponse # readList :: ReadS [DescribeCertificateAuthorityResponse] # readPrec :: ReadPrec DescribeCertificateAuthorityResponse # readListPrec :: ReadPrec [DescribeCertificateAuthorityResponse] #
Show DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods showsPrec :: Int -> DescribeCertificateAuthorityResponse -> ShowS # show :: DescribeCertificateAuthorityResponse -> String # showList :: [DescribeCertificateAuthorityResponse] -> ShowS #
Generic DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Associated Types type Rep DescribeCertificateAuthorityResponse :: Type -> Type # Methods from :: DescribeCertificateAuthorityResponse -> Rep DescribeCertificateAuthorityResponse x # to :: Rep DescribeCertificateAuthorityResponse x -> DescribeCertificateAuthorityResponse #
NFData DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority Methods rnf :: DescribeCertificateAuthorityResponse -> () #
type Rep DescribeCertificateAuthorityResponse Source #
Instance details Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority type Rep DescribeCertificateAuthorityResponse = D1 ('MetaData "DescribeCertificateAuthorityResponse" "Amazonka.CertificateManagerPCA.DescribeCertificateAuthority" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "DescribeCertificateAuthorityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateAuthority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateAuthority)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeCertificateAuthorityResponse Source #

Arguments

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

Create a value of DescribeCertificateAuthorityResponse 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:certificateAuthority:DescribeCertificateAuthorityResponse', describeCertificateAuthorityResponse_certificateAuthority - A CertificateAuthority structure that contains information about your private CA.

$sel:httpStatus:DescribeCertificateAuthorityResponse', describeCertificateAuthorityResponse_httpStatus - The response's http status code.

Response Lenses

describeCertificateAuthorityResponse_certificateAuthority :: Lens' DescribeCertificateAuthorityResponse (Maybe CertificateAuthority) Source #

A CertificateAuthority structure that contains information about your private CA.

describeCertificateAuthorityResponse_httpStatus :: Lens' DescribeCertificateAuthorityResponse Int Source #

The response's http status code.