| 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.CertificateManagerPCA
Contents
- Service Configuration
- Errors
- CertificateMismatchException
- ConcurrentModificationException
- InvalidArgsException
- InvalidArnException
- InvalidNextTokenException
- InvalidPolicyException
- InvalidRequestException
- InvalidStateException
- InvalidTagException
- LimitExceededException
- LockoutPreventedException
- MalformedCSRException
- MalformedCertificateException
- PermissionAlreadyExistsException
- RequestAlreadyProcessedException
- RequestFailedException
- RequestInProgressException
- ResourceNotFoundException
- TooManyTagsException
- Waiters
- Operations
- CreateCertificateAuthority
- CreateCertificateAuthorityAuditReport
- CreatePermission
- DeleteCertificateAuthority
- DeletePermission
- DeletePolicy
- DescribeCertificateAuthority
- DescribeCertificateAuthorityAuditReport
- GetCertificate
- GetCertificateAuthorityCertificate
- GetCertificateAuthorityCsr
- GetPolicy
- ImportCertificateAuthorityCertificate
- IssueCertificate
- ListCertificateAuthorities (Paginated)
- ListPermissions (Paginated)
- ListTags (Paginated)
- PutPolicy
- RestoreCertificateAuthority
- RevokeCertificate
- TagCertificateAuthority
- UntagCertificateAuthority
- UpdateCertificateAuthority
- Types
- AccessMethodType
- ActionType
- AuditReportResponseFormat
- AuditReportStatus
- CertificateAuthorityStatus
- CertificateAuthorityType
- CertificateAuthorityUsageMode
- ExtendedKeyUsageType
- FailureReason
- KeyAlgorithm
- KeyStorageSecurityStandard
- PolicyQualifierId
- ResourceOwner
- RevocationReason
- S3ObjectAcl
- SigningAlgorithm
- ValidityPeriodType
- ASN1Subject
- AccessDescription
- AccessMethod
- ApiPassthrough
- CertificateAuthority
- CertificateAuthorityConfiguration
- CrlConfiguration
- CsrExtensions
- CustomAttribute
- CustomExtension
- EdiPartyName
- ExtendedKeyUsage
- Extensions
- GeneralName
- KeyUsage
- OcspConfiguration
- OtherName
- Permission
- PolicyInformation
- PolicyQualifierInfo
- Qualifier
- RevocationConfiguration
- Tag
- Validity
Description
Derived from API version 2017-08-22 of the AWS service descriptions, licensed under Apache 2.0.
This is the /Amazon Web Services Private Certificate Authority API Reference/. It provides descriptions, syntax, and usage examples for each of the actions and data types involved in creating and managing a private certificate authority (CA) for your organization.
The documentation for each action shows the API request parameters and the JSON response. Alternatively, you can use one of the Amazon Web Services SDKs to access an API that is tailored to the programming language or platform that you prefer. For more information, see Amazon Web Services SDKs.
Each Amazon Web Services Private CA API operation has a quota that determines the number of times the operation can be called per second. Amazon Web Services Private CA throttles API requests at different rates depending on the operation. Throttling means that Amazon Web Services Private CA rejects an otherwise valid request because the request exceeds the operation's quota for the number of requests per second. When a request is throttled, Amazon Web Services Private CA returns a ThrottlingException error. Amazon Web Services Private CA does not guarantee a minimum request rate for APIs.
To see an up-to-date list of your Amazon Web Services Private CA quotas, or to request a quota increase, log into your Amazon Web Services account and visit the Service Quotas console.
Synopsis
- defaultService :: Service
- _CertificateMismatchException :: AsError a => Fold a ServiceError
- _ConcurrentModificationException :: AsError a => Fold a ServiceError
- _InvalidArgsException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidNextTokenException :: AsError a => Fold a ServiceError
- _InvalidPolicyException :: AsError a => Fold a ServiceError
- _InvalidRequestException :: AsError a => Fold a ServiceError
- _InvalidStateException :: AsError a => Fold a ServiceError
- _InvalidTagException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _LockoutPreventedException :: AsError a => Fold a ServiceError
- _MalformedCSRException :: AsError a => Fold a ServiceError
- _MalformedCertificateException :: AsError a => Fold a ServiceError
- _PermissionAlreadyExistsException :: AsError a => Fold a ServiceError
- _RequestAlreadyProcessedException :: AsError a => Fold a ServiceError
- _RequestFailedException :: AsError a => Fold a ServiceError
- _RequestInProgressException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- newAuditReportCreated :: Wait DescribeCertificateAuthorityAuditReport
- newCertificateAuthorityCSRCreated :: Wait GetCertificateAuthorityCsr
- newCertificateIssued :: Wait GetCertificate
- data CreateCertificateAuthority = CreateCertificateAuthority' (Maybe Text) (Maybe KeyStorageSecurityStandard) (Maybe RevocationConfiguration) (Maybe (NonEmpty Tag)) (Maybe CertificateAuthorityUsageMode) CertificateAuthorityConfiguration CertificateAuthorityType
- newCreateCertificateAuthority :: CertificateAuthorityConfiguration -> CertificateAuthorityType -> CreateCertificateAuthority
- data CreateCertificateAuthorityResponse = CreateCertificateAuthorityResponse' (Maybe Text) Int
- newCreateCertificateAuthorityResponse :: Int -> CreateCertificateAuthorityResponse
- data CreateCertificateAuthorityAuditReport = CreateCertificateAuthorityAuditReport' Text Text AuditReportResponseFormat
- newCreateCertificateAuthorityAuditReport :: Text -> Text -> AuditReportResponseFormat -> CreateCertificateAuthorityAuditReport
- data CreateCertificateAuthorityAuditReportResponse = CreateCertificateAuthorityAuditReportResponse' (Maybe Text) (Maybe Text) Int
- newCreateCertificateAuthorityAuditReportResponse :: Int -> CreateCertificateAuthorityAuditReportResponse
- data CreatePermission = CreatePermission' (Maybe Text) Text Text (NonEmpty ActionType)
- newCreatePermission :: Text -> Text -> NonEmpty ActionType -> CreatePermission
- data CreatePermissionResponse = CreatePermissionResponse' {
- newCreatePermissionResponse :: CreatePermissionResponse
- data DeleteCertificateAuthority = DeleteCertificateAuthority' (Maybe Natural) Text
- newDeleteCertificateAuthority :: Text -> DeleteCertificateAuthority
- data DeleteCertificateAuthorityResponse = DeleteCertificateAuthorityResponse' {
- newDeleteCertificateAuthorityResponse :: DeleteCertificateAuthorityResponse
- data DeletePermission = DeletePermission' (Maybe Text) Text Text
- newDeletePermission :: Text -> Text -> DeletePermission
- data DeletePermissionResponse = DeletePermissionResponse' {
- newDeletePermissionResponse :: DeletePermissionResponse
- data DeletePolicy = DeletePolicy' Text
- newDeletePolicy :: Text -> DeletePolicy
- data DeletePolicyResponse = DeletePolicyResponse' {
- newDeletePolicyResponse :: DeletePolicyResponse
- data DescribeCertificateAuthority = DescribeCertificateAuthority' Text
- newDescribeCertificateAuthority :: Text -> DescribeCertificateAuthority
- data DescribeCertificateAuthorityResponse = DescribeCertificateAuthorityResponse' (Maybe CertificateAuthority) Int
- newDescribeCertificateAuthorityResponse :: Int -> DescribeCertificateAuthorityResponse
- data DescribeCertificateAuthorityAuditReport = DescribeCertificateAuthorityAuditReport' Text Text
- newDescribeCertificateAuthorityAuditReport :: Text -> Text -> DescribeCertificateAuthorityAuditReport
- data DescribeCertificateAuthorityAuditReportResponse = DescribeCertificateAuthorityAuditReportResponse' (Maybe AuditReportStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) Int
- newDescribeCertificateAuthorityAuditReportResponse :: Int -> DescribeCertificateAuthorityAuditReportResponse
- data GetCertificate = GetCertificate' Text Text
- newGetCertificate :: Text -> Text -> GetCertificate
- data GetCertificateResponse = GetCertificateResponse' (Maybe Text) (Maybe Text) Int
- newGetCertificateResponse :: Int -> GetCertificateResponse
- data GetCertificateAuthorityCertificate = GetCertificateAuthorityCertificate' Text
- newGetCertificateAuthorityCertificate :: Text -> GetCertificateAuthorityCertificate
- data GetCertificateAuthorityCertificateResponse = GetCertificateAuthorityCertificateResponse' (Maybe Text) (Maybe Text) Int
- newGetCertificateAuthorityCertificateResponse :: Int -> GetCertificateAuthorityCertificateResponse
- data GetCertificateAuthorityCsr = GetCertificateAuthorityCsr' Text
- newGetCertificateAuthorityCsr :: Text -> GetCertificateAuthorityCsr
- data GetCertificateAuthorityCsrResponse = GetCertificateAuthorityCsrResponse' (Maybe Text) Int
- newGetCertificateAuthorityCsrResponse :: Int -> GetCertificateAuthorityCsrResponse
- data GetPolicy = GetPolicy' Text
- newGetPolicy :: Text -> GetPolicy
- data GetPolicyResponse = GetPolicyResponse' (Maybe Text) Int
- newGetPolicyResponse :: Int -> GetPolicyResponse
- data ImportCertificateAuthorityCertificate = ImportCertificateAuthorityCertificate' (Maybe Base64) Text Base64
- newImportCertificateAuthorityCertificate :: Text -> ByteString -> ImportCertificateAuthorityCertificate
- data ImportCertificateAuthorityCertificateResponse = ImportCertificateAuthorityCertificateResponse' {
- newImportCertificateAuthorityCertificateResponse :: ImportCertificateAuthorityCertificateResponse
- data IssueCertificate = IssueCertificate' (Maybe ApiPassthrough) (Maybe Text) (Maybe Text) (Maybe Validity) Text Base64 SigningAlgorithm Validity
- newIssueCertificate :: Text -> ByteString -> SigningAlgorithm -> Validity -> IssueCertificate
- data IssueCertificateResponse = IssueCertificateResponse' (Maybe Text) Int
- newIssueCertificateResponse :: Int -> IssueCertificateResponse
- data ListCertificateAuthorities = ListCertificateAuthorities' (Maybe Natural) (Maybe Text) (Maybe ResourceOwner)
- newListCertificateAuthorities :: ListCertificateAuthorities
- data ListCertificateAuthoritiesResponse = ListCertificateAuthoritiesResponse' (Maybe [CertificateAuthority]) (Maybe Text) Int
- newListCertificateAuthoritiesResponse :: Int -> ListCertificateAuthoritiesResponse
- data ListPermissions = ListPermissions' (Maybe Natural) (Maybe Text) Text
- newListPermissions :: Text -> ListPermissions
- data ListPermissionsResponse = ListPermissionsResponse' (Maybe Text) (Maybe [Permission]) Int
- newListPermissionsResponse :: Int -> ListPermissionsResponse
- data ListTags = ListTags' (Maybe Natural) (Maybe Text) Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe (NonEmpty Tag)) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data PutPolicy = PutPolicy' Text Text
- newPutPolicy :: Text -> Text -> PutPolicy
- data PutPolicyResponse = PutPolicyResponse' {
- newPutPolicyResponse :: PutPolicyResponse
- data RestoreCertificateAuthority = RestoreCertificateAuthority' Text
- newRestoreCertificateAuthority :: Text -> RestoreCertificateAuthority
- data RestoreCertificateAuthorityResponse = RestoreCertificateAuthorityResponse' {
- newRestoreCertificateAuthorityResponse :: RestoreCertificateAuthorityResponse
- data RevokeCertificate = RevokeCertificate' Text Text RevocationReason
- newRevokeCertificate :: Text -> Text -> RevocationReason -> RevokeCertificate
- data RevokeCertificateResponse = RevokeCertificateResponse' {
- newRevokeCertificateResponse :: RevokeCertificateResponse
- data TagCertificateAuthority = TagCertificateAuthority' Text (NonEmpty Tag)
- newTagCertificateAuthority :: Text -> NonEmpty Tag -> TagCertificateAuthority
- data TagCertificateAuthorityResponse = TagCertificateAuthorityResponse' {
- newTagCertificateAuthorityResponse :: TagCertificateAuthorityResponse
- data UntagCertificateAuthority = UntagCertificateAuthority' Text (NonEmpty Tag)
- newUntagCertificateAuthority :: Text -> NonEmpty Tag -> UntagCertificateAuthority
- data UntagCertificateAuthorityResponse = UntagCertificateAuthorityResponse' {
- newUntagCertificateAuthorityResponse :: UntagCertificateAuthorityResponse
- data UpdateCertificateAuthority = UpdateCertificateAuthority' (Maybe RevocationConfiguration) (Maybe CertificateAuthorityStatus) Text
- newUpdateCertificateAuthority :: Text -> UpdateCertificateAuthority
- data UpdateCertificateAuthorityResponse = UpdateCertificateAuthorityResponse' {
- newUpdateCertificateAuthorityResponse :: UpdateCertificateAuthorityResponse
- newtype AccessMethodType where
- newtype ActionType where
- ActionType' { }
- pattern ActionType_GetCertificate :: ActionType
- pattern ActionType_IssueCertificate :: ActionType
- pattern ActionType_ListPermissions :: ActionType
- newtype AuditReportResponseFormat where
- newtype AuditReportStatus where
- AuditReportStatus' { }
- pattern AuditReportStatus_CREATING :: AuditReportStatus
- pattern AuditReportStatus_FAILED :: AuditReportStatus
- pattern AuditReportStatus_SUCCESS :: AuditReportStatus
- newtype CertificateAuthorityStatus where
- CertificateAuthorityStatus' { }
- pattern CertificateAuthorityStatus_ACTIVE :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_CREATING :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_DELETED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_DISABLED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_EXPIRED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_FAILED :: CertificateAuthorityStatus
- pattern CertificateAuthorityStatus_PENDING_CERTIFICATE :: CertificateAuthorityStatus
- newtype CertificateAuthorityType where
- newtype CertificateAuthorityUsageMode where
- newtype ExtendedKeyUsageType where
- ExtendedKeyUsageType' { }
- pattern ExtendedKeyUsageType_CERTIFICATE_TRANSPARENCY :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_CLIENT_AUTH :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_CODE_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_DOCUMENT_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_EMAIL_PROTECTION :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_OCSP_SIGNING :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_SERVER_AUTH :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_SMART_CARD_LOGIN :: ExtendedKeyUsageType
- pattern ExtendedKeyUsageType_TIME_STAMPING :: ExtendedKeyUsageType
- newtype FailureReason where
- FailureReason' { }
- pattern FailureReason_OTHER :: FailureReason
- pattern FailureReason_REQUEST_TIMED_OUT :: FailureReason
- pattern FailureReason_UNSUPPORTED_ALGORITHM :: FailureReason
- newtype KeyAlgorithm where
- KeyAlgorithm' { }
- pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm
- pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm
- newtype KeyStorageSecurityStandard where
- newtype PolicyQualifierId where
- PolicyQualifierId' { }
- pattern PolicyQualifierId_CPS :: PolicyQualifierId
- newtype ResourceOwner where
- ResourceOwner' { }
- pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner
- pattern ResourceOwner_SELF :: ResourceOwner
- newtype RevocationReason where
- RevocationReason' { }
- pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason
- pattern RevocationReason_A_A_COMPROMISE :: RevocationReason
- pattern RevocationReason_CERTIFICATE_AUTHORITY_COMPROMISE :: RevocationReason
- pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason
- pattern RevocationReason_KEY_COMPROMISE :: RevocationReason
- pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason
- pattern RevocationReason_SUPERSEDED :: RevocationReason
- pattern RevocationReason_UNSPECIFIED :: RevocationReason
- newtype S3ObjectAcl where
- S3ObjectAcl' { }
- pattern S3ObjectAcl_BUCKET_OWNER_FULL_CONTROL :: S3ObjectAcl
- pattern S3ObjectAcl_PUBLIC_READ :: S3ObjectAcl
- newtype SigningAlgorithm where
- SigningAlgorithm' { }
- pattern SigningAlgorithm_SHA256WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA256WITHRSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA384WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA384WITHRSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA512WITHECDSA :: SigningAlgorithm
- pattern SigningAlgorithm_SHA512WITHRSA :: SigningAlgorithm
- newtype ValidityPeriodType where
- ValidityPeriodType' { }
- pattern ValidityPeriodType_ABSOLUTE :: ValidityPeriodType
- pattern ValidityPeriodType_DAYS :: ValidityPeriodType
- pattern ValidityPeriodType_END_DATE :: ValidityPeriodType
- pattern ValidityPeriodType_MONTHS :: ValidityPeriodType
- pattern ValidityPeriodType_YEARS :: ValidityPeriodType
- data ASN1Subject = ASN1Subject' (Maybe Text) (Maybe Text) (Maybe (NonEmpty CustomAttribute)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newASN1Subject :: ASN1Subject
- data AccessDescription = AccessDescription' AccessMethod GeneralName
- newAccessDescription :: AccessMethod -> GeneralName -> AccessDescription
- data AccessMethod = AccessMethod' (Maybe AccessMethodType) (Maybe Text)
- newAccessMethod :: AccessMethod
- data ApiPassthrough = ApiPassthrough' (Maybe Extensions) (Maybe ASN1Subject)
- newApiPassthrough :: ApiPassthrough
- data CertificateAuthority = CertificateAuthority' (Maybe Text) (Maybe CertificateAuthorityConfiguration) (Maybe POSIX) (Maybe FailureReason) (Maybe KeyStorageSecurityStandard) (Maybe POSIX) (Maybe POSIX) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe RevocationConfiguration) (Maybe Text) (Maybe CertificateAuthorityStatus) (Maybe CertificateAuthorityType) (Maybe CertificateAuthorityUsageMode)
- newCertificateAuthority :: CertificateAuthority
- data CertificateAuthorityConfiguration = CertificateAuthorityConfiguration' (Maybe CsrExtensions) KeyAlgorithm SigningAlgorithm ASN1Subject
- newCertificateAuthorityConfiguration :: KeyAlgorithm -> SigningAlgorithm -> ASN1Subject -> CertificateAuthorityConfiguration
- data CrlConfiguration = CrlConfiguration' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe S3ObjectAcl) Bool
- newCrlConfiguration :: Bool -> CrlConfiguration
- data CsrExtensions = CsrExtensions' (Maybe KeyUsage) (Maybe [AccessDescription])
- newCsrExtensions :: CsrExtensions
- data CustomAttribute = CustomAttribute' Text Text
- newCustomAttribute :: Text -> Text -> CustomAttribute
- data CustomExtension = CustomExtension' (Maybe Bool) Text Text
- newCustomExtension :: Text -> Text -> CustomExtension
- data EdiPartyName = EdiPartyName' (Maybe Text) Text
- newEdiPartyName :: Text -> EdiPartyName
- data ExtendedKeyUsage = ExtendedKeyUsage' (Maybe Text) (Maybe ExtendedKeyUsageType)
- newExtendedKeyUsage :: ExtendedKeyUsage
- data Extensions = Extensions' (Maybe (NonEmpty PolicyInformation)) (Maybe (NonEmpty CustomExtension)) (Maybe (NonEmpty ExtendedKeyUsage)) (Maybe KeyUsage) (Maybe (NonEmpty GeneralName))
- newExtensions :: Extensions
- data GeneralName = GeneralName' (Maybe ASN1Subject) (Maybe Text) (Maybe EdiPartyName) (Maybe Text) (Maybe OtherName) (Maybe Text) (Maybe Text) (Maybe Text)
- newGeneralName :: GeneralName
- data KeyUsage = KeyUsage' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool)
- newKeyUsage :: KeyUsage
- data OcspConfiguration = OcspConfiguration' (Maybe Text) Bool
- newOcspConfiguration :: Bool -> OcspConfiguration
- data OtherName = OtherName' Text Text
- newOtherName :: Text -> Text -> OtherName
- data Permission = Permission' (Maybe (NonEmpty ActionType)) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text)
- newPermission :: Permission
- data PolicyInformation = PolicyInformation' (Maybe (NonEmpty PolicyQualifierInfo)) Text
- newPolicyInformation :: Text -> PolicyInformation
- data PolicyQualifierInfo = PolicyQualifierInfo' PolicyQualifierId Qualifier
- newPolicyQualifierInfo :: PolicyQualifierId -> Qualifier -> PolicyQualifierInfo
- data Qualifier = Qualifier' Text
- newQualifier :: Text -> Qualifier
- data RevocationConfiguration = RevocationConfiguration' (Maybe CrlConfiguration) (Maybe OcspConfiguration)
- newRevocationConfiguration :: RevocationConfiguration
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
- data Validity = Validity' Natural ValidityPeriodType
- newValidity :: Natural -> ValidityPeriodType -> Validity
Service Configuration
defaultService :: Service Source #
API version 2017-08-22 of the Amazon Certificate Manager Private Certificate Authority SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CertificateManagerPCA.
CertificateMismatchException
_CertificateMismatchException :: AsError a => Fold a ServiceError Source #
The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.
ConcurrentModificationException
_ConcurrentModificationException :: AsError a => Fold a ServiceError Source #
A previous update to your private CA is still ongoing.
InvalidArgsException
_InvalidArgsException :: AsError a => Fold a ServiceError Source #
One or more of the specified arguments was not valid.
InvalidArnException
_InvalidArnException :: AsError a => Fold a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidNextTokenException
_InvalidNextTokenException :: AsError a => Fold a ServiceError Source #
The token specified in the NextToken argument is not valid. Use the
token returned from your previous call to
ListCertificateAuthorities.
InvalidPolicyException
_InvalidPolicyException :: AsError a => Fold a ServiceError Source #
The resource policy is invalid or is missing a required statement. For general information about IAM policy and statement structure, see Overview of JSON Policies.
InvalidRequestException
_InvalidRequestException :: AsError a => Fold a ServiceError Source #
The request action cannot be performed or is prohibited.
InvalidStateException
_InvalidStateException :: AsError a => Fold a ServiceError Source #
The state of the private CA does not allow this action to occur.
InvalidTagException
_InvalidTagException :: AsError a => Fold a ServiceError Source #
The tag associated with the CA is not valid. The invalid argument is contained in the message field.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
An Amazon Web Services Private CA quota has been exceeded. See the exception message returned to determine the quota that was exceeded.
LockoutPreventedException
_LockoutPreventedException :: AsError a => Fold a ServiceError Source #
The current action was prevented because it would lock the caller out from performing subsequent actions. Verify that the specified parameters would not result in the caller being denied access to the resource.
MalformedCSRException
_MalformedCSRException :: AsError a => Fold a ServiceError Source #
The certificate signing request is invalid.
MalformedCertificateException
_MalformedCertificateException :: AsError a => Fold a ServiceError Source #
One or more fields in the certificate are invalid.
PermissionAlreadyExistsException
_PermissionAlreadyExistsException :: AsError a => Fold a ServiceError Source #
The designated permission has already been given to the user.
RequestAlreadyProcessedException
_RequestAlreadyProcessedException :: AsError a => Fold a ServiceError Source #
Your request has already been completed.
RequestFailedException
_RequestFailedException :: AsError a => Fold a ServiceError Source #
The request has failed for an unspecified reason.
RequestInProgressException
_RequestInProgressException :: AsError a => Fold a ServiceError Source #
Your request is already in progress.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
A resource such as a private CA, S3 bucket, certificate, audit report, or policy cannot be found.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
AuditReportCreated
newAuditReportCreated :: Wait DescribeCertificateAuthorityAuditReport Source #
Polls DescribeCertificateAuthorityAuditReport every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
CertificateAuthorityCSRCreated
newCertificateAuthorityCSRCreated :: Wait GetCertificateAuthorityCsr Source #
Polls GetCertificateAuthorityCsr every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
CertificateIssued
newCertificateIssued :: Wait GetCertificate Source #
Polls GetCertificate every 3 seconds until a successful state is reached. An error is returned after 60 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateCertificateAuthority
data CreateCertificateAuthority Source #
See: newCreateCertificateAuthority smart constructor.
Constructors
Instances
newCreateCertificateAuthority Source #
Arguments
| :: CertificateAuthorityConfiguration | |
| -> CertificateAuthorityType | |
| -> CreateCertificateAuthority |
Create a value of CreateCertificateAuthority 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:idempotencyToken:CreateCertificateAuthority', createCertificateAuthority_idempotencyToken - Custom string that can be used to distinguish between calls to the
CreateCertificateAuthority action. Idempotency tokens for
CreateCertificateAuthority time out after five minutes. Therefore,
if you call CreateCertificateAuthority multiple times with the same
idempotency token within five minutes, Amazon Web Services Private CA
recognizes that you are requesting only certificate authority and will
issue only one. If you change the idempotency token for each call,
Amazon Web Services Private CA recognizes that you are requesting
multiple certificate authorities.
CreateCertificateAuthority, createCertificateAuthority_keyStorageSecurityStandard - Specifies a cryptographic key management compliance standard used for
handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: FIPS_140_2_LEVEL_3_OR_HIGHER is not supported in the following
Regions:
- ap-northeast-3
- ap-southeast-3
When creating a CA in these Regions, you must provide
FIPS_140_2_LEVEL_2_OR_HIGHER as the argument for
KeyStorageSecurityStandard. Failure to do this results in an
InvalidArgsException with the message, "A certificate authority
cannot be created in this region with the specified security standard."
CreateCertificateAuthority, createCertificateAuthority_revocationConfiguration - Contains information to enable Online Certificate Status Protocol (OCSP)
support, to enable a certificate revocation list (CRL), to enable both,
or to enable neither. The default is for both certificate validation
mechanisms to be disabled.
The following requirements apply to revocation configurations.
- A configuration disabling CRLs or OCSP must contain only the
Enabled=Falseparameter, and will fail if other parameters such asCustomCnameorExpirationInDaysare included. - In a CRL configuration, the
S3BucketNameparameter must conform to Amazon S3 bucket naming rules. - A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
- In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
For more information, see the OcspConfiguration and CrlConfiguration types.
$sel:tags:CreateCertificateAuthority', createCertificateAuthority_tags - Key-value pairs that will be attached to the new private CA. You can
associate up to 50 tags with a private CA. For information using tags
with IAM to manage permissions, see
Controlling Access Using IAM Tags.
CreateCertificateAuthority, createCertificateAuthority_usageMode - Specifies whether the CA issues general-purpose certificates that
typically require a revocation mechanism, or short-lived certificates
that may optionally omit revocation because they expire quickly.
Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
CreateCertificateAuthority, createCertificateAuthority_certificateAuthorityConfiguration - Name and bit size of the private key algorithm, the name of the signing
algorithm, and X.500 certificate subject information.
$sel:certificateAuthorityType:CreateCertificateAuthority', createCertificateAuthority_certificateAuthorityType - The type of the certificate authority.
data CreateCertificateAuthorityResponse Source #
See: newCreateCertificateAuthorityResponse smart constructor.
Constructors
| CreateCertificateAuthorityResponse' (Maybe Text) Int |
Instances
newCreateCertificateAuthorityResponse Source #
Arguments
| :: Int | |
| -> CreateCertificateAuthorityResponse |
Create a value of CreateCertificateAuthorityResponse 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:
CreateCertificateAuthorityResponse, createCertificateAuthorityResponse_certificateAuthorityArn - If successful, the Amazon Resource Name (ARN) of the certificate
authority (CA). This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
$sel:httpStatus:CreateCertificateAuthorityResponse', createCertificateAuthorityResponse_httpStatus - The response's http status code.
CreateCertificateAuthorityAuditReport
data CreateCertificateAuthorityAuditReport Source #
See: newCreateCertificateAuthorityAuditReport smart constructor.
Instances
newCreateCertificateAuthorityAuditReport Source #
Arguments
| :: Text | |
| -> Text | |
| -> AuditReportResponseFormat |
|
| -> CreateCertificateAuthorityAuditReport |
Create a value of CreateCertificateAuthorityAuditReport 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:
CreateCertificateAuthorityAuditReport, createCertificateAuthorityAuditReport_certificateAuthorityArn - The Amazon Resource Name (ARN) of the CA to be audited. This is of the
form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
CreateCertificateAuthorityAuditReport, createCertificateAuthorityAuditReport_s3BucketName - The name of the S3 bucket that will contain the audit report.
$sel:auditReportResponseFormat:CreateCertificateAuthorityAuditReport', createCertificateAuthorityAuditReport_auditReportResponseFormat - The format in which to create the report. This can be either JSON or
CSV.
data CreateCertificateAuthorityAuditReportResponse Source #
See: newCreateCertificateAuthorityAuditReportResponse smart constructor.
Instances
newCreateCertificateAuthorityAuditReportResponse Source #
Arguments
| :: Int |
|
| -> CreateCertificateAuthorityAuditReportResponse |
Create a value of CreateCertificateAuthorityAuditReportResponse 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:auditReportId:CreateCertificateAuthorityAuditReportResponse', createCertificateAuthorityAuditReportResponse_auditReportId - An alphanumeric string that contains a report identifier.
$sel:s3Key:CreateCertificateAuthorityAuditReportResponse', createCertificateAuthorityAuditReportResponse_s3Key - The key that uniquely identifies the report file in your S3 bucket.
$sel:httpStatus:CreateCertificateAuthorityAuditReportResponse', createCertificateAuthorityAuditReportResponse_httpStatus - The response's http status code.
CreatePermission
data CreatePermission Source #
See: newCreatePermission smart constructor.
Constructors
| CreatePermission' (Maybe Text) Text Text (NonEmpty ActionType) |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty ActionType | |
| -> CreatePermission |
Create a value of CreatePermission 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:
CreatePermission, createPermission_sourceAccount - The ID of the calling account.
CreatePermission, createPermission_certificateAuthorityArn - The Amazon Resource Name (ARN) of the CA that grants the permissions.
You can find the ARN by calling the
ListCertificateAuthorities
action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
CreatePermission, createPermission_principal - The Amazon Web Services service or identity that receives the
permission. At this time, the only valid principal is
acm.amazonaws.com.
CreatePermission, createPermission_actions - The actions that the specified Amazon Web Services service principal can
use. These include IssueCertificate, GetCertificate, and
ListPermissions.
data CreatePermissionResponse Source #
See: newCreatePermissionResponse smart constructor.
Constructors
| CreatePermissionResponse' | |
Instances
newCreatePermissionResponse :: CreatePermissionResponse Source #
Create a value of CreatePermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCertificateAuthority
data DeleteCertificateAuthority Source #
See: newDeleteCertificateAuthority smart constructor.
Constructors
| DeleteCertificateAuthority' (Maybe Natural) Text |
Instances
newDeleteCertificateAuthority Source #
Arguments
| :: Text | |
| -> DeleteCertificateAuthority |
Create a value of DeleteCertificateAuthority 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:permanentDeletionTimeInDays:DeleteCertificateAuthority', deleteCertificateAuthority_permanentDeletionTimeInDays - The number of days to make a CA restorable after it has been deleted.
This can be anywhere from 7 to 30 days, with 30 being the default.
DeleteCertificateAuthority, deleteCertificateAuthority_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called
CreateCertificateAuthority.
This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
data DeleteCertificateAuthorityResponse Source #
See: newDeleteCertificateAuthorityResponse smart constructor.
Constructors
| DeleteCertificateAuthorityResponse' | |
Instances
newDeleteCertificateAuthorityResponse :: DeleteCertificateAuthorityResponse Source #
Create a value of DeleteCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePermission
data DeletePermission Source #
See: newDeletePermission smart constructor.
Constructors
| DeletePermission' (Maybe Text) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DeletePermission |
Create a value of DeletePermission 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:
DeletePermission, deletePermission_sourceAccount - The Amazon Web Services account that calls this action.
DeletePermission, deletePermission_certificateAuthorityArn - The Amazon Resource Number (ARN) of the private CA that issued the
permissions. You can find the CA's ARN by calling the
ListCertificateAuthorities
action. This must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
DeletePermission, deletePermission_principal - The Amazon Web Services service or identity that will have its CA
permissions revoked. At this time, the only valid service principal is
acm.amazonaws.com
data DeletePermissionResponse Source #
See: newDeletePermissionResponse smart constructor.
Constructors
| DeletePermissionResponse' | |
Instances
newDeletePermissionResponse :: DeletePermissionResponse Source #
Create a value of DeletePermissionResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeletePolicy
data DeletePolicy Source #
See: newDeletePolicy smart constructor.
Constructors
| DeletePolicy' Text |
Instances
Arguments
| :: Text | |
| -> DeletePolicy |
Create a value of DeletePolicy 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:resourceArn:DeletePolicy', deletePolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA that will have its
policy deleted. You can find the CA's ARN by calling the
ListCertificateAuthorities
action. The ARN value must have the form
arn:aws:acm-pca:region:account:certificate-authority/01234567-89ab-cdef-0123-0123456789ab.
data DeletePolicyResponse Source #
See: newDeletePolicyResponse smart constructor.
Constructors
| DeletePolicyResponse' | |
Instances
newDeletePolicyResponse :: DeletePolicyResponse Source #
Create a value of DeletePolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeCertificateAuthority
data DescribeCertificateAuthority Source #
See: newDescribeCertificateAuthority smart constructor.
Constructors
| DescribeCertificateAuthority' Text |
Instances
newDescribeCertificateAuthority Source #
Arguments
| :: Text | |
| -> 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:
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 .
data DescribeCertificateAuthorityResponse Source #
See: newDescribeCertificateAuthorityResponse smart constructor.
Constructors
| DescribeCertificateAuthorityResponse' (Maybe CertificateAuthority) Int |
Instances
newDescribeCertificateAuthorityResponse Source #
Arguments
| :: Int | |
| -> 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.
DescribeCertificateAuthorityAuditReport
data DescribeCertificateAuthorityAuditReport Source #
See: newDescribeCertificateAuthorityAuditReport smart constructor.
Constructors
| DescribeCertificateAuthorityAuditReport' Text Text |
Instances
newDescribeCertificateAuthorityAuditReport Source #
Arguments
| :: Text | |
| -> Text | |
| -> DescribeCertificateAuthorityAuditReport |
Create a value of DescribeCertificateAuthorityAuditReport 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:
DescribeCertificateAuthorityAuditReport, describeCertificateAuthorityAuditReport_certificateAuthorityArn - The Amazon Resource Name (ARN) of the private CA. This must be of the
form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
$sel:auditReportId:DescribeCertificateAuthorityAuditReport', describeCertificateAuthorityAuditReport_auditReportId - The report ID returned by calling the
CreateCertificateAuthorityAuditReport
action.
data DescribeCertificateAuthorityAuditReportResponse Source #
See: newDescribeCertificateAuthorityAuditReportResponse smart constructor.
Constructors
| DescribeCertificateAuthorityAuditReportResponse' (Maybe AuditReportStatus) (Maybe POSIX) (Maybe Text) (Maybe Text) Int |
Instances
newDescribeCertificateAuthorityAuditReportResponse Source #
Arguments
| :: Int |
|
| -> DescribeCertificateAuthorityAuditReportResponse |
Create a value of DescribeCertificateAuthorityAuditReportResponse 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:auditReportStatus:DescribeCertificateAuthorityAuditReportResponse', describeCertificateAuthorityAuditReportResponse_auditReportStatus - Specifies whether report creation is in progress, has succeeded, or has
failed.
DescribeCertificateAuthorityAuditReportResponse, describeCertificateAuthorityAuditReportResponse_createdAt - The date and time at which the report was created.
DescribeCertificateAuthorityAuditReportResponse, describeCertificateAuthorityAuditReportResponse_s3BucketName - Name of the S3 bucket that contains the report.
$sel:s3Key:DescribeCertificateAuthorityAuditReportResponse', describeCertificateAuthorityAuditReportResponse_s3Key - S3 key that uniquely identifies the report file in your S3 bucket.
$sel:httpStatus:DescribeCertificateAuthorityAuditReportResponse', describeCertificateAuthorityAuditReportResponse_httpStatus - The response's http status code.
GetCertificate
data GetCertificate Source #
See: newGetCertificate smart constructor.
Constructors
| GetCertificate' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetCertificate |
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:
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
data GetCertificateResponse Source #
See: newGetCertificateResponse smart constructor.
Instances
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.
GetCertificateAuthorityCertificate
data GetCertificateAuthorityCertificate Source #
See: newGetCertificateAuthorityCertificate smart constructor.
Constructors
| GetCertificateAuthorityCertificate' Text |
Instances
newGetCertificateAuthorityCertificate Source #
Create a value of GetCertificateAuthorityCertificate 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:
GetCertificateAuthorityCertificate, getCertificateAuthorityCertificate_certificateAuthorityArn - The Amazon Resource Name (ARN) of your private CA. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012 .
data GetCertificateAuthorityCertificateResponse Source #
See: newGetCertificateAuthorityCertificateResponse smart constructor.
Instances
newGetCertificateAuthorityCertificateResponse Source #
Arguments
| :: Int | |
| -> GetCertificateAuthorityCertificateResponse |
Create a value of GetCertificateAuthorityCertificateResponse 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:GetCertificateAuthorityCertificateResponse', getCertificateAuthorityCertificateResponse_certificate - Base64-encoded certificate authority (CA) certificate.
$sel:certificateChain:GetCertificateAuthorityCertificateResponse', getCertificateAuthorityCertificateResponse_certificateChain - Base64-encoded certificate chain that includes any intermediate
certificates and chains up to root certificate that you used to sign
your private CA certificate. The chain does not include your private CA
certificate. If this is a root CA, the value will be null.
$sel:httpStatus:GetCertificateAuthorityCertificateResponse', getCertificateAuthorityCertificateResponse_httpStatus - The response's http status code.
GetCertificateAuthorityCsr
data GetCertificateAuthorityCsr Source #
See: newGetCertificateAuthorityCsr smart constructor.
Constructors
| GetCertificateAuthorityCsr' Text |
Instances
newGetCertificateAuthorityCsr Source #
Arguments
| :: Text | |
| -> GetCertificateAuthorityCsr |
Create a value of GetCertificateAuthorityCsr 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:
GetCertificateAuthorityCsr, getCertificateAuthorityCsr_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called the
CreateCertificateAuthority
action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
data GetCertificateAuthorityCsrResponse Source #
See: newGetCertificateAuthorityCsrResponse smart constructor.
Constructors
| GetCertificateAuthorityCsrResponse' (Maybe Text) Int |
Instances
newGetCertificateAuthorityCsrResponse Source #
Arguments
| :: Int | |
| -> GetCertificateAuthorityCsrResponse |
Create a value of GetCertificateAuthorityCsrResponse 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:csr:GetCertificateAuthorityCsrResponse', getCertificateAuthorityCsrResponse_csr - The base64 PEM-encoded certificate signing request (CSR) for your
private CA certificate.
$sel:httpStatus:GetCertificateAuthorityCsrResponse', getCertificateAuthorityCsrResponse_httpStatus - The response's http status code.
GetPolicy
See: newGetPolicy smart constructor.
Constructors
| GetPolicy' Text |
Instances
Create a value of GetPolicy 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:resourceArn:GetPolicy', getPolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA that will have its
policy retrieved. You can find the CA's ARN by calling the
ListCertificateAuthorities action.
data GetPolicyResponse Source #
See: newGetPolicyResponse smart constructor.
Constructors
| GetPolicyResponse' (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetPolicyResponse |
Create a value of GetPolicyResponse 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:
GetPolicyResponse, getPolicyResponse_policy - The policy attached to the private CA as a JSON document.
$sel:httpStatus:GetPolicyResponse', getPolicyResponse_httpStatus - The response's http status code.
ImportCertificateAuthorityCertificate
data ImportCertificateAuthorityCertificate Source #
See: newImportCertificateAuthorityCertificate smart constructor.
Constructors
| ImportCertificateAuthorityCertificate' (Maybe Base64) Text Base64 |
Instances
newImportCertificateAuthorityCertificate Source #
Arguments
| :: Text | |
| -> ByteString | |
| -> ImportCertificateAuthorityCertificate |
Create a value of ImportCertificateAuthorityCertificate 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:certificateChain:ImportCertificateAuthorityCertificate', importCertificateAuthorityCertificate_certificateChain - A PEM-encoded file that contains all of your certificates, other than
the certificate you're importing, chaining up to your root CA. Your
Amazon Web Services Private CA-hosted or on-premises root certificate is
the last in the chain, and each certificate in the chain signs the one
preceding.
This parameter must be supplied when you import a subordinate CA. When
you import a root CA, there is no chain.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
ImportCertificateAuthorityCertificate, importCertificateAuthorityCertificate_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:certificate:ImportCertificateAuthorityCertificate', importCertificateAuthorityCertificate_certificate - The PEM-encoded certificate for a private CA. This may be a self-signed
certificate in the case of a root CA, or it may be signed by another CA
that you control.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
data ImportCertificateAuthorityCertificateResponse Source #
See: newImportCertificateAuthorityCertificateResponse smart constructor.
Constructors
| ImportCertificateAuthorityCertificateResponse' | |
Instances
newImportCertificateAuthorityCertificateResponse :: ImportCertificateAuthorityCertificateResponse Source #
Create a value of ImportCertificateAuthorityCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
IssueCertificate
data IssueCertificate Source #
See: newIssueCertificate smart constructor.
Constructors
| IssueCertificate' (Maybe ApiPassthrough) (Maybe Text) (Maybe Text) (Maybe Validity) Text Base64 SigningAlgorithm Validity |
Instances
Arguments
| :: Text | |
| -> ByteString | |
| -> SigningAlgorithm | |
| -> Validity | |
| -> IssueCertificate |
Create a value of IssueCertificate 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:apiPassthrough:IssueCertificate', issueCertificate_apiPassthrough - Specifies X.509 certificate information to be included in the issued
certificate. An APIPassthrough or APICSRPassthrough template variant
must be selected, or else this parameter is ignored. For more
information about using these templates, see
Understanding Certificate Templates.
If conflicting or duplicate certificate information is supplied during certificate issuance, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
$sel:idempotencyToken:IssueCertificate', issueCertificate_idempotencyToken - Alphanumeric string that can be used to distinguish between calls to the
IssueCertificate action. Idempotency tokens for IssueCertificate
time out after one minute. Therefore, if you call IssueCertificate
multiple times with the same idempotency token within one minute, Amazon
Web Services Private CA recognizes that you are requesting only one
certificate and will issue only one. If you change the idempotency token
for each call, Amazon Web Services Private CA recognizes that you are
requesting multiple certificates.
$sel:templateArn:IssueCertificate', issueCertificate_templateArn - Specifies a custom configuration template to use when issuing a
certificate. If this parameter is not provided, Amazon Web Services
Private CA defaults to the EndEntityCertificate/V1 template. For CA
certificates, you should choose the shortest path length that meets your
needs. The path length is indicated by the PathLenN portion of the
ARN, where N is the
CA depth.
Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.
For a list of TemplateArn values supported by Amazon Web Services
Private CA, see
Understanding Certificate Templates.
$sel:validityNotBefore:IssueCertificate', issueCertificate_validityNotBefore - Information describing the start of the validity period of the
certificate. This parameter sets the “Not Before" date for the
certificate.
By default, when issuing a certificate, Amazon Web Services Private CA
sets the "Not Before" date to the issuance time minus 60 minutes. This
compensates for clock inconsistencies across computer systems. The
ValidityNotBefore parameter can be used to customize the “Not Before”
value.
Unlike the Validity parameter, the ValidityNotBefore parameter is
optional.
The ValidityNotBefore value is expressed as an explicit date and time,
using the Validity type value ABSOLUTE. For more information, see
Validity
in this API reference and
Validity
in RFC 5280.
IssueCertificate, issueCertificate_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:csr:IssueCertificate', issueCertificate_csr - The certificate signing request (CSR) for the certificate you want to
issue. As an example, you can use the following OpenSSL command to
create the CSR and a 2048 bit RSA private key.
openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
If you have a configuration file, you can then use the following OpenSSL
command. The usr_cert block in the configuration file contains your
X509 version 3 extensions.
openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csr
Note: A CSR must provide either a subject name or a /subject
alternative name/ or the request will be rejected.--
-- Note: This Lens automatically encodes and decodes Base64 data.
-- The underlying isomorphism will encode to Base64 representation during
-- serialisation, and decode from Base64 representation during deserialisation.
-- This Lens accepts and returns only raw unencoded data.
IssueCertificate, issueCertificate_signingAlgorithm - The name of the algorithm that will be used to sign the certificate to
be issued.
This parameter should not be confused with the SigningAlgorithm
parameter used to sign a CSR in the CreateCertificateAuthority action.
The specified signing algorithm family (RSA or ECDSA) much match the algorithm family of the CA's secret key.
$sel:validity:IssueCertificate', issueCertificate_validity - Information describing the end of the validity period of the
certificate. This parameter sets the “Not After” date for the
certificate.
Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
This value is unaffected when ValidityNotBefore is also specified. For
example, if Validity is set to 20 days in the future, the certificate
will expire 20 days from issuance time regardless of the
ValidityNotBefore value.
The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
data IssueCertificateResponse Source #
See: newIssueCertificateResponse smart constructor.
Constructors
| IssueCertificateResponse' (Maybe Text) Int |
Instances
newIssueCertificateResponse Source #
Create a value of IssueCertificateResponse 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:certificateArn:IssueCertificateResponse', issueCertificateResponse_certificateArn - The Amazon Resource Name (ARN) of the issued certificate and the
certificate serial number. This is of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012/certificate/286535153982981100925020015808220737245
$sel:httpStatus:IssueCertificateResponse', issueCertificateResponse_httpStatus - The response's http status code.
ListCertificateAuthorities (Paginated)
data ListCertificateAuthorities Source #
See: newListCertificateAuthorities smart constructor.
Constructors
| ListCertificateAuthorities' (Maybe Natural) (Maybe Text) (Maybe ResourceOwner) |
Instances
newListCertificateAuthorities :: ListCertificateAuthorities Source #
Create a value of ListCertificateAuthorities 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:ListCertificateAuthorities', listCertificateAuthorities_maxResults - Use this parameter when paginating results to specify the maximum number
of items to return in the response on each page. If additional items
exist beyond the number you specify, the NextToken element is sent in
the response. Use this NextToken value in a subsequent request to
retrieve additional items.
ListCertificateAuthorities, listCertificateAuthorities_nextToken - Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of
the NextToken parameter from the response you just received.
$sel:resourceOwner:ListCertificateAuthorities', listCertificateAuthorities_resourceOwner - Use this parameter to filter the returned set of certificate authorities
based on their owner. The default is SELF.
data ListCertificateAuthoritiesResponse Source #
See: newListCertificateAuthoritiesResponse smart constructor.
Constructors
| ListCertificateAuthoritiesResponse' (Maybe [CertificateAuthority]) (Maybe Text) Int |
Instances
newListCertificateAuthoritiesResponse Source #
Arguments
| :: Int | |
| -> ListCertificateAuthoritiesResponse |
Create a value of ListCertificateAuthoritiesResponse 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:certificateAuthorities:ListCertificateAuthoritiesResponse', listCertificateAuthoritiesResponse_certificateAuthorities - Summary information about each certificate authority you have created.
ListCertificateAuthorities, listCertificateAuthoritiesResponse_nextToken - When the list is truncated, this value is present and should be used for
the NextToken parameter in a subsequent pagination request.
$sel:httpStatus:ListCertificateAuthoritiesResponse', listCertificateAuthoritiesResponse_httpStatus - The response's http status code.
ListPermissions (Paginated)
data ListPermissions Source #
See: newListPermissions smart constructor.
Instances
Arguments
| :: Text | |
| -> ListPermissions |
Create a value of ListPermissions 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:ListPermissions', listPermissions_maxResults - When paginating results, use this parameter to specify the maximum
number of items to return in the response. If additional items exist
beyond the number you specify, the NextToken element is sent in the
response. Use this NextToken value in a subsequent request to
retrieve additional items.
ListPermissions, listPermissions_nextToken - When paginating results, use this parameter in a subsequent request
after you receive a response with truncated results. Set it to the value
of NextToken from the response you just received.
ListPermissions, listPermissions_certificateAuthorityArn - The Amazon Resource Number (ARN) of the private CA to inspect. You can
find the ARN by calling the
ListCertificateAuthorities
action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
You can get a private CA's ARN by running the
ListCertificateAuthorities
action.
data ListPermissionsResponse Source #
See: newListPermissionsResponse smart constructor.
Constructors
| ListPermissionsResponse' (Maybe Text) (Maybe [Permission]) Int |
Instances
newListPermissionsResponse Source #
Create a value of ListPermissionsResponse 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:
ListPermissions, listPermissionsResponse_nextToken - When the list is truncated, this value is present and should be used for
the NextToken parameter in a subsequent pagination request.
$sel:permissions:ListPermissionsResponse', listPermissionsResponse_permissions - Summary information about each permission assigned by the specified
private CA, including the action enabled, the policy provided, and the
time of creation.
$sel:httpStatus:ListPermissionsResponse', listPermissionsResponse_httpStatus - The response's http status code.
ListTags (Paginated)
See: newListTags smart constructor.
Instances
Create a value of ListTags 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:ListTags', listTags_maxResults - Use this parameter when paginating results to specify the maximum number
of items to return in the response. If additional items exist beyond the
number you specify, the NextToken element is sent in the response.
Use this NextToken value in a subsequent request to retrieve
additional items.
ListTags, listTags_nextToken - Use this parameter when paginating results in a subsequent request after
you receive a response with truncated results. Set it to the value of
NextToken from the response you just received.
ListTags, listTags_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called the
CreateCertificateAuthority
action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
data ListTagsResponse Source #
See: newListTagsResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListTagsResponse |
Create a value of ListTagsResponse 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:
ListTags, listTagsResponse_nextToken - When the list is truncated, this value is present and should be used for
the NextToken parameter in a subsequent pagination request.
$sel:tags:ListTagsResponse', listTagsResponse_tags - The tags associated with your private CA.
$sel:httpStatus:ListTagsResponse', listTagsResponse_httpStatus - The response's http status code.
PutPolicy
See: newPutPolicy smart constructor.
Constructors
| PutPolicy' Text Text |
Instances
Create a value of PutPolicy 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:resourceArn:PutPolicy', putPolicy_resourceArn - The Amazon Resource Number (ARN) of the private CA to associate with the
policy. The ARN of the CA can be found by calling the
ListCertificateAuthorities
action.
PutPolicy, putPolicy_policy - The path and file name of a JSON-formatted IAM policy to attach to the
specified private CA resource. If this policy does not contain all
required statements or if it includes any statement that is not allowed,
the PutPolicy action returns an InvalidPolicyException. For
information about IAM policy and statement structure, see
Overview of JSON Policies.
data PutPolicyResponse Source #
See: newPutPolicyResponse smart constructor.
Constructors
| PutPolicyResponse' | |
Instances
newPutPolicyResponse :: PutPolicyResponse Source #
Create a value of PutPolicyResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RestoreCertificateAuthority
data RestoreCertificateAuthority Source #
See: newRestoreCertificateAuthority smart constructor.
Constructors
| RestoreCertificateAuthority' Text |
Instances
newRestoreCertificateAuthority Source #
Arguments
| :: Text | |
| -> RestoreCertificateAuthority |
Create a value of RestoreCertificateAuthority 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:
RestoreCertificateAuthority, restoreCertificateAuthority_certificateAuthorityArn - The Amazon Resource Name (ARN) that was returned when you called the
CreateCertificateAuthority
action. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
data RestoreCertificateAuthorityResponse Source #
See: newRestoreCertificateAuthorityResponse smart constructor.
Constructors
| RestoreCertificateAuthorityResponse' | |
Instances
newRestoreCertificateAuthorityResponse :: RestoreCertificateAuthorityResponse Source #
Create a value of RestoreCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RevokeCertificate
data RevokeCertificate Source #
See: newRevokeCertificate smart constructor.
Constructors
| RevokeCertificate' Text Text RevocationReason |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RevocationReason | |
| -> RevokeCertificate |
Create a value of RevokeCertificate 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:
RevokeCertificate, revokeCertificate_certificateAuthorityArn - Amazon Resource Name (ARN) of the private CA that issued the certificate
to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
$sel:certificateSerial:RevokeCertificate', revokeCertificate_certificateSerial - Serial number of the certificate to be revoked. This must be in
hexadecimal format. You can retrieve the serial number by calling
GetCertificate
with the Amazon Resource Name (ARN) of the certificate you want and the
ARN of your private CA. The GetCertificate action retrieves the
certificate in the PEM format. You can use the following OpenSSL command
to list the certificate in text format and copy the hexadecimal serial
number.
openssl x509 -in file_path -text -noout
You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.
$sel:revocationReason:RevokeCertificate', revokeCertificate_revocationReason - Specifies why you revoked the certificate.
data RevokeCertificateResponse Source #
See: newRevokeCertificateResponse smart constructor.
Constructors
| RevokeCertificateResponse' | |
Instances
newRevokeCertificateResponse :: RevokeCertificateResponse Source #
Create a value of RevokeCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagCertificateAuthority
data TagCertificateAuthority Source #
See: newTagCertificateAuthority smart constructor.
Constructors
| TagCertificateAuthority' Text (NonEmpty Tag) |
Instances
newTagCertificateAuthority Source #
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> TagCertificateAuthority |
Create a value of TagCertificateAuthority 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:
TagCertificateAuthority, tagCertificateAuthority_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:tags:TagCertificateAuthority', tagCertificateAuthority_tags - List of tags to be associated with the CA.
data TagCertificateAuthorityResponse Source #
See: newTagCertificateAuthorityResponse smart constructor.
Constructors
| TagCertificateAuthorityResponse' | |
Instances
newTagCertificateAuthorityResponse :: TagCertificateAuthorityResponse Source #
Create a value of TagCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagCertificateAuthority
data UntagCertificateAuthority Source #
See: newUntagCertificateAuthority smart constructor.
Constructors
| UntagCertificateAuthority' Text (NonEmpty Tag) |
Instances
newUntagCertificateAuthority Source #
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> UntagCertificateAuthority |
Create a value of UntagCertificateAuthority 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:
UntagCertificateAuthority, untagCertificateAuthority_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:tags:UntagCertificateAuthority', untagCertificateAuthority_tags - List of tags to be removed from the CA.
data UntagCertificateAuthorityResponse Source #
See: newUntagCertificateAuthorityResponse smart constructor.
Constructors
| UntagCertificateAuthorityResponse' | |
Instances
newUntagCertificateAuthorityResponse :: UntagCertificateAuthorityResponse Source #
Create a value of UntagCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateCertificateAuthority
data UpdateCertificateAuthority Source #
See: newUpdateCertificateAuthority smart constructor.
Constructors
| UpdateCertificateAuthority' (Maybe RevocationConfiguration) (Maybe CertificateAuthorityStatus) Text |
Instances
newUpdateCertificateAuthority Source #
Arguments
| :: Text | |
| -> UpdateCertificateAuthority |
Create a value of UpdateCertificateAuthority 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:
UpdateCertificateAuthority, updateCertificateAuthority_revocationConfiguration - Contains information to enable Online Certificate Status Protocol (OCSP)
support, to enable a certificate revocation list (CRL), to enable both,
or to enable neither. If this parameter is not supplied, existing
capibilites remain unchanged. For more information, see the
OcspConfiguration
and
CrlConfiguration
types.
The following requirements apply to revocation configurations.
- A configuration disabling CRLs or OCSP must contain only the
Enabled=Falseparameter, and will fail if other parameters such asCustomCnameorExpirationInDaysare included. - In a CRL configuration, the
S3BucketNameparameter must conform to Amazon S3 bucket naming rules. - A configuration containing a custom Canonical Name (CNAME) parameter for CRLs or OCSP must conform to RFC2396 restrictions on the use of special characters in a CNAME.
- In a CRL or OCSP configuration, the value of a CNAME parameter must not include a protocol prefix such as "http://" or "https://".
UpdateCertificateAuthority, updateCertificateAuthority_status - Status of your private CA.
UpdateCertificateAuthority, updateCertificateAuthority_certificateAuthorityArn - Amazon Resource Name (ARN) of the private CA that issued the certificate
to be revoked. This must be of the form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
data UpdateCertificateAuthorityResponse Source #
See: newUpdateCertificateAuthorityResponse smart constructor.
Constructors
| UpdateCertificateAuthorityResponse' | |
Instances
newUpdateCertificateAuthorityResponse :: UpdateCertificateAuthorityResponse Source #
Create a value of UpdateCertificateAuthorityResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
AccessMethodType
newtype AccessMethodType Source #
Constructors
| AccessMethodType' | |
Fields | |
Bundled Patterns
| pattern AccessMethodType_CA_REPOSITORY :: AccessMethodType | |
| pattern AccessMethodType_RESOURCE_PKI_MANIFEST :: AccessMethodType | |
| pattern AccessMethodType_RESOURCE_PKI_NOTIFY :: AccessMethodType |
Instances
ActionType
newtype ActionType Source #
Constructors
| ActionType' | |
Fields | |
Bundled Patterns
| pattern ActionType_GetCertificate :: ActionType | |
| pattern ActionType_IssueCertificate :: ActionType | |
| pattern ActionType_ListPermissions :: ActionType |
Instances
AuditReportResponseFormat
newtype AuditReportResponseFormat Source #
Constructors
| AuditReportResponseFormat' | |
Fields | |
Bundled Patterns
| pattern AuditReportResponseFormat_CSV :: AuditReportResponseFormat | |
| pattern AuditReportResponseFormat_JSON :: AuditReportResponseFormat |
Instances
AuditReportStatus
newtype AuditReportStatus Source #
Constructors
| AuditReportStatus' | |
Fields | |
Bundled Patterns
| pattern AuditReportStatus_CREATING :: AuditReportStatus | |
| pattern AuditReportStatus_FAILED :: AuditReportStatus | |
| pattern AuditReportStatus_SUCCESS :: AuditReportStatus |
Instances
CertificateAuthorityStatus
newtype CertificateAuthorityStatus Source #
Constructors
| CertificateAuthorityStatus' | |
Fields | |
Bundled Patterns
Instances
CertificateAuthorityType
newtype CertificateAuthorityType Source #
Constructors
| CertificateAuthorityType' | |
Fields | |
Bundled Patterns
| pattern CertificateAuthorityType_ROOT :: CertificateAuthorityType | |
| pattern CertificateAuthorityType_SUBORDINATE :: CertificateAuthorityType |
Instances
CertificateAuthorityUsageMode
newtype CertificateAuthorityUsageMode Source #
Constructors
| CertificateAuthorityUsageMode' | |
Fields | |
Bundled Patterns
| pattern CertificateAuthorityUsageMode_GENERAL_PURPOSE :: CertificateAuthorityUsageMode | |
| pattern CertificateAuthorityUsageMode_SHORT_LIVED_CERTIFICATE :: CertificateAuthorityUsageMode |
Instances
ExtendedKeyUsageType
newtype ExtendedKeyUsageType Source #
Constructors
| ExtendedKeyUsageType' | |
Fields | |
Bundled Patterns
Instances
FailureReason
newtype FailureReason Source #
Constructors
| FailureReason' | |
Fields | |
Bundled Patterns
| pattern FailureReason_OTHER :: FailureReason | |
| pattern FailureReason_REQUEST_TIMED_OUT :: FailureReason | |
| pattern FailureReason_UNSUPPORTED_ALGORITHM :: FailureReason |
Instances
KeyAlgorithm
newtype KeyAlgorithm Source #
Constructors
| KeyAlgorithm' | |
Fields | |
Bundled Patterns
| pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm |
Instances
KeyStorageSecurityStandard
newtype KeyStorageSecurityStandard Source #
Constructors
| KeyStorageSecurityStandard' | |
Fields | |
Bundled Patterns
| pattern KeyStorageSecurityStandard_FIPS_140_2_LEVEL_2_OR_HIGHER :: KeyStorageSecurityStandard | |
| pattern KeyStorageSecurityStandard_FIPS_140_2_LEVEL_3_OR_HIGHER :: KeyStorageSecurityStandard |
Instances
PolicyQualifierId
newtype PolicyQualifierId Source #
Constructors
| PolicyQualifierId' | |
Fields | |
Bundled Patterns
| pattern PolicyQualifierId_CPS :: PolicyQualifierId |
Instances
ResourceOwner
newtype ResourceOwner Source #
Constructors
| ResourceOwner' | |
Fields | |
Bundled Patterns
| pattern ResourceOwner_OTHER_ACCOUNTS :: ResourceOwner | |
| pattern ResourceOwner_SELF :: ResourceOwner |
Instances
RevocationReason
newtype RevocationReason Source #
Constructors
| RevocationReason' | |
Fields | |
Bundled Patterns
| pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason | |
| pattern RevocationReason_A_A_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CERTIFICATE_AUTHORITY_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason | |
| pattern RevocationReason_KEY_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason | |
| pattern RevocationReason_SUPERSEDED :: RevocationReason | |
| pattern RevocationReason_UNSPECIFIED :: RevocationReason |
Instances
S3ObjectAcl
newtype S3ObjectAcl Source #
Constructors
| S3ObjectAcl' | |
Fields | |
Bundled Patterns
| pattern S3ObjectAcl_BUCKET_OWNER_FULL_CONTROL :: S3ObjectAcl | |
| pattern S3ObjectAcl_PUBLIC_READ :: S3ObjectAcl |
Instances
SigningAlgorithm
newtype SigningAlgorithm Source #
Constructors
| SigningAlgorithm' | |
Fields | |
Bundled Patterns
| pattern SigningAlgorithm_SHA256WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA256WITHRSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA384WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA384WITHRSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA512WITHECDSA :: SigningAlgorithm | |
| pattern SigningAlgorithm_SHA512WITHRSA :: SigningAlgorithm |
Instances
ValidityPeriodType
newtype ValidityPeriodType Source #
Constructors
| ValidityPeriodType' | |
Fields | |
Bundled Patterns
| pattern ValidityPeriodType_ABSOLUTE :: ValidityPeriodType | |
| pattern ValidityPeriodType_DAYS :: ValidityPeriodType | |
| pattern ValidityPeriodType_END_DATE :: ValidityPeriodType | |
| pattern ValidityPeriodType_MONTHS :: ValidityPeriodType | |
| pattern ValidityPeriodType_YEARS :: ValidityPeriodType |
Instances
ASN1Subject
data ASN1Subject Source #
Contains information about the certificate subject. The Subject field
in the certificate identifies the entity that owns or controls the
public key in the certificate. The entity can be a user, computer,
device, or service. The Subject must contain an X.500 distinguished
name (DN). A DN is a sequence of relative distinguished names (RDNs).
The RDNs are separated by commas in the certificate.
See: newASN1Subject smart constructor.
Constructors
| ASN1Subject' (Maybe Text) (Maybe Text) (Maybe (NonEmpty CustomAttribute)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newASN1Subject :: ASN1Subject Source #
Create a value of ASN1Subject 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:commonName:ASN1Subject', aSN1Subject_commonName - For CA and end-entity certificates in a private PKI, the common name
(CN) can be any string within the length limit.
Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
$sel:country:ASN1Subject', aSN1Subject_country - Two-digit code that specifies the country in which the certificate
subject located.
$sel:customAttributes:ASN1Subject', aSN1Subject_customAttributes - Contains a sequence of one or more X.500 relative distinguished names
(RDNs), each of which consists of an object identifier (OID) and a
value. For more information, see NIST’s definition of
Object Identifier (OID).
Custom attributes cannot be used in combination with standard attributes.
$sel:distinguishedNameQualifier:ASN1Subject', aSN1Subject_distinguishedNameQualifier - Disambiguating information for the certificate subject.
$sel:generationQualifier:ASN1Subject', aSN1Subject_generationQualifier - Typically a qualifier appended to the name of an individual. Examples
include Jr. for junior, Sr. for senior, and III for third.
$sel:givenName:ASN1Subject', aSN1Subject_givenName - First name.
$sel:initials:ASN1Subject', aSN1Subject_initials - Concatenation that typically contains the first letter of the
GivenName, the first letter of the middle name if one exists, and
the first letter of the Surname.
$sel:locality:ASN1Subject', aSN1Subject_locality - The locality (such as a city or town) in which the certificate subject
is located.
$sel:organization:ASN1Subject', aSN1Subject_organization - Legal name of the organization with which the certificate subject is
affiliated.
$sel:organizationalUnit:ASN1Subject', aSN1Subject_organizationalUnit - A subdivision or unit of the organization (such as sales or finance)
with which the certificate subject is affiliated.
$sel:pseudonym:ASN1Subject', aSN1Subject_pseudonym - Typically a shortened version of a longer GivenName. For example,
Jonathan is often shortened to John. Elizabeth is often shortened to
Beth, Liz, or Eliza.
$sel:serialNumber:ASN1Subject', aSN1Subject_serialNumber - The certificate serial number.
$sel:state:ASN1Subject', aSN1Subject_state - State in which the subject of the certificate is located.
$sel:surname:ASN1Subject', aSN1Subject_surname - Family name. In the US and the UK, for example, the surname of an
individual is ordered last. In Asian cultures the surname is typically
ordered first.
$sel:title:ASN1Subject', aSN1Subject_title - A title such as Mr. or Ms., which is pre-pended to the name to refer
formally to the certificate subject.
AccessDescription
data AccessDescription Source #
Provides access information used by the authorityInfoAccess and
subjectInfoAccess extensions described in
RFC 5280.
See: newAccessDescription smart constructor.
Constructors
| AccessDescription' AccessMethod GeneralName |
Instances
Arguments
| :: AccessMethod | |
| -> GeneralName | |
| -> AccessDescription |
Create a value of AccessDescription 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:accessMethod:AccessDescription', accessDescription_accessMethod - The type and format of AccessDescription information.
$sel:accessLocation:AccessDescription', accessDescription_accessLocation - The location of AccessDescription information.
AccessMethod
data AccessMethod Source #
Describes the type and format of extension access. Only one of
CustomObjectIdentifier or AccessMethodType may be provided.
Providing both results in InvalidArgsException.
See: newAccessMethod smart constructor.
Constructors
| AccessMethod' (Maybe AccessMethodType) (Maybe Text) |
Instances
newAccessMethod :: AccessMethod Source #
Create a value of AccessMethod 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:accessMethodType:AccessMethod', accessMethod_accessMethodType - Specifies the AccessMethod.
$sel:customObjectIdentifier:AccessMethod', accessMethod_customObjectIdentifier - An object identifier (OID) specifying the AccessMethod. The OID must
satisfy the regular expression shown below. For more information, see
NIST's definition of
Object Identifier (OID).
ApiPassthrough
data ApiPassthrough Source #
Contains X.509 certificate information to be placed in an issued
certificate. An APIPassthrough or APICSRPassthrough template variant
must be selected, or else this parameter is ignored.
If conflicting or duplicate certificate information is supplied from other sources, Amazon Web Services Private CA applies order of operation rules to determine what information is used.
See: newApiPassthrough smart constructor.
Constructors
| ApiPassthrough' (Maybe Extensions) (Maybe ASN1Subject) |
Instances
newApiPassthrough :: ApiPassthrough Source #
Create a value of ApiPassthrough 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:extensions:ApiPassthrough', apiPassthrough_extensions - Specifies X.509 extension information for a certificate.
$sel:subject:ApiPassthrough', apiPassthrough_subject - Undocumented member.
CertificateAuthority
data CertificateAuthority Source #
Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the __Subject Public Key Info__ field. Call the CreateCertificateAuthority action to create your private CA. You must then call the GetCertificateAuthorityCertificate action to retrieve a private CA certificate signing request (CSR). Sign the CSR with your Amazon Web Services Private CA-hosted or on-premises root or subordinate CA certificate. Call the ImportCertificateAuthorityCertificate action to import the signed certificate into Certificate Manager (ACM).
See: newCertificateAuthority smart constructor.
Constructors
Instances
newCertificateAuthority :: CertificateAuthority Source #
Create a value of CertificateAuthority 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:arn:CertificateAuthority', certificateAuthority_arn - Amazon Resource Name (ARN) for your private certificate authority (CA).
The format is 12345678-1234-1234-1234-123456789012 .
$sel:certificateAuthorityConfiguration:CertificateAuthority', certificateAuthority_certificateAuthorityConfiguration - Your private CA configuration.
$sel:createdAt:CertificateAuthority', certificateAuthority_createdAt - Date and time at which your private CA was created.
$sel:failureReason:CertificateAuthority', certificateAuthority_failureReason - Reason the request to create your private CA failed.
$sel:keyStorageSecurityStandard:CertificateAuthority', certificateAuthority_keyStorageSecurityStandard - Defines a cryptographic key management compliance standard used for
handling CA keys.
Default: FIPS_140_2_LEVEL_3_OR_HIGHER
Note: Amazon Web Services Region ap-northeast-3 supports only
FIPS_140_2_LEVEL_2_OR_HIGHER. You must explicitly specify this parameter
and value when creating a CA in that Region. Specifying a different
value (or no value) results in an InvalidArgsException with the
message "A certificate authority cannot be created in this region with
the specified security standard."
$sel:lastStateChangeAt:CertificateAuthority', certificateAuthority_lastStateChangeAt - Date and time at which your private CA was last updated.
$sel:notAfter:CertificateAuthority', certificateAuthority_notAfter - Date and time after which your private CA certificate is not valid.
$sel:notBefore:CertificateAuthority', certificateAuthority_notBefore - Date and time before which your private CA certificate is not valid.
$sel:ownerAccount:CertificateAuthority', certificateAuthority_ownerAccount - The Amazon Web Services account ID that owns the certificate authority.
$sel:restorableUntil:CertificateAuthority', certificateAuthority_restorableUntil - The period during which a deleted CA can be restored. For more
information, see the PermanentDeletionTimeInDays parameter of the
DeleteCertificateAuthorityRequest
action.
$sel:revocationConfiguration:CertificateAuthority', certificateAuthority_revocationConfiguration - Information about the Online Certificate Status Protocol (OCSP)
configuration or certificate revocation list (CRL) created and
maintained by your private CA.
$sel:serial:CertificateAuthority', certificateAuthority_serial - Serial number of your private CA.
$sel:status:CertificateAuthority', certificateAuthority_status - Status of your private CA.
$sel:type':CertificateAuthority', certificateAuthority_type - Type of your private CA.
$sel:usageMode:CertificateAuthority', certificateAuthority_usageMode - Specifies whether the CA issues general-purpose certificates that
typically require a revocation mechanism, or short-lived certificates
that may optionally omit revocation because they expire quickly.
Short-lived certificate validity is limited to seven days.
The default value is GENERAL_PURPOSE.
CertificateAuthorityConfiguration
data CertificateAuthorityConfiguration Source #
Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate. It also includes the signature algorithm that it uses when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority action.
See: newCertificateAuthorityConfiguration smart constructor.
Constructors
| CertificateAuthorityConfiguration' (Maybe CsrExtensions) KeyAlgorithm SigningAlgorithm ASN1Subject |
Instances
newCertificateAuthorityConfiguration Source #
Arguments
| :: KeyAlgorithm | |
| -> SigningAlgorithm | |
| -> ASN1Subject | |
| -> CertificateAuthorityConfiguration |
Create a value of CertificateAuthorityConfiguration 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:csrExtensions:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_csrExtensions - Specifies information to be added to the extension section of the
certificate signing request (CSR).
$sel:keyAlgorithm:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_keyAlgorithm - Type of the public key algorithm and size, in bits, of the key pair that
your CA creates when it issues a certificate. When you create a
subordinate CA, you must use a key algorithm supported by the parent CA.
$sel:signingAlgorithm:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_signingAlgorithm - Name of the algorithm your private CA uses to sign certificate requests.
This parameter should not be confused with the SigningAlgorithm
parameter used to sign certificates when they are issued.
$sel:subject:CertificateAuthorityConfiguration', certificateAuthorityConfiguration_subject - Structure that contains X.500 distinguished name information for your
private CA.
CrlConfiguration
data CrlConfiguration Source #
Contains configuration information for a certificate revocation list
(CRL). Your private certificate authority (CA) creates base CRLs. Delta
CRLs are not supported. You can enable CRLs for your new or an existing
private CA by setting the Enabled parameter to true. Your private
CA writes CRLs to an S3 bucket that you specify in the S3BucketName
parameter. You can hide the name of your bucket by specifying a value
for the CustomCname parameter. Your private CA copies the CNAME or
the S3 bucket name to the CRL Distribution Points extension of each
certificate it issues. Your S3 bucket policy must give write permission
to Amazon Web Services Private CA.
Amazon Web Services Private CA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your CRLs.
Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed prior to a certificate's expiration date or when a certificate is revoked. When a certificate is revoked, it appears in the CRL until the certificate expires, and then in one additional CRL after expiration, and it always appears in the audit report.
A CRL is typically updated approximately 30 minutes after a certificate is revoked. If for any reason a CRL update fails, Amazon Web Services Private CA makes further attempts every 15 minutes.
CRLs contain the following fields:
- Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1.
- Signature Algorithm: The name of the algorithm used to sign the CRL.
- Issuer: The X.500 distinguished name of your private CA that issued the CRL.
- Last Update: The issue date and time of this CRL.
- Next Update: The day and time by which the next CRL will be issued.
Revoked Certificates: List of revoked certificates. Each list item contains the following information.
- Serial Number: The serial number, in hexadecimal format, of the revoked certificate.
- Revocation Date: Date and time the certificate was revoked.
CRL Entry Extensions: Optional extensions for the CRL entry.
- X509v3 CRL Reason Code: Reason the certificate was revoked.
CRL Extensions: Optional extensions for the CRL.
- X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate.
- X509v3 CRL Number:: Decimal sequence number for the CRL.
- Signature Algorithm: Algorithm used by your private CA to sign the CRL.
- Signature Value: Signature computed over the CRL.
Certificate revocation lists created by Amazon Web Services Private CA are DER-encoded. You can use the following OpenSSL command to list a CRL.
openssl crl -inform DER -text -in crl_path -noout
For more information, see Planning a certificate revocation list (CRL) in the Amazon Web Services Private Certificate Authority User Guide
See: newCrlConfiguration smart constructor.
Constructors
| CrlConfiguration' (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe S3ObjectAcl) Bool |
Instances
Arguments
| :: Bool | |
| -> CrlConfiguration |
Create a value of CrlConfiguration 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:customCname:CrlConfiguration', crlConfiguration_customCname - Name inserted into the certificate CRL Distribution Points extension
that enables the use of an alias for the CRL distribution point. Use
this value if you don't want the name of your S3 bucket to be public.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
$sel:expirationInDays:CrlConfiguration', crlConfiguration_expirationInDays - Validity period of the CRL in days.
$sel:s3BucketName:CrlConfiguration', crlConfiguration_s3BucketName - Name of the S3 bucket that contains the CRL. If you do not provide a
value for the CustomCname argument, the name of your S3 bucket is
placed into the CRL Distribution Points extension of the issued
certificate. You can change the name of your bucket by calling the
UpdateCertificateAuthority
operation. You must specify a
bucket policy
that allows Amazon Web Services Private CA to write the CRL to your
bucket.
The S3BucketName parameter must conform to the
S3 bucket naming rules.
$sel:s3ObjectAcl:CrlConfiguration', crlConfiguration_s3ObjectAcl - Determines whether the CRL will be publicly readable or privately held
in the CRL Amazon S3 bucket. If you choose PUBLIC_READ, the CRL will be
accessible over the public internet. If you choose
BUCKET_OWNER_FULL_CONTROL, only the owner of the CRL S3 bucket can
access the CRL, and your PKI clients may need an alternative method of
access.
If no value is specified, the default is PUBLIC_READ.
Note: This default can cause CA creation to fail in some
circumstances. If you have have enabled the Block Public Access (BPA)
feature in your S3 account, then you must specify the value of this
parameter as BUCKET_OWNER_FULL_CONTROL, and not doing so results in an
error. If you have disabled BPA in S3, then you can specify either
BUCKET_OWNER_FULL_CONTROL or PUBLIC_READ as the value.
For more information, see Blocking public access to the S3 bucket.
$sel:enabled:CrlConfiguration', crlConfiguration_enabled - Boolean value that specifies whether certificate revocation lists (CRLs)
are enabled. You can use this value to enable certificate revocation for
a new CA when you call the
CreateCertificateAuthority
action or for an existing CA when you call the
UpdateCertificateAuthority
action.
CsrExtensions
data CsrExtensions Source #
Describes the certificate extensions to be added to the certificate signing request (CSR).
See: newCsrExtensions smart constructor.
Constructors
| CsrExtensions' (Maybe KeyUsage) (Maybe [AccessDescription]) |
Instances
newCsrExtensions :: CsrExtensions Source #
Create a value of CsrExtensions 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:keyUsage:CsrExtensions', csrExtensions_keyUsage - Indicates the purpose of the certificate and of the key contained in the
certificate.
$sel:subjectInformationAccess:CsrExtensions', csrExtensions_subjectInformationAccess - For CA certificates, provides a path to additional information
pertaining to the CA, such as revocation and policy. For more
information, see
Subject Information Access
in RFC 5280.
CustomAttribute
data CustomAttribute Source #
Defines the X.500 relative distinguished name (RDN).
See: newCustomAttribute smart constructor.
Constructors
| CustomAttribute' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CustomAttribute |
Create a value of CustomAttribute 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:objectIdentifier:CustomAttribute', customAttribute_objectIdentifier - Specifies the object identifier (OID) of the attribute type of the
relative distinguished name (RDN).
$sel:value:CustomAttribute', customAttribute_value - Specifies the attribute value of relative distinguished name (RDN).
CustomExtension
data CustomExtension Source #
Specifies the X.509 extension information for a certificate.
Extensions present in CustomExtensions follow the ApiPassthrough
template rules.
See: newCustomExtension smart constructor.
Constructors
| CustomExtension' (Maybe Bool) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> CustomExtension |
Create a value of CustomExtension 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:critical:CustomExtension', customExtension_critical - Specifies the critical flag of the X.509 extension.
$sel:objectIdentifier:CustomExtension', customExtension_objectIdentifier - Specifies the object identifier (OID) of the X.509 extension. For more
information, see the
Global OID reference database.
$sel:value:CustomExtension', customExtension_value - Specifies the base64-encoded value of the X.509 extension.
EdiPartyName
data EdiPartyName Source #
Describes an Electronic Data Interchange (EDI) entity as described in as defined in Subject Alternative Name in RFC 5280.
See: newEdiPartyName smart constructor.
Constructors
| EdiPartyName' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> EdiPartyName |
Create a value of EdiPartyName 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:nameAssigner:EdiPartyName', ediPartyName_nameAssigner - Specifies the name assigner.
$sel:partyName:EdiPartyName', ediPartyName_partyName - Specifies the party name.
ExtendedKeyUsage
data ExtendedKeyUsage Source #
Specifies additional purposes for which the certified public key may be
used other than basic purposes indicated in the KeyUsage extension.
See: newExtendedKeyUsage smart constructor.
Constructors
| ExtendedKeyUsage' (Maybe Text) (Maybe ExtendedKeyUsageType) |
Instances
newExtendedKeyUsage :: ExtendedKeyUsage Source #
Create a value of ExtendedKeyUsage 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:extendedKeyUsageObjectIdentifier:ExtendedKeyUsage', extendedKeyUsage_extendedKeyUsageObjectIdentifier - Specifies a custom ExtendedKeyUsage with an object identifier (OID).
$sel:extendedKeyUsageType:ExtendedKeyUsage', extendedKeyUsage_extendedKeyUsageType - Specifies a standard ExtendedKeyUsage as defined as in
RFC 5280.
Extensions
data Extensions Source #
Contains X.509 extension information for a certificate.
See: newExtensions smart constructor.
Constructors
| Extensions' (Maybe (NonEmpty PolicyInformation)) (Maybe (NonEmpty CustomExtension)) (Maybe (NonEmpty ExtendedKeyUsage)) (Maybe KeyUsage) (Maybe (NonEmpty GeneralName)) |
Instances
newExtensions :: Extensions Source #
Create a value of Extensions 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:certificatePolicies:Extensions', extensions_certificatePolicies - Contains a sequence of one or more policy information terms, each of
which consists of an object identifier (OID) and optional qualifiers.
For more information, see NIST's definition of
Object Identifier (OID).
In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
$sel:customExtensions:Extensions', extensions_customExtensions - Contains a sequence of one or more X.509 extensions, each of which
consists of an object identifier (OID), a base64-encoded value, and the
critical flag. For more information, see the
Global OID reference database.
$sel:extendedKeyUsage:Extensions', extensions_extendedKeyUsage - Specifies additional purposes for which the certified public key may be
used other than basic purposes indicated in the KeyUsage extension.
$sel:keyUsage:Extensions', extensions_keyUsage - Undocumented member.
$sel:subjectAlternativeNames:Extensions', extensions_subjectAlternativeNames - The subject alternative name extension allows identities to be bound to
the subject of the certificate. These identities may be included in
addition to or in place of the identity in the subject field of the
certificate.
GeneralName
data GeneralName Source #
Describes an ASN.1 X.400 GeneralName as defined in
RFC 5280. Only one of
the following naming options should be provided. Providing more than one
option results in an InvalidArgsException error.
See: newGeneralName smart constructor.
Constructors
| GeneralName' (Maybe ASN1Subject) (Maybe Text) (Maybe EdiPartyName) (Maybe Text) (Maybe OtherName) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newGeneralName :: GeneralName Source #
Create a value of GeneralName 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:directoryName:GeneralName', generalName_directoryName - Undocumented member.
$sel:dnsName:GeneralName', generalName_dnsName - Represents GeneralName as a DNS name.
$sel:ediPartyName:GeneralName', generalName_ediPartyName - Represents GeneralName as an EdiPartyName object.
$sel:ipAddress:GeneralName', generalName_ipAddress - Represents GeneralName as an IPv4 or IPv6 address.
$sel:otherName:GeneralName', generalName_otherName - Represents GeneralName using an OtherName object.
$sel:registeredId:GeneralName', generalName_registeredId - Represents GeneralName as an object identifier (OID).
$sel:rfc822Name:GeneralName', generalName_rfc822Name - Represents GeneralName as an
RFC 822 email address.
$sel:uniformResourceIdentifier:GeneralName', generalName_uniformResourceIdentifier - Represents GeneralName as a URI.
KeyUsage
Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
See: newKeyUsage smart constructor.
Constructors
| KeyUsage' (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) |
Instances
newKeyUsage :: KeyUsage Source #
Create a value of KeyUsage 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:cRLSign:KeyUsage', keyUsage_cRLSign - Key can be used to sign CRLs.
$sel:dataEncipherment:KeyUsage', keyUsage_dataEncipherment - Key can be used to decipher data.
$sel:decipherOnly:KeyUsage', keyUsage_decipherOnly - Key can be used only to decipher data.
$sel:digitalSignature:KeyUsage', keyUsage_digitalSignature - Key can be used for digital signing.
$sel:encipherOnly:KeyUsage', keyUsage_encipherOnly - Key can be used only to encipher data.
$sel:keyAgreement:KeyUsage', keyUsage_keyAgreement - Key can be used in a key-agreement protocol.
$sel:keyCertSign:KeyUsage', keyUsage_keyCertSign - Key can be used to sign certificates.
$sel:keyEncipherment:KeyUsage', keyUsage_keyEncipherment - Key can be used to encipher data.
$sel:nonRepudiation:KeyUsage', keyUsage_nonRepudiation - Key can be used for non-repudiation.
OcspConfiguration
data OcspConfiguration Source #
Contains information to enable and configure Online Certificate Status Protocol (OCSP) for validating certificate revocation status.
When you revoke a certificate, OCSP responses may take up to 60 minutes to reflect the new status.
See: newOcspConfiguration smart constructor.
Constructors
| OcspConfiguration' (Maybe Text) Bool |
Instances
Arguments
| :: Bool | |
| -> OcspConfiguration |
Create a value of OcspConfiguration 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:ocspCustomCname:OcspConfiguration', ocspConfiguration_ocspCustomCname - By default, Amazon Web Services Private CA injects an Amazon Web
Services domain into certificates being validated by the Online
Certificate Status Protocol (OCSP). A customer can alternatively use
this object to define a CNAME specifying a customized OCSP domain.
The content of a Canonical Name (CNAME) record must conform to RFC2396 restrictions on the use of special characters in URIs. Additionally, the value of the CNAME must not include a protocol prefix such as "http://" or "https://".
For more information, see Customizing Online Certificate Status Protocol (OCSP) in the Amazon Web Services Private Certificate Authority User Guide.
$sel:enabled:OcspConfiguration', ocspConfiguration_enabled - Flag enabling use of the Online Certificate Status Protocol (OCSP) for
validating certificate revocation status.
OtherName
Defines a custom ASN.1 X.400 GeneralName using an object identifier
(OID) and value. The OID must satisfy the regular expression shown
below. For more information, see NIST's definition of
Object Identifier (OID).
See: newOtherName smart constructor.
Constructors
| OtherName' Text Text |
Instances
| FromJSON OtherName Source # | |
| ToJSON OtherName Source # | |
| Generic OtherName Source # | |
| Read OtherName Source # | |
| Show OtherName Source # | |
| NFData OtherName Source # | |
| Eq OtherName Source # | |
| Hashable OtherName Source # | |
| type Rep OtherName Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.OtherName type Rep OtherName = D1 ('MetaData "OtherName" "Amazonka.CertificateManagerPCA.Types.OtherName" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "OtherName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typeId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of OtherName 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:typeId:OtherName', otherName_typeId - Specifies an OID.
$sel:value:OtherName', otherName_value - Specifies an OID value.
Permission
data Permission Source #
Permissions designate which private CA actions can be performed by an
Amazon Web Services service or entity. In order for ACM to automatically
renew private certificates, you must give the ACM service principal all
available permissions (IssueCertificate, GetCertificate, and
ListPermissions). Permissions can be assigned with the
CreatePermission
action, removed with the
DeletePermission
action, and listed with the
ListPermissions
action.
See: newPermission smart constructor.
Constructors
| Permission' (Maybe (NonEmpty ActionType)) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newPermission :: Permission Source #
Create a value of Permission 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:actions:Permission', permission_actions - The private CA actions that can be performed by the designated Amazon
Web Services service.
$sel:certificateAuthorityArn:Permission', permission_certificateAuthorityArn - The Amazon Resource Number (ARN) of the private CA from which the
permission was issued.
$sel:createdAt:Permission', permission_createdAt - The time at which the permission was created.
$sel:policy:Permission', permission_policy - The name of the policy that is associated with the permission.
$sel:principal:Permission', permission_principal - The Amazon Web Services service or entity that holds the permission. At
this time, the only valid principal is acm.amazonaws.com.
$sel:sourceAccount:Permission', permission_sourceAccount - The ID of the account that assigned the permission.
PolicyInformation
data PolicyInformation Source #
Defines the X.509 CertificatePolicies extension.
See: newPolicyInformation smart constructor.
Constructors
| PolicyInformation' (Maybe (NonEmpty PolicyQualifierInfo)) Text |
Instances
Arguments
| :: Text | |
| -> PolicyInformation |
Create a value of PolicyInformation 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:policyQualifiers:PolicyInformation', policyInformation_policyQualifiers - Modifies the given CertPolicyId with a qualifier. Amazon Web Services
Private CA supports the certification practice statement (CPS)
qualifier.
$sel:certPolicyId:PolicyInformation', policyInformation_certPolicyId - Specifies the object identifier (OID) of the certificate policy under
which the certificate was issued. For more information, see NIST's
definition of
Object Identifier (OID).
PolicyQualifierInfo
data PolicyQualifierInfo Source #
Modifies the CertPolicyId of a PolicyInformation object with a
qualifier. Amazon Web Services Private CA supports the certification
practice statement (CPS) qualifier.
See: newPolicyQualifierInfo smart constructor.
Constructors
| PolicyQualifierInfo' PolicyQualifierId Qualifier |
Instances
newPolicyQualifierInfo Source #
Arguments
| :: PolicyQualifierId | |
| -> Qualifier | |
| -> PolicyQualifierInfo |
Create a value of PolicyQualifierInfo 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:policyQualifierId:PolicyQualifierInfo', policyQualifierInfo_policyQualifierId - Identifies the qualifier modifying a CertPolicyId.
$sel:qualifier:PolicyQualifierInfo', policyQualifierInfo_qualifier - Defines the qualifier type. Amazon Web Services Private CA supports the
use of a URI for a CPS qualifier in this field.
Qualifier
Defines a PolicyInformation qualifier. Amazon Web Services Private CA
supports the
certification practice statement (CPS) qualifier
defined in RFC 5280.
See: newQualifier smart constructor.
Constructors
| Qualifier' Text |
Instances
| ToJSON Qualifier Source # | |
| Generic Qualifier Source # | |
| Read Qualifier Source # | |
| Show Qualifier Source # | |
| NFData Qualifier Source # | |
| Eq Qualifier Source # | |
| Hashable Qualifier Source # | |
| type Rep Qualifier Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Qualifier type Rep Qualifier = D1 ('MetaData "Qualifier" "Amazonka.CertificateManagerPCA.Types.Qualifier" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Qualifier'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cpsUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Qualifier 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:cpsUri:Qualifier', qualifier_cpsUri - Contains a pointer to a certification practice statement (CPS) published
by the CA.
RevocationConfiguration
data RevocationConfiguration Source #
Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority actions. Your private certificate authority (CA) can configure Online Certificate Status Protocol (OCSP) support and/or maintain a certificate revocation list (CRL). OCSP returns validation information about certificates as requested by clients, and a CRL contains an updated list of certificates revoked by your CA. For more information, see RevokeCertificate and Setting up a certificate revocation method in the Amazon Web Services Private Certificate Authority User Guide.
See: newRevocationConfiguration smart constructor.
Constructors
| RevocationConfiguration' (Maybe CrlConfiguration) (Maybe OcspConfiguration) |
Instances
newRevocationConfiguration :: RevocationConfiguration Source #
Create a value of RevocationConfiguration 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:crlConfiguration:RevocationConfiguration', revocationConfiguration_crlConfiguration - Configuration of the certificate revocation list (CRL), if any,
maintained by your private CA. A CRL is typically updated approximately
30 minutes after a certificate is revoked. If for any reason a CRL
update fails, Amazon Web Services Private CA makes further attempts
every 15 minutes.
$sel:ocspConfiguration:RevocationConfiguration', revocationConfiguration_ocspConfiguration - Configuration of Online Certificate Status Protocol (OCSP) support, if
any, maintained by your private CA. When you revoke a certificate, OCSP
responses may take up to 60 minutes to reflect the new status.
Tag
Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority action. To remove a tag, call the UntagCertificateAuthority action.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CertificateManagerPCA.Types.Tag" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) | |
Create a value of Tag 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:value:Tag', tag_value - Value of the tag.
$sel:key:Tag', tag_key - Key (name) of the tag.
Validity
Validity specifies the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the validity of a certificate starts or expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280.
Amazon Web Services Private CA API consumes the Validity data type
differently in two distinct parameters of the IssueCertificate action.
The required parameter IssueCertificate:Validity specifies the end
of a certificate's validity period. The optional parameter
IssueCertificate:ValidityNotBefore specifies a customized starting
time for the validity period.
See: newValidity smart constructor.
Constructors
| Validity' Natural ValidityPeriodType |
Instances
| ToJSON Validity Source # | |
| Generic Validity Source # | |
| Read Validity Source # | |
| Show Validity Source # | |
| NFData Validity Source # | |
| Eq Validity Source # | |
| Hashable Validity Source # | |
| type Rep Validity Source # | |
Defined in Amazonka.CertificateManagerPCA.Types.Validity type Rep Validity = D1 ('MetaData "Validity" "Amazonka.CertificateManagerPCA.Types.Validity" "amazonka-certificatemanager-pca-2.0-BrCc8DEClV63rMSVXz2XYH" 'False) (C1 ('MetaCons "Validity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ValidityPeriodType))) | |
Create a value of Validity 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:value:Validity', validity_value - A long integer interpreted according to the value of Type, below.
$sel:type':Validity', validity_type - Determines how Amazon Web Services Private CA interprets the Value
parameter, an integer. Supported validity types include those listed
below. Type definitions with values include a sample input value and the
resulting output.
END_DATE: The specific date and time when the certificate will expire,
expressed using UTCTime (YYMMDDHHMMSS) or GeneralizedTime
(YYYYMMDDHHMMSS) format. When UTCTime is used, if the year field (YY) is
greater than or equal to 50, the year is interpreted as 19YY. If the
year field is less than 50, the year is interpreted as 20YY.
- Sample input value: 491231235959 (UTCTime format)
- Output expiration date/time: 12/31/2049 23:59:59
ABSOLUTE: The specific date and time when the validity of a
certificate will start or expire, expressed in seconds since the Unix
Epoch.
- Sample input value: 2524608000
- Output expiration date/time: 01/01/2050 00:00:00
DAYS, MONTHS, YEARS: The relative time from the moment of issuance
until the certificate will expire, expressed in days, months, or years.
Example if DAYS, issued on 10/12/2020 at 12:34:54 UTC:
- Sample input value: 90
- Output expiration date: 01/10/2020 12:34:54 UTC
The minimum validity duration for a certificate using relative time
(DAYS) is one day. The minimum validity for a certificate using
absolute time (ABSOLUTE or END_DATE) is one second.