amazonka-certificatemanager-pca-2.0: Amazon Certificate Manager Private Certificate Authority SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

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 - Amazon Web Services Private CA is creating your private certificate authority.
  • PENDING_CERTIFICATE - The certificate is pending. You must use your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA to sign your private CA CSR and then import it into Amazon Web Services Private CA.
  • 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 Amazon Web Services 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.
Synopsis

Creating a Request

data DescribeCertificateAuthority Source #

See: newDescribeCertificateAuthority smart constructor.

Constructors

DescribeCertificateAuthority' 

Fields

Instances

Instances details
ToJSON DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

ToHeaders DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

ToPath DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

ToQuery DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

AWSRequest DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Generic DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Associated Types

type Rep DescribeCertificateAuthority :: Type -> Type #

Read DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Show DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

NFData DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Eq DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Hashable DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

type AWSResponse DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

type Rep DescribeCertificateAuthority Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

type Rep DescribeCertificateAuthority = D1 ('MetaData "DescribeCertificateAuthority" "Amazonka.CertificateManagerPCA.DescribeCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "DescribeCertificateAuthority'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeCertificateAuthority Source #

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:

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 #

Constructors

DescribeCertificateAuthorityResponse' 

Fields

Instances

Instances details
Generic DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Read DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Show DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

NFData DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

Eq DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

type Rep DescribeCertificateAuthorityResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.DescribeCertificateAuthority

type Rep DescribeCertificateAuthorityResponse = D1 ('MetaData "DescribeCertificateAuthorityResponse" "Amazonka.CertificateManagerPCA.DescribeCertificateAuthority" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" '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 #

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