libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca
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.CertificateManagerPCA.GetCertificate

Description

Retrieves a certificate from your private CA or one that has been shared with you. The ARN of the certificate is returned when you call the IssueCertificate action. You must specify both the ARN of your private CA and the ARN of the issued certificate when calling the GetCertificate action. You can retrieve the certificate if it is in the ISSUED state. You can call the CreateCertificateAuthorityAuditReport action to create a report that contains information about all of the certificates issued and revoked by your private CA.

Synopsis

Creating a Request

data GetCertificate Source #

See: newGetCertificate smart constructor.

Constructors

GetCertificate' 

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 .

  • certificateArn :: Text

    The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

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

Instances

Instances details
Eq GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Read GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Show GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Generic GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Associated Types

type Rep GetCertificate :: Type -> Type #

NFData GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Methods

rnf :: GetCertificate -> () #

Hashable GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

ToJSON GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

AWSRequest GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Associated Types

type AWSResponse GetCertificate #

ToHeaders GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

ToPath GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

ToQuery GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

type Rep GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

type Rep GetCertificate = D1 ('MetaData "GetCertificate" "Amazonka.CertificateManagerPCA.GetCertificate" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "GetCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificateAuthorityArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetCertificate Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

newGetCertificate Source #

Create a value of GetCertificate 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:GetCertificate', getCertificate_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 .

$sel:certificateArn:GetCertificate', getCertificate_certificateArn - The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

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

Request Lenses

getCertificate_certificateAuthorityArn :: Lens' GetCertificate 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 .

getCertificate_certificateArn :: Lens' GetCertificate Text Source #

The ARN of the issued certificate. The ARN contains the certificate serial number and must be in the following form:

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

Destructuring the Response

data GetCertificateResponse Source #

See: newGetCertificateResponse smart constructor.

Constructors

GetCertificateResponse' 

Fields

  • certificate :: Maybe Text

    The base64 PEM-encoded certificate specified by the CertificateArn parameter.

  • certificateChain :: Maybe Text

    The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Read GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Show GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Generic GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Associated Types

type Rep GetCertificateResponse :: Type -> Type #

NFData GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

Methods

rnf :: GetCertificateResponse -> () #

type Rep GetCertificateResponse Source # 
Instance details

Defined in Amazonka.CertificateManagerPCA.GetCertificate

type Rep GetCertificateResponse = D1 ('MetaData "GetCertificateResponse" "Amazonka.CertificateManagerPCA.GetCertificate" "libZSservicesZSamazonka-certificatemanager-pcaZSamazonka-certificatemanager-pca" 'False) (C1 ('MetaCons "GetCertificateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "certificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "certificateChain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetCertificateResponse Source #

Create a value of GetCertificateResponse 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:certificate:GetCertificateResponse', getCertificateResponse_certificate - The base64 PEM-encoded certificate specified by the CertificateArn parameter.

$sel:certificateChain:GetCertificateResponse', getCertificateResponse_certificateChain - The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.

$sel:httpStatus:GetCertificateResponse', getCertificateResponse_httpStatus - The response's http status code.

Response Lenses

getCertificateResponse_certificate :: Lens' GetCertificateResponse (Maybe Text) Source #

The base64 PEM-encoded certificate specified by the CertificateArn parameter.

getCertificateResponse_certificateChain :: Lens' GetCertificateResponse (Maybe Text) Source #

The base64 PEM-encoded certificate chain that chains up to the root CA certificate that you used to sign your private CA certificate.