| 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.CertificateManager
Contents
- Service Configuration
- Errors
- AccessDeniedException
- ConflictException
- InvalidArgsException
- InvalidArnException
- InvalidDomainValidationOptionsException
- InvalidParameterException
- InvalidStateException
- InvalidTagException
- LimitExceededException
- RequestInProgressException
- ResourceInUseException
- ResourceNotFoundException
- TagPolicyException
- ThrottlingException
- TooManyTagsException
- ValidationException
- Waiters
- Operations
- AddTagsToCertificate
- DeleteCertificate
- DescribeCertificate
- ExportCertificate
- GetAccountConfiguration
- GetCertificate
- ImportCertificate
- ListCertificates (Paginated)
- ListTagsForCertificate
- PutAccountConfiguration
- RemoveTagsFromCertificate
- RenewCertificate
- RequestCertificate
- ResendValidationEmail
- UpdateCertificateOptions
- Types
- CertificateStatus
- CertificateTransparencyLoggingPreference
- CertificateType
- DomainStatus
- ExtendedKeyUsageName
- FailureReason
- KeyAlgorithm
- KeyUsageName
- RecordType
- RenewalEligibility
- RenewalStatus
- RevocationReason
- SortBy
- SortOrder
- ValidationMethod
- CertificateDetail
- CertificateOptions
- CertificateSummary
- DomainValidation
- DomainValidationOption
- ExpiryEventsConfiguration
- ExtendedKeyUsage
- Filters
- KeyUsage
- RenewalSummary
- ResourceRecord
- Tag
Description
Derived from API version 2015-12-08 of the AWS service descriptions, licensed under Apache 2.0.
Certificate Manager
You can use Certificate Manager (ACM) to manage SSL/TLS certificates for your Amazon Web Services-based websites and applications. For more information about using ACM, see the Certificate Manager User Guide.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InvalidArgsException :: AsError a => Fold a ServiceError
- _InvalidArnException :: AsError a => Fold a ServiceError
- _InvalidDomainValidationOptionsException :: AsError a => Fold a ServiceError
- _InvalidParameterException :: AsError a => Fold a ServiceError
- _InvalidStateException :: AsError a => Fold a ServiceError
- _InvalidTagException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _RequestInProgressException :: AsError a => Fold a ServiceError
- _ResourceInUseException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _TagPolicyException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _TooManyTagsException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newCertificateValidated :: Wait DescribeCertificate
- data AddTagsToCertificate = AddTagsToCertificate' Text (NonEmpty Tag)
- newAddTagsToCertificate :: Text -> NonEmpty Tag -> AddTagsToCertificate
- data AddTagsToCertificateResponse = AddTagsToCertificateResponse' {
- newAddTagsToCertificateResponse :: AddTagsToCertificateResponse
- data DeleteCertificate = DeleteCertificate' Text
- newDeleteCertificate :: Text -> DeleteCertificate
- data DeleteCertificateResponse = DeleteCertificateResponse' {
- newDeleteCertificateResponse :: DeleteCertificateResponse
- data DescribeCertificate = DescribeCertificate' Text
- newDescribeCertificate :: Text -> DescribeCertificate
- data DescribeCertificateResponse = DescribeCertificateResponse' (Maybe CertificateDetail) Int
- newDescribeCertificateResponse :: Int -> DescribeCertificateResponse
- data ExportCertificate = ExportCertificate' Text (Sensitive Base64)
- newExportCertificate :: Text -> ByteString -> ExportCertificate
- data ExportCertificateResponse = ExportCertificateResponse' (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) Int
- newExportCertificateResponse :: Int -> ExportCertificateResponse
- data GetAccountConfiguration = GetAccountConfiguration' {
- newGetAccountConfiguration :: GetAccountConfiguration
- data GetAccountConfigurationResponse = GetAccountConfigurationResponse' (Maybe ExpiryEventsConfiguration) Int
- newGetAccountConfigurationResponse :: Int -> GetAccountConfigurationResponse
- data GetCertificate = GetCertificate' Text
- newGetCertificate :: Text -> GetCertificate
- data GetCertificateResponse = GetCertificateResponse' (Maybe Text) (Maybe Text) Int
- newGetCertificateResponse :: Int -> GetCertificateResponse
- data ImportCertificate = ImportCertificate' (Maybe Text) (Maybe Base64) (Maybe (NonEmpty Tag)) Base64 (Sensitive Base64)
- newImportCertificate :: ByteString -> ByteString -> ImportCertificate
- data ImportCertificateResponse = ImportCertificateResponse' (Maybe Text) Int
- newImportCertificateResponse :: Int -> ImportCertificateResponse
- data ListCertificates = ListCertificates' (Maybe [CertificateStatus]) (Maybe Filters) (Maybe Natural) (Maybe Text) (Maybe SortBy) (Maybe SortOrder)
- newListCertificates :: ListCertificates
- data ListCertificatesResponse = ListCertificatesResponse' (Maybe [CertificateSummary]) (Maybe Text) Int
- newListCertificatesResponse :: Int -> ListCertificatesResponse
- data ListTagsForCertificate = ListTagsForCertificate' Text
- newListTagsForCertificate :: Text -> ListTagsForCertificate
- data ListTagsForCertificateResponse = ListTagsForCertificateResponse' (Maybe (NonEmpty Tag)) Int
- newListTagsForCertificateResponse :: Int -> ListTagsForCertificateResponse
- data PutAccountConfiguration = PutAccountConfiguration' (Maybe ExpiryEventsConfiguration) Text
- newPutAccountConfiguration :: Text -> PutAccountConfiguration
- data PutAccountConfigurationResponse = PutAccountConfigurationResponse' {
- newPutAccountConfigurationResponse :: PutAccountConfigurationResponse
- data RemoveTagsFromCertificate = RemoveTagsFromCertificate' Text (NonEmpty Tag)
- newRemoveTagsFromCertificate :: Text -> NonEmpty Tag -> RemoveTagsFromCertificate
- data RemoveTagsFromCertificateResponse = RemoveTagsFromCertificateResponse' {
- newRemoveTagsFromCertificateResponse :: RemoveTagsFromCertificateResponse
- data RenewCertificate = RenewCertificate' Text
- newRenewCertificate :: Text -> RenewCertificate
- data RenewCertificateResponse = RenewCertificateResponse' {
- newRenewCertificateResponse :: RenewCertificateResponse
- data RequestCertificate = RequestCertificate' (Maybe Text) (Maybe (NonEmpty DomainValidationOption)) (Maybe Text) (Maybe KeyAlgorithm) (Maybe CertificateOptions) (Maybe (NonEmpty Text)) (Maybe (NonEmpty Tag)) (Maybe ValidationMethod) Text
- newRequestCertificate :: Text -> RequestCertificate
- data RequestCertificateResponse = RequestCertificateResponse' (Maybe Text) Int
- newRequestCertificateResponse :: Int -> RequestCertificateResponse
- data ResendValidationEmail = ResendValidationEmail' Text Text Text
- newResendValidationEmail :: Text -> Text -> Text -> ResendValidationEmail
- data ResendValidationEmailResponse = ResendValidationEmailResponse' {
- newResendValidationEmailResponse :: ResendValidationEmailResponse
- data UpdateCertificateOptions = UpdateCertificateOptions' Text CertificateOptions
- newUpdateCertificateOptions :: Text -> CertificateOptions -> UpdateCertificateOptions
- data UpdateCertificateOptionsResponse = UpdateCertificateOptionsResponse' {
- newUpdateCertificateOptionsResponse :: UpdateCertificateOptionsResponse
- newtype CertificateStatus where
- CertificateStatus' { }
- pattern CertificateStatus_EXPIRED :: CertificateStatus
- pattern CertificateStatus_FAILED :: CertificateStatus
- pattern CertificateStatus_INACTIVE :: CertificateStatus
- pattern CertificateStatus_ISSUED :: CertificateStatus
- pattern CertificateStatus_PENDING_VALIDATION :: CertificateStatus
- pattern CertificateStatus_REVOKED :: CertificateStatus
- pattern CertificateStatus_VALIDATION_TIMED_OUT :: CertificateStatus
- newtype CertificateTransparencyLoggingPreference where
- newtype CertificateType where
- CertificateType' { }
- pattern CertificateType_AMAZON_ISSUED :: CertificateType
- pattern CertificateType_IMPORTED :: CertificateType
- pattern CertificateType_PRIVATE :: CertificateType
- newtype DomainStatus where
- DomainStatus' { }
- pattern DomainStatus_FAILED :: DomainStatus
- pattern DomainStatus_PENDING_VALIDATION :: DomainStatus
- pattern DomainStatus_SUCCESS :: DomainStatus
- newtype ExtendedKeyUsageName where
- ExtendedKeyUsageName' { }
- pattern ExtendedKeyUsageName_ANY :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_CODE_SIGNING :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_CUSTOM :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_EMAIL_PROTECTION :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_IPSEC_END_SYSTEM :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_IPSEC_TUNNEL :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_IPSEC_USER :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_NONE :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_OCSP_SIGNING :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_TIME_STAMPING :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_TLS_WEB_CLIENT_AUTHENTICATION :: ExtendedKeyUsageName
- pattern ExtendedKeyUsageName_TLS_WEB_SERVER_AUTHENTICATION :: ExtendedKeyUsageName
- newtype FailureReason where
- FailureReason' { }
- pattern FailureReason_ADDITIONAL_VERIFICATION_REQUIRED :: FailureReason
- pattern FailureReason_CAA_ERROR :: FailureReason
- pattern FailureReason_DOMAIN_NOT_ALLOWED :: FailureReason
- pattern FailureReason_DOMAIN_VALIDATION_DENIED :: FailureReason
- pattern FailureReason_INVALID_PUBLIC_DOMAIN :: FailureReason
- pattern FailureReason_NO_AVAILABLE_CONTACTS :: FailureReason
- pattern FailureReason_OTHER :: FailureReason
- pattern FailureReason_PCA_ACCESS_DENIED :: FailureReason
- pattern FailureReason_PCA_INVALID_ARGS :: FailureReason
- pattern FailureReason_PCA_INVALID_ARN :: FailureReason
- pattern FailureReason_PCA_INVALID_DURATION :: FailureReason
- pattern FailureReason_PCA_INVALID_STATE :: FailureReason
- pattern FailureReason_PCA_LIMIT_EXCEEDED :: FailureReason
- pattern FailureReason_PCA_NAME_CONSTRAINTS_VALIDATION :: FailureReason
- pattern FailureReason_PCA_REQUEST_FAILED :: FailureReason
- pattern FailureReason_PCA_RESOURCE_NOT_FOUND :: FailureReason
- pattern FailureReason_SLR_NOT_FOUND :: FailureReason
- newtype KeyAlgorithm where
- KeyAlgorithm' { }
- pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm
- pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm
- pattern KeyAlgorithm_EC_secp521r1 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_1024 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_3072 :: KeyAlgorithm
- pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm
- newtype KeyUsageName where
- KeyUsageName' { }
- pattern KeyUsageName_ANY :: KeyUsageName
- pattern KeyUsageName_CERTIFICATE_SIGNING :: KeyUsageName
- pattern KeyUsageName_CRL_SIGNING :: KeyUsageName
- pattern KeyUsageName_CUSTOM :: KeyUsageName
- pattern KeyUsageName_DATA_ENCIPHERMENT :: KeyUsageName
- pattern KeyUsageName_DECIPHER_ONLY :: KeyUsageName
- pattern KeyUsageName_DIGITAL_SIGNATURE :: KeyUsageName
- pattern KeyUsageName_ENCIPHER_ONLY :: KeyUsageName
- pattern KeyUsageName_KEY_AGREEMENT :: KeyUsageName
- pattern KeyUsageName_KEY_ENCIPHERMENT :: KeyUsageName
- pattern KeyUsageName_NON_REPUDIATION :: KeyUsageName
- newtype RecordType where
- RecordType' { }
- pattern RecordType_CNAME :: RecordType
- newtype RenewalEligibility where
- newtype RenewalStatus where
- RenewalStatus' { }
- pattern RenewalStatus_FAILED :: RenewalStatus
- pattern RenewalStatus_PENDING_AUTO_RENEWAL :: RenewalStatus
- pattern RenewalStatus_PENDING_VALIDATION :: RenewalStatus
- pattern RenewalStatus_SUCCESS :: RenewalStatus
- newtype RevocationReason where
- RevocationReason' { }
- pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason
- pattern RevocationReason_A_A_COMPROMISE :: RevocationReason
- pattern RevocationReason_CA_COMPROMISE :: RevocationReason
- pattern RevocationReason_CERTIFICATE_HOLD :: RevocationReason
- pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason
- pattern RevocationReason_KEY_COMPROMISE :: RevocationReason
- pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason
- pattern RevocationReason_REMOVE_FROM_CRL :: RevocationReason
- pattern RevocationReason_SUPERCEDED :: RevocationReason
- pattern RevocationReason_UNSPECIFIED :: RevocationReason
- newtype SortBy where
- SortBy' {
- fromSortBy :: Text
- pattern SortBy_CREATED_AT :: SortBy
- SortBy' {
- newtype SortOrder where
- SortOrder' { }
- pattern SortOrder_ASCENDING :: SortOrder
- pattern SortOrder_DESCENDING :: SortOrder
- newtype ValidationMethod where
- ValidationMethod' { }
- pattern ValidationMethod_DNS :: ValidationMethod
- pattern ValidationMethod_EMAIL :: ValidationMethod
- data CertificateDetail = CertificateDetail' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DomainValidation)) (Maybe [ExtendedKeyUsage]) (Maybe FailureReason) (Maybe POSIX) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe KeyAlgorithm) (Maybe [KeyUsage]) (Maybe POSIX) (Maybe POSIX) (Maybe CertificateOptions) (Maybe RenewalEligibility) (Maybe RenewalSummary) (Maybe RevocationReason) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe CertificateStatus) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe CertificateType)
- newCertificateDetail :: CertificateDetail
- data CertificateOptions = CertificateOptions' (Maybe CertificateTransparencyLoggingPreference)
- newCertificateOptions :: CertificateOptions
- data CertificateSummary = CertificateSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe [ExtendedKeyUsageName]) (Maybe Bool) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe KeyAlgorithm) (Maybe [KeyUsageName]) (Maybe POSIX) (Maybe POSIX) (Maybe RenewalEligibility) (Maybe POSIX) (Maybe CertificateStatus) (Maybe (NonEmpty Text)) (Maybe CertificateType)
- newCertificateSummary :: CertificateSummary
- data DomainValidation = DomainValidation' (Maybe ResourceRecord) (Maybe Text) (Maybe [Text]) (Maybe ValidationMethod) (Maybe DomainStatus) Text
- newDomainValidation :: Text -> DomainValidation
- data DomainValidationOption = DomainValidationOption' Text Text
- newDomainValidationOption :: Text -> Text -> DomainValidationOption
- data ExpiryEventsConfiguration = ExpiryEventsConfiguration' (Maybe Natural)
- newExpiryEventsConfiguration :: ExpiryEventsConfiguration
- data ExtendedKeyUsage = ExtendedKeyUsage' (Maybe ExtendedKeyUsageName) (Maybe Text)
- newExtendedKeyUsage :: ExtendedKeyUsage
- data Filters = Filters' (Maybe [ExtendedKeyUsageName]) (Maybe [KeyAlgorithm]) (Maybe [KeyUsageName])
- newFilters :: Filters
- data KeyUsage = KeyUsage' (Maybe KeyUsageName)
- newKeyUsage :: KeyUsage
- data RenewalSummary = RenewalSummary' (Maybe FailureReason) RenewalStatus (NonEmpty DomainValidation) POSIX
- newRenewalSummary :: RenewalStatus -> NonEmpty DomainValidation -> UTCTime -> RenewalSummary
- data ResourceRecord = ResourceRecord' Text RecordType Text
- newResourceRecord :: Text -> RecordType -> Text -> ResourceRecord
- data Tag = Tag' (Maybe Text) Text
- newTag :: Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2015-12-08 of the Amazon Certificate Manager 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 CertificateManager.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have access required to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
You are trying to update a resource or configuration that is already being created or updated. Wait for the previous operation to finish and try again.
InvalidArgsException
_InvalidArgsException :: AsError a => Fold a ServiceError Source #
One or more of of request parameters specified is not valid.
InvalidArnException
_InvalidArnException :: AsError a => Fold a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
InvalidDomainValidationOptionsException
_InvalidDomainValidationOptionsException :: AsError a => Fold a ServiceError Source #
One or more values in the DomainValidationOption structure is incorrect.
InvalidParameterException
_InvalidParameterException :: AsError a => Fold a ServiceError Source #
An input parameter was invalid.
InvalidStateException
_InvalidStateException :: AsError a => Fold a ServiceError Source #
Processing has reached an invalid state.
InvalidTagException
_InvalidTagException :: AsError a => Fold a ServiceError Source #
One or both of the values that make up the key-value pair is not valid.
For example, you cannot specify a tag value that begins with aws:.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
An ACM quota has been exceeded.
RequestInProgressException
_RequestInProgressException :: AsError a => Fold a ServiceError Source #
The certificate request is in process and the certificate in your account has not yet been issued.
ResourceInUseException
_ResourceInUseException :: AsError a => Fold a ServiceError Source #
The certificate is in use by another Amazon Web Services service in the caller's account. Remove the association and try again.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
The specified certificate cannot be found in the caller's account or the caller's account cannot be found.
TagPolicyException
_TagPolicyException :: AsError a => Fold a ServiceError Source #
A specified tag did not comply with an existing tag policy and was rejected.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied because it exceeded a quota.
TooManyTagsException
_TooManyTagsException :: AsError a => Fold a ServiceError Source #
The request contains too many tags. Try the request again with fewer tags.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The supplied input failed to satisfy constraints of an Amazon Web Services service.
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.
CertificateValidated
newCertificateValidated :: Wait DescribeCertificate Source #
Polls DescribeCertificate every 60 seconds until a successful state is reached. An error is returned after 40 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.
AddTagsToCertificate
data AddTagsToCertificate Source #
See: newAddTagsToCertificate smart constructor.
Constructors
| AddTagsToCertificate' Text (NonEmpty Tag) |
Instances
newAddTagsToCertificate Source #
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> AddTagsToCertificate |
Create a value of AddTagsToCertificate 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:
AddTagsToCertificate, addTagsToCertificate_certificateArn - String that contains the ARN of the ACM certificate to which the tag is
to be applied. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
$sel:tags:AddTagsToCertificate', addTagsToCertificate_tags - The key-value pair that defines the tag. The tag value is optional.
data AddTagsToCertificateResponse Source #
See: newAddTagsToCertificateResponse smart constructor.
Constructors
| AddTagsToCertificateResponse' | |
Instances
| Generic AddTagsToCertificateResponse Source # | |
Defined in Amazonka.CertificateManager.AddTagsToCertificate Associated Types type Rep AddTagsToCertificateResponse :: Type -> Type # | |
| Read AddTagsToCertificateResponse Source # | |
| Show AddTagsToCertificateResponse Source # | |
Defined in Amazonka.CertificateManager.AddTagsToCertificate Methods showsPrec :: Int -> AddTagsToCertificateResponse -> ShowS # show :: AddTagsToCertificateResponse -> String # showList :: [AddTagsToCertificateResponse] -> ShowS # | |
| NFData AddTagsToCertificateResponse Source # | |
Defined in Amazonka.CertificateManager.AddTagsToCertificate Methods rnf :: AddTagsToCertificateResponse -> () # | |
| Eq AddTagsToCertificateResponse Source # | |
Defined in Amazonka.CertificateManager.AddTagsToCertificate Methods (==) :: AddTagsToCertificateResponse -> AddTagsToCertificateResponse -> Bool # (/=) :: AddTagsToCertificateResponse -> AddTagsToCertificateResponse -> Bool # | |
| type Rep AddTagsToCertificateResponse Source # | |
newAddTagsToCertificateResponse :: AddTagsToCertificateResponse Source #
Create a value of AddTagsToCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCertificate
data DeleteCertificate Source #
See: newDeleteCertificate smart constructor.
Constructors
| DeleteCertificate' Text |
Instances
Arguments
| :: Text | |
| -> DeleteCertificate |
Create a value of DeleteCertificate 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:
DeleteCertificate, deleteCertificate_certificateArn - String that contains the ARN of the ACM certificate to be deleted. This
must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
data DeleteCertificateResponse Source #
See: newDeleteCertificateResponse smart constructor.
Constructors
| DeleteCertificateResponse' | |
Instances
newDeleteCertificateResponse :: DeleteCertificateResponse Source #
Create a value of DeleteCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeCertificate
data DescribeCertificate Source #
See: newDescribeCertificate smart constructor.
Constructors
| DescribeCertificate' Text |
Instances
newDescribeCertificate Source #
Arguments
| :: Text | |
| -> DescribeCertificate |
Create a value of DescribeCertificate 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:
DescribeCertificate, describeCertificate_certificateArn - The Amazon Resource Name (ARN) of the ACM certificate. The ARN must have
the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
data DescribeCertificateResponse Source #
See: newDescribeCertificateResponse smart constructor.
Constructors
| DescribeCertificateResponse' (Maybe CertificateDetail) Int |
Instances
newDescribeCertificateResponse Source #
Create a value of DescribeCertificateResponse 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:DescribeCertificateResponse', describeCertificateResponse_certificate - Metadata about an ACM certificate.
$sel:httpStatus:DescribeCertificateResponse', describeCertificateResponse_httpStatus - The response's http status code.
ExportCertificate
data ExportCertificate Source #
See: newExportCertificate smart constructor.
Constructors
| ExportCertificate' Text (Sensitive Base64) |
Instances
Arguments
| :: Text | |
| -> ByteString | |
| -> ExportCertificate |
Create a value of ExportCertificate 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:
ExportCertificate, exportCertificate_certificateArn - An Amazon Resource Name (ARN) of the issued certificate. This must be of
the form:
arn:aws:acm:region:account:certificate/12345678-1234-1234-1234-123456789012
$sel:passphrase:ExportCertificate', exportCertificate_passphrase - Passphrase to associate with the encrypted exported private key.
When creating your passphrase, you can use any ASCII character except #, $, or %.
If you want to later decrypt the private key, you must have the passphrase. You can use the following OpenSSL command to decrypt a private key. After entering the command, you are prompted for the passphrase.
openssl rsa -in encrypted_key.pem -out decrypted_key.pem--
-- 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 ExportCertificateResponse Source #
See: newExportCertificateResponse smart constructor.
Instances
newExportCertificateResponse Source #
Create a value of ExportCertificateResponse 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:ExportCertificateResponse', exportCertificateResponse_certificate - The base64 PEM-encoded certificate.
$sel:certificateChain:ExportCertificateResponse', exportCertificateResponse_certificateChain - The base64 PEM-encoded certificate chain. This does not include the
certificate that you are exporting.
$sel:privateKey:ExportCertificateResponse', exportCertificateResponse_privateKey - The encrypted private key associated with the public key in the
certificate. The key is output in PKCS #8 format and is base64
PEM-encoded.
$sel:httpStatus:ExportCertificateResponse', exportCertificateResponse_httpStatus - The response's http status code.
GetAccountConfiguration
data GetAccountConfiguration Source #
See: newGetAccountConfiguration smart constructor.
Constructors
| GetAccountConfiguration' | |
Instances
newGetAccountConfiguration :: GetAccountConfiguration Source #
Create a value of GetAccountConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data GetAccountConfigurationResponse Source #
See: newGetAccountConfigurationResponse smart constructor.
Constructors
| GetAccountConfigurationResponse' (Maybe ExpiryEventsConfiguration) Int |
Instances
newGetAccountConfigurationResponse Source #
Create a value of GetAccountConfigurationResponse 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:expiryEvents:GetAccountConfigurationResponse', getAccountConfigurationResponse_expiryEvents - Expiration events configuration options associated with the Amazon Web
Services account.
$sel:httpStatus:GetAccountConfigurationResponse', getAccountConfigurationResponse_httpStatus - The response's http status code.
GetCertificate
data GetCertificate Source #
See: newGetCertificate smart constructor.
Constructors
| GetCertificate' Text |
Instances
Arguments
| :: 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_certificateArn - String that contains a certificate ARN in the following format:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
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 ACM-issued certificate corresponding to the ARN specified as input.
$sel:certificateChain:GetCertificateResponse', getCertificateResponse_certificateChain - Certificates forming the requested certificate's chain of trust. The
chain consists of the certificate of the issuing CA and the intermediate
certificates of any other subordinate CAs.
$sel:httpStatus:GetCertificateResponse', getCertificateResponse_httpStatus - The response's http status code.
ImportCertificate
data ImportCertificate Source #
See: newImportCertificate smart constructor.
Constructors
| ImportCertificate' (Maybe Text) (Maybe Base64) (Maybe (NonEmpty Tag)) Base64 (Sensitive Base64) |
Instances
Arguments
| :: ByteString | |
| -> ByteString | |
| -> ImportCertificate |
Create a value of ImportCertificate 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:
ImportCertificate, importCertificate_certificateArn - The
Amazon Resource Name (ARN)
of an imported certificate to replace. To import a new certificate, omit
this field.
$sel:certificateChain:ImportCertificate', importCertificate_certificateChain - The PEM encoded certificate 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.
$sel:tags:ImportCertificate', importCertificate_tags - One or more resource tags to associate with the imported certificate.
Note: You cannot apply tags when reimporting a certificate.
$sel:certificate:ImportCertificate', importCertificate_certificate - The certificate to import.--
-- 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.
$sel:privateKey:ImportCertificate', importCertificate_privateKey - The private key that matches the public key in the certificate.--
-- 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 ImportCertificateResponse Source #
See: newImportCertificateResponse smart constructor.
Constructors
| ImportCertificateResponse' (Maybe Text) Int |
Instances
newImportCertificateResponse Source #
Create a value of ImportCertificateResponse 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:
ImportCertificate, importCertificateResponse_certificateArn - The
Amazon Resource Name (ARN)
of the imported certificate.
$sel:httpStatus:ImportCertificateResponse', importCertificateResponse_httpStatus - The response's http status code.
ListCertificates (Paginated)
data ListCertificates Source #
See: newListCertificates smart constructor.
Constructors
| ListCertificates' (Maybe [CertificateStatus]) (Maybe Filters) (Maybe Natural) (Maybe Text) (Maybe SortBy) (Maybe SortOrder) |
Instances
newListCertificates :: ListCertificates Source #
Create a value of ListCertificates with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateStatuses:ListCertificates', listCertificates_certificateStatuses - Filter the certificate list by status value.
$sel:includes:ListCertificates', listCertificates_includes - Filter the certificate list. For more information, see the Filters
structure.
$sel:maxItems:ListCertificates', listCertificates_maxItems - 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.
ListCertificates, listCertificates_nextToken - Use this parameter only when paginating results and only 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.
$sel:sortBy:ListCertificates', listCertificates_sortBy - Specifies the field to sort results by. If you specify SortBy, you
must also specify SortOrder.
$sel:sortOrder:ListCertificates', listCertificates_sortOrder - Specifies the order of sorted results. If you specify SortOrder, you
must also specify SortBy.
data ListCertificatesResponse Source #
See: newListCertificatesResponse smart constructor.
Constructors
| ListCertificatesResponse' (Maybe [CertificateSummary]) (Maybe Text) Int |
Instances
newListCertificatesResponse Source #
Create a value of ListCertificatesResponse 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:certificateSummaryList:ListCertificatesResponse', listCertificatesResponse_certificateSummaryList - A list of ACM certificates.
ListCertificates, listCertificatesResponse_nextToken - When the list is truncated, this value is present and contains the value
to use for the NextToken parameter in a subsequent pagination request.
$sel:httpStatus:ListCertificatesResponse', listCertificatesResponse_httpStatus - The response's http status code.
ListTagsForCertificate
data ListTagsForCertificate Source #
See: newListTagsForCertificate smart constructor.
Constructors
| ListTagsForCertificate' Text |
Instances
newListTagsForCertificate Source #
Arguments
| :: Text | |
| -> ListTagsForCertificate |
Create a value of ListTagsForCertificate 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:
ListTagsForCertificate, listTagsForCertificate_certificateArn - String that contains the ARN of the ACM certificate for which you want
to list the tags. This must have the following form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
data ListTagsForCertificateResponse Source #
See: newListTagsForCertificateResponse smart constructor.
Constructors
| ListTagsForCertificateResponse' (Maybe (NonEmpty Tag)) Int |
Instances
newListTagsForCertificateResponse Source #
Create a value of ListTagsForCertificateResponse 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:tags:ListTagsForCertificateResponse', listTagsForCertificateResponse_tags - The key-value pairs that define the applied tags.
$sel:httpStatus:ListTagsForCertificateResponse', listTagsForCertificateResponse_httpStatus - The response's http status code.
PutAccountConfiguration
data PutAccountConfiguration Source #
See: newPutAccountConfiguration smart constructor.
Constructors
| PutAccountConfiguration' (Maybe ExpiryEventsConfiguration) Text |
Instances
newPutAccountConfiguration Source #
Create a value of PutAccountConfiguration 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:expiryEvents:PutAccountConfiguration', putAccountConfiguration_expiryEvents - Specifies expiration events associated with an account.
$sel:idempotencyToken:PutAccountConfiguration', putAccountConfiguration_idempotencyToken - Customer-chosen string used to distinguish between calls to
PutAccountConfiguration. Idempotency tokens time out after one hour.
If you call PutAccountConfiguration multiple times with the same
unexpired idempotency token, ACM treats it as the same request and
returns the original result. If you change the idempotency token for
each call, ACM treats each call as a new request.
data PutAccountConfigurationResponse Source #
See: newPutAccountConfigurationResponse smart constructor.
Constructors
| PutAccountConfigurationResponse' | |
Instances
| Generic PutAccountConfigurationResponse Source # | |
Defined in Amazonka.CertificateManager.PutAccountConfiguration Associated Types type Rep PutAccountConfigurationResponse :: Type -> Type # | |
| Read PutAccountConfigurationResponse Source # | |
| Show PutAccountConfigurationResponse Source # | |
Defined in Amazonka.CertificateManager.PutAccountConfiguration Methods showsPrec :: Int -> PutAccountConfigurationResponse -> ShowS # | |
| NFData PutAccountConfigurationResponse Source # | |
Defined in Amazonka.CertificateManager.PutAccountConfiguration Methods rnf :: PutAccountConfigurationResponse -> () # | |
| Eq PutAccountConfigurationResponse Source # | |
| type Rep PutAccountConfigurationResponse Source # | |
newPutAccountConfigurationResponse :: PutAccountConfigurationResponse Source #
Create a value of PutAccountConfigurationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RemoveTagsFromCertificate
data RemoveTagsFromCertificate Source #
See: newRemoveTagsFromCertificate smart constructor.
Constructors
| RemoveTagsFromCertificate' Text (NonEmpty Tag) |
Instances
newRemoveTagsFromCertificate Source #
Arguments
| :: Text | |
| -> NonEmpty Tag | |
| -> RemoveTagsFromCertificate |
Create a value of RemoveTagsFromCertificate 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:
RemoveTagsFromCertificate, removeTagsFromCertificate_certificateArn - String that contains the ARN of the ACM Certificate with one or more
tags that you want to remove. This must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
$sel:tags:RemoveTagsFromCertificate', removeTagsFromCertificate_tags - The key-value pair that defines the tag to remove.
data RemoveTagsFromCertificateResponse Source #
See: newRemoveTagsFromCertificateResponse smart constructor.
Constructors
| RemoveTagsFromCertificateResponse' | |
Instances
newRemoveTagsFromCertificateResponse :: RemoveTagsFromCertificateResponse Source #
Create a value of RemoveTagsFromCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RenewCertificate
data RenewCertificate Source #
See: newRenewCertificate smart constructor.
Constructors
| RenewCertificate' Text |
Instances
Arguments
| :: Text | |
| -> RenewCertificate |
Create a value of RenewCertificate 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:
RenewCertificate, renewCertificate_certificateArn - String that contains the ARN of the ACM certificate to be renewed. This
must be of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
data RenewCertificateResponse Source #
See: newRenewCertificateResponse smart constructor.
Constructors
| RenewCertificateResponse' | |
Instances
newRenewCertificateResponse :: RenewCertificateResponse Source #
Create a value of RenewCertificateResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RequestCertificate
data RequestCertificate Source #
See: newRequestCertificate smart constructor.
Constructors
Instances
newRequestCertificate Source #
Arguments
| :: Text | |
| -> RequestCertificate |
Create a value of RequestCertificate 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:
RequestCertificate, requestCertificate_certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA)
that will be used to issue the certificate. If you do not provide an ARN
and you are trying to request a private certificate, ACM will attempt to
issue a public certificate. For more information about private CAs, see
the
Amazon Web Services Private Certificate Authority
user guide. The ARN must have the following form:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
RequestCertificate, requestCertificate_domainValidationOptions - The domain name that you want ACM to use to send you emails so that you
can validate domain ownership.
$sel:idempotencyToken:RequestCertificate', requestCertificate_idempotencyToken - Customer chosen string that can be used to distinguish between calls to
RequestCertificate. Idempotency tokens time out after one hour.
Therefore, if you call RequestCertificate multiple times with the same
idempotency token within one hour, ACM recognizes that you are
requesting only one certificate and will issue only one. If you change
the idempotency token for each call, ACM recognizes that you are
requesting multiple certificates.
RequestCertificate, requestCertificate_keyAlgorithm - Specifies the algorithm of the public and private key pair that your
certificate uses to encrypt data. RSA is the default key algorithm for
ACM certificates. Elliptic Curve Digital Signature Algorithm (ECDSA)
keys are smaller, offering security comparable to RSA keys but with
greater computing efficiency. However, ECDSA is not supported by all
network clients. Some AWS services may require RSA keys, or only support
ECDSA keys of a particular size, while others allow the use of either
RSA and ECDSA keys to ensure that compatibility is not broken. Check the
requirements for the AWS service where you plan to deploy your
certificate.
Default: RSA_2048
RequestCertificate, requestCertificate_options - Currently, you can use this parameter to specify whether to add the
certificate to a certificate transparency log. Certificate transparency
makes it possible to detect SSL/TLS certificates that have been
mistakenly or maliciously issued. Certificates that have not been logged
typically produce an error message in a browser. For more information,
see
Opting Out of Certificate Transparency Logging.
RequestCertificate, requestCertificate_subjectAlternativeNames - Additional FQDNs to be included in the Subject Alternative Name
extension of the ACM certificate. For example, add the name
www.example.net to a certificate for which the DomainName field is
www.example.com if users can reach your site by using either name. The
maximum number of domain names that you can add to an ACM certificate is
100. However, the initial quota is 10 domain names. If you need more
than 10 names, you must request a quota increase. For more information,
see
Quotas.
The maximum length of a SAN DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples:
(63 octets).(63 octets).(63 octets).(61 octets)is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets.(64 octets).(63 octets).(63 octets).(61 octets)is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets.(63 octets).(63 octets).(63 octets).(62 octets)is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets.
$sel:tags:RequestCertificate', requestCertificate_tags - One or more resource tags to associate with the certificate.
RequestCertificate, requestCertificate_validationMethod - The method you want to use if you are requesting a public certificate to
validate that you own or control domain. You can
validate with DNS
or
validate with email.
We recommend that you use DNS validation.
RequestCertificate, requestCertificate_domainName - Fully qualified domain name (FQDN), such as www.example.com, that you
want to secure with an ACM certificate. Use an asterisk (*) to create a
wildcard certificate that protects several sites in the same domain. For
example, *.example.com protects www.example.com, site.example.com, and
images.example.com.
In compliance with RFC 5280, the length of the domain name (technically, the Common Name) that you provide cannot exceed 64 octets (characters), including periods. To add a longer domain name, specify it in the Subject Alternative Name field, which supports names up to 253 octets in length.
data RequestCertificateResponse Source #
See: newRequestCertificateResponse smart constructor.
Constructors
| RequestCertificateResponse' (Maybe Text) Int |
Instances
newRequestCertificateResponse Source #
Create a value of RequestCertificateResponse 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:
RequestCertificateResponse, requestCertificateResponse_certificateArn - String that contains the ARN of the issued certificate. This must be of
the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
$sel:httpStatus:RequestCertificateResponse', requestCertificateResponse_httpStatus - The response's http status code.
ResendValidationEmail
data ResendValidationEmail Source #
See: newResendValidationEmail smart constructor.
Constructors
| ResendValidationEmail' Text Text Text |
Instances
newResendValidationEmail Source #
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> ResendValidationEmail |
Create a value of ResendValidationEmail 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:
ResendValidationEmail, resendValidationEmail_certificateArn - String that contains the ARN of the requested certificate. The
certificate ARN is generated and returned by the RequestCertificate
action as soon as the request is made. By default, using this parameter
causes email to be sent to all top-level domains you specified in the
certificate request. The ARN must be of the form:
arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
$sel:domain:ResendValidationEmail', resendValidationEmail_domain - The fully qualified domain name (FQDN) of the certificate that needs to
be validated.
ResendValidationEmail, resendValidationEmail_validationDomain - The base validation domain that will act as the suffix of the email
addresses that are used to send the emails. This must be the same as the
Domain value or a superdomain of the Domain value. For example, if
you requested a certificate for site.subdomain.example.com and specify
a ValidationDomain of subdomain.example.com, ACM sends email to
the domain registrant, technical contact, and administrative contact in
WHOIS and the following five addresses:
- admin@subdomain.example.com
- administrator@subdomain.example.com
- hostmaster@subdomain.example.com
- postmaster@subdomain.example.com
- webmaster@subdomain.example.com
data ResendValidationEmailResponse Source #
See: newResendValidationEmailResponse smart constructor.
Constructors
| ResendValidationEmailResponse' | |
Instances
| Generic ResendValidationEmailResponse Source # | |
Defined in Amazonka.CertificateManager.ResendValidationEmail Associated Types type Rep ResendValidationEmailResponse :: Type -> Type # | |
| Read ResendValidationEmailResponse Source # | |
| Show ResendValidationEmailResponse Source # | |
Defined in Amazonka.CertificateManager.ResendValidationEmail Methods showsPrec :: Int -> ResendValidationEmailResponse -> ShowS # show :: ResendValidationEmailResponse -> String # showList :: [ResendValidationEmailResponse] -> ShowS # | |
| NFData ResendValidationEmailResponse Source # | |
Defined in Amazonka.CertificateManager.ResendValidationEmail Methods rnf :: ResendValidationEmailResponse -> () # | |
| Eq ResendValidationEmailResponse Source # | |
| type Rep ResendValidationEmailResponse Source # | |
newResendValidationEmailResponse :: ResendValidationEmailResponse Source #
Create a value of ResendValidationEmailResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateCertificateOptions
data UpdateCertificateOptions Source #
See: newUpdateCertificateOptions smart constructor.
Constructors
| UpdateCertificateOptions' Text CertificateOptions |
Instances
newUpdateCertificateOptions Source #
Arguments
| :: Text | |
| -> CertificateOptions | |
| -> UpdateCertificateOptions |
Create a value of UpdateCertificateOptions 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:
UpdateCertificateOptions, updateCertificateOptions_certificateArn - ARN of the requested certificate to update. This must be of the form:
arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012
UpdateCertificateOptions, updateCertificateOptions_options - Use to update the options for your certificate. Currently, you can
specify whether to add your certificate to a transparency log.
Certificate transparency makes it possible to detect SSL/TLS
certificates that have been mistakenly or maliciously issued.
Certificates that have not been logged typically produce an error
message in a browser.
data UpdateCertificateOptionsResponse Source #
See: newUpdateCertificateOptionsResponse smart constructor.
Constructors
| UpdateCertificateOptionsResponse' | |
Instances
newUpdateCertificateOptionsResponse :: UpdateCertificateOptionsResponse Source #
Create a value of UpdateCertificateOptionsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
CertificateStatus
newtype CertificateStatus Source #
Constructors
| CertificateStatus' | |
Fields | |
Bundled Patterns
| pattern CertificateStatus_EXPIRED :: CertificateStatus | |
| pattern CertificateStatus_FAILED :: CertificateStatus | |
| pattern CertificateStatus_INACTIVE :: CertificateStatus | |
| pattern CertificateStatus_ISSUED :: CertificateStatus | |
| pattern CertificateStatus_PENDING_VALIDATION :: CertificateStatus | |
| pattern CertificateStatus_REVOKED :: CertificateStatus | |
| pattern CertificateStatus_VALIDATION_TIMED_OUT :: CertificateStatus |
Instances
CertificateTransparencyLoggingPreference
newtype CertificateTransparencyLoggingPreference Source #
Constructors
| CertificateTransparencyLoggingPreference' | |
Bundled Patterns
Instances
CertificateType
newtype CertificateType Source #
Constructors
| CertificateType' | |
Fields | |
Bundled Patterns
| pattern CertificateType_AMAZON_ISSUED :: CertificateType | |
| pattern CertificateType_IMPORTED :: CertificateType | |
| pattern CertificateType_PRIVATE :: CertificateType |
Instances
DomainStatus
newtype DomainStatus Source #
Constructors
| DomainStatus' | |
Fields | |
Bundled Patterns
| pattern DomainStatus_FAILED :: DomainStatus | |
| pattern DomainStatus_PENDING_VALIDATION :: DomainStatus | |
| pattern DomainStatus_SUCCESS :: DomainStatus |
Instances
ExtendedKeyUsageName
newtype ExtendedKeyUsageName Source #
Constructors
| ExtendedKeyUsageName' | |
Fields | |
Bundled Patterns
Instances
FailureReason
newtype FailureReason Source #
Constructors
| FailureReason' | |
Fields | |
Bundled Patterns
| pattern FailureReason_ADDITIONAL_VERIFICATION_REQUIRED :: FailureReason | |
| pattern FailureReason_CAA_ERROR :: FailureReason | |
| pattern FailureReason_DOMAIN_NOT_ALLOWED :: FailureReason | |
| pattern FailureReason_DOMAIN_VALIDATION_DENIED :: FailureReason | |
| pattern FailureReason_INVALID_PUBLIC_DOMAIN :: FailureReason | |
| pattern FailureReason_NO_AVAILABLE_CONTACTS :: FailureReason | |
| pattern FailureReason_OTHER :: FailureReason | |
| pattern FailureReason_PCA_ACCESS_DENIED :: FailureReason | |
| pattern FailureReason_PCA_INVALID_ARGS :: FailureReason | |
| pattern FailureReason_PCA_INVALID_ARN :: FailureReason | |
| pattern FailureReason_PCA_INVALID_DURATION :: FailureReason | |
| pattern FailureReason_PCA_INVALID_STATE :: FailureReason | |
| pattern FailureReason_PCA_LIMIT_EXCEEDED :: FailureReason | |
| pattern FailureReason_PCA_NAME_CONSTRAINTS_VALIDATION :: FailureReason | |
| pattern FailureReason_PCA_REQUEST_FAILED :: FailureReason | |
| pattern FailureReason_PCA_RESOURCE_NOT_FOUND :: FailureReason | |
| pattern FailureReason_SLR_NOT_FOUND :: FailureReason |
Instances
KeyAlgorithm
newtype KeyAlgorithm Source #
Constructors
| KeyAlgorithm' | |
Fields | |
Bundled Patterns
| pattern KeyAlgorithm_EC_prime256v1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_EC_secp384r1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_EC_secp521r1 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_1024 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_2048 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_3072 :: KeyAlgorithm | |
| pattern KeyAlgorithm_RSA_4096 :: KeyAlgorithm |
Instances
KeyUsageName
newtype KeyUsageName Source #
Constructors
| KeyUsageName' | |
Fields | |
Bundled Patterns
| pattern KeyUsageName_ANY :: KeyUsageName | |
| pattern KeyUsageName_CERTIFICATE_SIGNING :: KeyUsageName | |
| pattern KeyUsageName_CRL_SIGNING :: KeyUsageName | |
| pattern KeyUsageName_CUSTOM :: KeyUsageName | |
| pattern KeyUsageName_DATA_ENCIPHERMENT :: KeyUsageName | |
| pattern KeyUsageName_DECIPHER_ONLY :: KeyUsageName | |
| pattern KeyUsageName_DIGITAL_SIGNATURE :: KeyUsageName | |
| pattern KeyUsageName_ENCIPHER_ONLY :: KeyUsageName | |
| pattern KeyUsageName_KEY_AGREEMENT :: KeyUsageName | |
| pattern KeyUsageName_KEY_ENCIPHERMENT :: KeyUsageName | |
| pattern KeyUsageName_NON_REPUDIATION :: KeyUsageName |
Instances
RecordType
newtype RecordType Source #
Constructors
| RecordType' | |
Fields | |
Bundled Patterns
| pattern RecordType_CNAME :: RecordType |
Instances
RenewalEligibility
newtype RenewalEligibility Source #
Constructors
| RenewalEligibility' | |
Fields | |
Bundled Patterns
| pattern RenewalEligibility_ELIGIBLE :: RenewalEligibility | |
| pattern RenewalEligibility_INELIGIBLE :: RenewalEligibility |
Instances
RenewalStatus
newtype RenewalStatus Source #
Constructors
| RenewalStatus' | |
Fields | |
Bundled Patterns
| pattern RenewalStatus_FAILED :: RenewalStatus | |
| pattern RenewalStatus_PENDING_AUTO_RENEWAL :: RenewalStatus | |
| pattern RenewalStatus_PENDING_VALIDATION :: RenewalStatus | |
| pattern RenewalStatus_SUCCESS :: RenewalStatus |
Instances
RevocationReason
newtype RevocationReason Source #
Constructors
| RevocationReason' | |
Fields | |
Bundled Patterns
| pattern RevocationReason_AFFILIATION_CHANGED :: RevocationReason | |
| pattern RevocationReason_A_A_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CA_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_CERTIFICATE_HOLD :: RevocationReason | |
| pattern RevocationReason_CESSATION_OF_OPERATION :: RevocationReason | |
| pattern RevocationReason_KEY_COMPROMISE :: RevocationReason | |
| pattern RevocationReason_PRIVILEGE_WITHDRAWN :: RevocationReason | |
| pattern RevocationReason_REMOVE_FROM_CRL :: RevocationReason | |
| pattern RevocationReason_SUPERCEDED :: RevocationReason | |
| pattern RevocationReason_UNSPECIFIED :: RevocationReason |
Instances
SortBy
Constructors
| SortBy' | |
Fields
| |
Bundled Patterns
| pattern SortBy_CREATED_AT :: SortBy |
Instances
SortOrder
Constructors
| SortOrder' | |
Fields | |
Bundled Patterns
| pattern SortOrder_ASCENDING :: SortOrder | |
| pattern SortOrder_DESCENDING :: SortOrder |
Instances
ValidationMethod
newtype ValidationMethod Source #
Constructors
| ValidationMethod' | |
Fields | |
Bundled Patterns
| pattern ValidationMethod_DNS :: ValidationMethod | |
| pattern ValidationMethod_EMAIL :: ValidationMethod |
Instances
CertificateDetail
data CertificateDetail Source #
Contains metadata about an ACM certificate. This structure is returned in the response to a DescribeCertificate request.
See: newCertificateDetail smart constructor.
Constructors
| CertificateDetail' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (NonEmpty DomainValidation)) (Maybe [ExtendedKeyUsage]) (Maybe FailureReason) (Maybe POSIX) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe KeyAlgorithm) (Maybe [KeyUsage]) (Maybe POSIX) (Maybe POSIX) (Maybe CertificateOptions) (Maybe RenewalEligibility) (Maybe RenewalSummary) (Maybe RevocationReason) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe CertificateStatus) (Maybe Text) (Maybe (NonEmpty Text)) (Maybe CertificateType) |
Instances
newCertificateDetail :: CertificateDetail Source #
Create a value of CertificateDetail 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:CertificateDetail', certificateDetail_certificateArn - The Amazon Resource Name (ARN) of the certificate. For more information
about ARNs, see
Amazon Resource Names (ARNs)
in the Amazon Web Services General Reference.
$sel:certificateAuthorityArn:CertificateDetail', certificateDetail_certificateAuthorityArn - The Amazon Resource Name (ARN) of the private certificate authority (CA)
that issued the certificate. This has the following format:
arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
$sel:createdAt:CertificateDetail', certificateDetail_createdAt - The time at which the certificate was requested.
CertificateDetail, certificateDetail_domainName - The fully qualified domain name for the certificate, such as
www.example.com or example.com.
CertificateDetail, certificateDetail_domainValidationOptions - Contains information about the initial validation of each domain name
that occurs as a result of the RequestCertificate request. This field
exists only when the certificate type is AMAZON_ISSUED.
$sel:extendedKeyUsages:CertificateDetail', certificateDetail_extendedKeyUsages - Contains a list of Extended Key Usage X.509 v3 extension objects. Each
object specifies a purpose for which the certificate public key can be
used and consists of a name and an object identifier (OID).
$sel:failureReason:CertificateDetail', certificateDetail_failureReason - The reason the certificate request failed. This value exists only when
the certificate status is FAILED. For more information, see
Certificate Request Failed
in the Certificate Manager User Guide.
$sel:importedAt:CertificateDetail', certificateDetail_importedAt - The date and time when the certificate was imported. This value exists
only when the certificate type is IMPORTED.
$sel:inUseBy:CertificateDetail', certificateDetail_inUseBy - A list of ARNs for the Amazon Web Services resources that are using the
certificate. A certificate can be used by multiple Amazon Web Services
resources.
$sel:issuedAt:CertificateDetail', certificateDetail_issuedAt - The time at which the certificate was issued. This value exists only
when the certificate type is AMAZON_ISSUED.
$sel:issuer:CertificateDetail', certificateDetail_issuer - The name of the certificate authority that issued and signed the
certificate.
$sel:keyAlgorithm:CertificateDetail', certificateDetail_keyAlgorithm - The algorithm that was used to generate the public-private key pair.
$sel:keyUsages:CertificateDetail', certificateDetail_keyUsages - A list of Key Usage X.509 v3 extension objects. Each object is a string
value that identifies the purpose of the public key contained in the
certificate. Possible extension values include DIGITAL_SIGNATURE,
KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
$sel:notAfter:CertificateDetail', certificateDetail_notAfter - The time after which the certificate is not valid.
$sel:notBefore:CertificateDetail', certificateDetail_notBefore - The time before which the certificate is not valid.
$sel:options:CertificateDetail', certificateDetail_options - Value that specifies whether to add the certificate to a transparency
log. Certificate transparency makes it possible to detect SSL
certificates that have been mistakenly or maliciously issued. A browser
might respond to certificate that has not been logged by showing an
error message. The logs are cryptographically secure.
$sel:renewalEligibility:CertificateDetail', certificateDetail_renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time,
only exported private certificates can be renewed with the
RenewCertificate command.
$sel:renewalSummary:CertificateDetail', certificateDetail_renewalSummary - Contains information about the status of ACM's
managed renewal
for the certificate. This field exists only when the certificate type is
AMAZON_ISSUED.
$sel:revocationReason:CertificateDetail', certificateDetail_revocationReason - The reason the certificate was revoked. This value exists only when the
certificate status is REVOKED.
$sel:revokedAt:CertificateDetail', certificateDetail_revokedAt - The time at which the certificate was revoked. This value exists only
when the certificate status is REVOKED.
$sel:serial:CertificateDetail', certificateDetail_serial - The serial number of the certificate.
$sel:signatureAlgorithm:CertificateDetail', certificateDetail_signatureAlgorithm - The algorithm that was used to sign the certificate.
$sel:status:CertificateDetail', certificateDetail_status - The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
$sel:subject:CertificateDetail', certificateDetail_subject - The name of the entity that is associated with the public key contained
in the certificate.
$sel:subjectAlternativeNames:CertificateDetail', certificateDetail_subjectAlternativeNames - One or more domain names (subject alternative names) included in the
certificate. This list contains the domain names that are bound to the
public key that is contained in the certificate. The subject alternative
names include the canonical domain name (CN) of the certificate and
additional domain names that can be used to connect to the website.
$sel:type':CertificateDetail', certificateDetail_type - The source of the certificate. For certificates provided by ACM, this
value is AMAZON_ISSUED. For certificates that you imported with
ImportCertificate, this value is IMPORTED. ACM does not provide
managed renewal
for imported certificates. For more information about the differences
between certificates that you import and those that ACM provides, see
Importing Certificates
in the Certificate Manager User Guide.
CertificateOptions
data CertificateOptions Source #
Structure that contains options for your certificate. Currently, you can use this only to specify whether to opt in to or out of certificate transparency logging. Some browsers require that public certificates issued for your domain be recorded in a log. Certificates that are not logged typically generate a browser error. Transparency makes it possible for you to detect SSL/TLS certificates that have been mistakenly or maliciously issued for your domain. For general information, see Certificate Transparency Logging.
See: newCertificateOptions smart constructor.
Constructors
| CertificateOptions' (Maybe CertificateTransparencyLoggingPreference) |
Instances
newCertificateOptions :: CertificateOptions Source #
Create a value of CertificateOptions 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:certificateTransparencyLoggingPreference:CertificateOptions', certificateOptions_certificateTransparencyLoggingPreference - You can opt out of certificate transparency logging by specifying the
DISABLED option. Opt in by specifying ENABLED.
CertificateSummary
data CertificateSummary Source #
This structure is returned in the response object of ListCertificates action.
See: newCertificateSummary smart constructor.
Constructors
| CertificateSummary' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe [ExtendedKeyUsageName]) (Maybe Bool) (Maybe POSIX) (Maybe Bool) (Maybe POSIX) (Maybe KeyAlgorithm) (Maybe [KeyUsageName]) (Maybe POSIX) (Maybe POSIX) (Maybe RenewalEligibility) (Maybe POSIX) (Maybe CertificateStatus) (Maybe (NonEmpty Text)) (Maybe CertificateType) |
Instances
newCertificateSummary :: CertificateSummary Source #
Create a value of CertificateSummary 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:CertificateSummary', certificateSummary_certificateArn - Amazon Resource Name (ARN) of the certificate. This is of the form:
arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012
For more information about ARNs, see Amazon Resource Names (ARNs).
$sel:createdAt:CertificateSummary', certificateSummary_createdAt - The time at which the certificate was requested.
$sel:domainName:CertificateSummary', certificateSummary_domainName - Fully qualified domain name (FQDN), such as www.example.com or
example.com, for the certificate.
$sel:exported:CertificateSummary', certificateSummary_exported - Indicates whether the certificate has been exported. This value exists
only when the certificate type is PRIVATE.
$sel:extendedKeyUsages:CertificateSummary', certificateSummary_extendedKeyUsages - Contains a list of Extended Key Usage X.509 v3 extension objects. Each
object specifies a purpose for which the certificate public key can be
used and consists of a name and an object identifier (OID).
$sel:hasAdditionalSubjectAlternativeNames:CertificateSummary', certificateSummary_hasAdditionalSubjectAlternativeNames - When called by
ListCertificates,
indicates whether the full list of subject alternative names has been
included in the response. If false, the response includes all of the
subject alternative names included in the certificate. If true, the
response only includes the first 100 subject alternative names included
in the certificate. To display the full list of subject alternative
names, use
DescribeCertificate.
$sel:importedAt:CertificateSummary', certificateSummary_importedAt - The date and time when the certificate was imported. This value exists
only when the certificate type is IMPORTED.
$sel:inUse:CertificateSummary', certificateSummary_inUse - Indicates whether the certificate is currently in use by any Amazon Web
Services resources.
$sel:issuedAt:CertificateSummary', certificateSummary_issuedAt - The time at which the certificate was issued. This value exists only
when the certificate type is AMAZON_ISSUED.
$sel:keyAlgorithm:CertificateSummary', certificateSummary_keyAlgorithm - The algorithm that was used to generate the public-private key pair.
$sel:keyUsages:CertificateSummary', certificateSummary_keyUsages - A list of Key Usage X.509 v3 extension objects. Each object is a string
value that identifies the purpose of the public key contained in the
certificate. Possible extension values include DIGITAL_SIGNATURE,
KEY_ENCHIPHERMENT, NON_REPUDIATION, and more.
$sel:notAfter:CertificateSummary', certificateSummary_notAfter - The time after which the certificate is not valid.
$sel:notBefore:CertificateSummary', certificateSummary_notBefore - The time before which the certificate is not valid.
$sel:renewalEligibility:CertificateSummary', certificateSummary_renewalEligibility - Specifies whether the certificate is eligible for renewal. At this time,
only exported private certificates can be renewed with the
RenewCertificate command.
$sel:revokedAt:CertificateSummary', certificateSummary_revokedAt - The time at which the certificate was revoked. This value exists only
when the certificate status is REVOKED.
$sel:status:CertificateSummary', certificateSummary_status - The status of the certificate.
A certificate enters status PENDING_VALIDATION upon being requested, unless it fails for any of the reasons given in the troubleshooting topic Certificate request fails. ACM makes repeated attempts to validate a certificate for 72 hours and then times out. If a certificate shows status FAILED or VALIDATION_TIMED_OUT, delete the request, correct the issue with DNS validation or Email validation, and try again. If validation succeeds, the certificate enters status ISSUED.
$sel:subjectAlternativeNameSummaries:CertificateSummary', certificateSummary_subjectAlternativeNameSummaries - One or more domain names (subject alternative names) included in the
certificate. This list contains the domain names that are bound to the
public key that is contained in the certificate. The subject alternative
names include the canonical domain name (CN) of the certificate and
additional domain names that can be used to connect to the website.
When called by ListCertificates, this parameter will only return the first 100 subject alternative names included in the certificate. To display the full list of subject alternative names, use DescribeCertificate.
$sel:type':CertificateSummary', certificateSummary_type - The source of the certificate. For certificates provided by ACM, this
value is AMAZON_ISSUED. For certificates that you imported with
ImportCertificate, this value is IMPORTED. ACM does not provide
managed renewal
for imported certificates. For more information about the differences
between certificates that you import and those that ACM provides, see
Importing Certificates
in the Certificate Manager User Guide.
DomainValidation
data DomainValidation Source #
Contains information about the validation of each domain name in the certificate.
See: newDomainValidation smart constructor.
Constructors
| DomainValidation' (Maybe ResourceRecord) (Maybe Text) (Maybe [Text]) (Maybe ValidationMethod) (Maybe DomainStatus) Text |
Instances
Arguments
| :: Text | |
| -> DomainValidation |
Create a value of DomainValidation 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:resourceRecord:DomainValidation', domainValidation_resourceRecord - Contains the CNAME record that you add to your DNS database for domain
validation. For more information, see
Use DNS to Validate Domain Ownership.
Note: The CNAME information that you need does not include the name of your domain. If you include your domain name in the DNS database CNAME record, validation fails. For example, if the name is "_a79865eb4cd1a6ab990a45779b4e0b96.yourdomain.com", only "_a79865eb4cd1a6ab990a45779b4e0b96" must be used.
$sel:validationDomain:DomainValidation', domainValidation_validationDomain - The domain name that ACM used to send domain validation emails.
$sel:validationEmails:DomainValidation', domainValidation_validationEmails - A list of email addresses that ACM used to send domain validation
emails.
$sel:validationMethod:DomainValidation', domainValidation_validationMethod - Specifies the domain validation method.
$sel:validationStatus:DomainValidation', domainValidation_validationStatus - The validation status of the domain name. This can be one of the
following values:
PENDING_VALIDATION
- SUCCESS
- FAILED
$sel:domainName:DomainValidation', domainValidation_domainName - A fully qualified domain name (FQDN) in the certificate. For example,
www.example.com or example.com.
DomainValidationOption
data DomainValidationOption Source #
Contains information about the domain names that you want ACM to use to send you emails that enable you to validate domain ownership.
See: newDomainValidationOption smart constructor.
Constructors
| DomainValidationOption' Text Text |
Instances
newDomainValidationOption Source #
Arguments
| :: Text | |
| -> Text | |
| -> DomainValidationOption |
Create a value of DomainValidationOption 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:domainName:DomainValidationOption', domainValidationOption_domainName - A fully qualified domain name (FQDN) in the certificate request.
$sel:validationDomain:DomainValidationOption', domainValidationOption_validationDomain - The domain name that you want ACM to use to send you validation emails.
This domain name is the suffix of the email addresses that you want ACM
to use. This must be the same as the DomainName value or a superdomain
of the DomainName value. For example, if you request a certificate for
testing.example.com, you can specify example.com for this value. In
that case, ACM sends domain validation emails to the following five
addresses:
- admin@example.com
- administrator@example.com
- hostmaster@example.com
- postmaster@example.com
- webmaster@example.com
ExpiryEventsConfiguration
data ExpiryEventsConfiguration Source #
Object containing expiration events options associated with an Amazon Web Services account.
See: newExpiryEventsConfiguration smart constructor.
Constructors
| ExpiryEventsConfiguration' (Maybe Natural) |
Instances
newExpiryEventsConfiguration :: ExpiryEventsConfiguration Source #
Create a value of ExpiryEventsConfiguration 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:daysBeforeExpiry:ExpiryEventsConfiguration', expiryEventsConfiguration_daysBeforeExpiry - Specifies the number of days prior to certificate expiration when ACM
starts generating EventBridge events. ACM sends one event per day per
certificate until the certificate expires. By default, accounts receive
events starting 45 days before certificate expiration.
ExtendedKeyUsage
data ExtendedKeyUsage Source #
The Extended Key Usage X.509 v3 extension defines one or more purposes for which the public key can be used. This is in addition to or in place of the basic purposes specified by the Key Usage extension.
See: newExtendedKeyUsage smart constructor.
Constructors
| ExtendedKeyUsage' (Maybe ExtendedKeyUsageName) (Maybe Text) |
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:name:ExtendedKeyUsage', extendedKeyUsage_name - The name of an Extended Key Usage value.
$sel:oid:ExtendedKeyUsage', extendedKeyUsage_oid - An object identifier (OID) for the extension value. OIDs are strings of
numbers separated by periods. The following OIDs are defined in RFC 3280
and RFC 5280.
1.3.6.1.5.5.7.3.1 (TLS_WEB_SERVER_AUTHENTICATION)
1.3.6.1.5.5.7.3.2 (TLS_WEB_CLIENT_AUTHENTICATION)
1.3.6.1.5.5.7.3.3 (CODE_SIGNING)
1.3.6.1.5.5.7.3.4 (EMAIL_PROTECTION)
1.3.6.1.5.5.7.3.8 (TIME_STAMPING)
1.3.6.1.5.5.7.3.9 (OCSP_SIGNING)
1.3.6.1.5.5.7.3.5 (IPSEC_END_SYSTEM)
1.3.6.1.5.5.7.3.6 (IPSEC_TUNNEL)
1.3.6.1.5.5.7.3.7 (IPSEC_USER)
Filters
This structure can be used in the ListCertificates action to filter the output of the certificate list.
See: newFilters smart constructor.
Constructors
| Filters' (Maybe [ExtendedKeyUsageName]) (Maybe [KeyAlgorithm]) (Maybe [KeyUsageName]) |
Instances
| ToJSON Filters Source # | |
Defined in Amazonka.CertificateManager.Types.Filters | |
| Generic Filters Source # | |
| Read Filters Source # | |
| Show Filters Source # | |
| NFData Filters Source # | |
Defined in Amazonka.CertificateManager.Types.Filters | |
| Eq Filters Source # | |
| Hashable Filters Source # | |
Defined in Amazonka.CertificateManager.Types.Filters | |
| type Rep Filters Source # | |
Defined in Amazonka.CertificateManager.Types.Filters type Rep Filters = D1 ('MetaData "Filters" "Amazonka.CertificateManager.Types.Filters" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" 'False) (C1 ('MetaCons "Filters'" 'PrefixI 'True) (S1 ('MetaSel ('Just "extendedKeyUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ExtendedKeyUsageName])) :*: (S1 ('MetaSel ('Just "keyTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyAlgorithm])) :*: S1 ('MetaSel ('Just "keyUsage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [KeyUsageName]))))) | |
newFilters :: Filters Source #
Create a value of Filters 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:extendedKeyUsage:Filters', filters_extendedKeyUsage - Specify one or more ExtendedKeyUsage extension values.
$sel:keyTypes:Filters', filters_keyTypes - Specify one or more algorithms that can be used to generate key pairs.
Default filtering returns only RSA_1024 and RSA_2048 certificates
that have at least one domain. To return other certificate types,
provide the desired type signatures in a comma-separated list. For
example, "keyTypes": ["RSA_2048","RSA_4096"] returns both
RSA_2048 and RSA_4096 certificates.
$sel:keyUsage:Filters', filters_keyUsage - Specify one or more KeyUsage extension values.
KeyUsage
The Key Usage X.509 v3 extension defines the purpose of the public key contained in the certificate.
See: newKeyUsage smart constructor.
Constructors
| KeyUsage' (Maybe KeyUsageName) |
Instances
| FromJSON KeyUsage Source # | |
| Generic KeyUsage Source # | |
| Read KeyUsage Source # | |
| Show KeyUsage Source # | |
| NFData KeyUsage Source # | |
Defined in Amazonka.CertificateManager.Types.KeyUsage | |
| Eq KeyUsage Source # | |
| Hashable KeyUsage Source # | |
Defined in Amazonka.CertificateManager.Types.KeyUsage | |
| type Rep KeyUsage Source # | |
Defined in Amazonka.CertificateManager.Types.KeyUsage type Rep KeyUsage = D1 ('MetaData "KeyUsage" "Amazonka.CertificateManager.Types.KeyUsage" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" 'False) (C1 ('MetaCons "KeyUsage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KeyUsageName)))) | |
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:name:KeyUsage', keyUsage_name - A string value that contains a Key Usage extension name.
RenewalSummary
data RenewalSummary Source #
Contains information about the status of ACM's
managed renewal
for the certificate. This structure exists only when the certificate
type is AMAZON_ISSUED.
See: newRenewalSummary smart constructor.
Constructors
| RenewalSummary' (Maybe FailureReason) RenewalStatus (NonEmpty DomainValidation) POSIX |
Instances
Arguments
| :: RenewalStatus | |
| -> NonEmpty DomainValidation | |
| -> UTCTime | |
| -> RenewalSummary |
Create a value of RenewalSummary 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:renewalStatusReason:RenewalSummary', renewalSummary_renewalStatusReason - The reason that a renewal request was unsuccessful.
$sel:renewalStatus:RenewalSummary', renewalSummary_renewalStatus - The status of ACM's
managed renewal
of the certificate.
$sel:domainValidationOptions:RenewalSummary', renewalSummary_domainValidationOptions - Contains information about the validation of each domain name in the
certificate, as it pertains to ACM's
managed renewal.
This is different from the initial validation that occurs as a result of
the RequestCertificate request. This field exists only when the
certificate type is AMAZON_ISSUED.
$sel:updatedAt:RenewalSummary', renewalSummary_updatedAt - The time at which the renewal summary was last updated.
ResourceRecord
data ResourceRecord Source #
Contains a DNS record value that you can use to validate ownership or control of a domain. This is used by the DescribeCertificate action.
See: newResourceRecord smart constructor.
Constructors
| ResourceRecord' Text RecordType Text |
Instances
Arguments
| :: Text | |
| -> RecordType | |
| -> Text | |
| -> ResourceRecord |
Create a value of ResourceRecord 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:name:ResourceRecord', resourceRecord_name - The name of the DNS record to create in your domain. This is supplied by
ACM.
$sel:type':ResourceRecord', resourceRecord_type - The type of DNS record. Currently this can be CNAME.
$sel:value:ResourceRecord', resourceRecord_value - The value of the CNAME record to add to your DNS database. This is
supplied by ACM.
Tag
A key-value pair that identifies or specifies metadata about an ACM resource.
See: newTag smart constructor.
Instances
| FromJSON Tag Source # | |
| ToJSON Tag Source # | |
Defined in Amazonka.CertificateManager.Types.Tag | |
| Generic Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.CertificateManager.Types.Tag | |
| Eq Tag Source # | |
| Hashable Tag Source # | |
Defined in Amazonka.CertificateManager.Types.Tag | |
| type Rep Tag Source # | |
Defined in Amazonka.CertificateManager.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.CertificateManager.Types.Tag" "amazonka-certificatemanager-2.0-CRaDh4gXGsJGb4mnkgvuBR" '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 - The value of the tag.
$sel:key:Tag', tag_key - The key of the tag.