Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
AWS Certificate Manager
Welcome to the AWS Certificate Manager (ACM) API documentation.
You can use ACM to manage SSLTLS certificates for your AWS-based websites and applications. For general information about using ACM, see the <http:docs.aws.amazon.comacmlatestuserguide AWS Certificate Manager User Guide/ > .
- certificateManager :: Service
- _InvalidTagException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDomainValidationOptionsException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestInProgressException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CertificateManager.ResendValidationEmail
- module Network.AWS.CertificateManager.ListTagsForCertificate
- module Network.AWS.CertificateManager.GetCertificate
- module Network.AWS.CertificateManager.AddTagsToCertificate
- module Network.AWS.CertificateManager.RequestCertificate
- module Network.AWS.CertificateManager.ListCertificates
- module Network.AWS.CertificateManager.DeleteCertificate
- module Network.AWS.CertificateManager.RemoveTagsFromCertificate
- module Network.AWS.CertificateManager.ImportCertificate
- module Network.AWS.CertificateManager.DescribeCertificate
- data CertificateStatus
- data CertificateType
- data FailureReason
- data KeyAlgorithm
- data RevocationReason
- data CertificateDetail
- certificateDetail :: CertificateDetail
- cdSubject :: Lens' CertificateDetail (Maybe Text)
- cdStatus :: Lens' CertificateDetail (Maybe CertificateStatus)
- cdFailureReason :: Lens' CertificateDetail (Maybe FailureReason)
- cdSubjectAlternativeNames :: Lens' CertificateDetail (Maybe (NonEmpty Text))
- cdInUseBy :: Lens' CertificateDetail [Text]
- cdCreatedAt :: Lens' CertificateDetail (Maybe UTCTime)
- cdCertificateARN :: Lens' CertificateDetail (Maybe Text)
- cdSerial :: Lens' CertificateDetail (Maybe Text)
- cdImportedAt :: Lens' CertificateDetail (Maybe UTCTime)
- cdRevokedAt :: Lens' CertificateDetail (Maybe UTCTime)
- cdNotBefore :: Lens' CertificateDetail (Maybe UTCTime)
- cdRevocationReason :: Lens' CertificateDetail (Maybe RevocationReason)
- cdDomainName :: Lens' CertificateDetail (Maybe Text)
- cdKeyAlgorithm :: Lens' CertificateDetail (Maybe KeyAlgorithm)
- cdType :: Lens' CertificateDetail (Maybe CertificateType)
- cdIssuedAt :: Lens' CertificateDetail (Maybe UTCTime)
- cdSignatureAlgorithm :: Lens' CertificateDetail (Maybe Text)
- cdDomainValidationOptions :: Lens' CertificateDetail (Maybe (NonEmpty DomainValidation))
- cdIssuer :: Lens' CertificateDetail (Maybe Text)
- cdNotAfter :: Lens' CertificateDetail (Maybe UTCTime)
- data CertificateSummary
- certificateSummary :: CertificateSummary
- csCertificateARN :: Lens' CertificateSummary (Maybe Text)
- csDomainName :: Lens' CertificateSummary (Maybe Text)
- data DomainValidation
- domainValidation :: Text -> DomainValidation
- dvValidationEmails :: Lens' DomainValidation [Text]
- dvValidationDomain :: Lens' DomainValidation (Maybe Text)
- dvDomainName :: Lens' DomainValidation Text
- data DomainValidationOption
- domainValidationOption :: Text -> Text -> DomainValidationOption
- dvoDomainName :: Lens' DomainValidationOption Text
- dvoValidationDomain :: Lens' DomainValidationOption Text
- data Tag
- tag :: Text -> Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag Text
Service Configuration
certificateManager :: 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
.
InvalidTagException
_InvalidTagException :: AsError a => Getting (First ServiceError) 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:
.
InvalidDomainValidationOptionsException
_InvalidDomainValidationOptionsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more values in the DomainValidationOption
structure is incorrect.
TooManyTagsException
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request contains too many tags. Try the request again with fewer tags.
RequestInProgressException
_RequestInProgressException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate request is in process and the certificate in your account has not yet been issued.
InvalidARNException
_InvalidARNException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The requested Amazon Resource Name (ARN) does not refer to an existing resource.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified certificate cannot be found in the caller's account, or the caller's account cannot be found.
InvalidStateException
_InvalidStateException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Processing has reached an invalid state. For example, this exception can occur if the specified domain is not using email validation, or the current certificate status does not permit the requested operation. See the exception message returned by ACM to determine which state is not valid.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An ACM limit has been exceeded. For example, you may have input more domains than are allowed or you've requested too many certificates for your account. See the exception message returned by ACM to determine which limit you have violated. For more information about ACM limits, see the Limits topic.
ResourceInUseException
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The certificate is in use by another AWS service in the caller's account. Remove the association and try again.
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.
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.
ResendValidationEmail
ListTagsForCertificate
GetCertificate
AddTagsToCertificate
RequestCertificate
ListCertificates (Paginated)
DeleteCertificate
RemoveTagsFromCertificate
ImportCertificate
DescribeCertificate
Types
CertificateStatus
data CertificateStatus Source #
CertificateType
data CertificateType Source #
FailureReason
data FailureReason Source #
KeyAlgorithm
data KeyAlgorithm Source #
RevocationReason
data RevocationReason Source #
AACompromise | |
AffiliationChanged | |
CaCompromise | |
CertificateHold | |
CessationOfOperation | |
KeyCompromise | |
PrivilegeWithdrawn | |
RemoveFromCrl | |
Superceded | |
Unspecified |
CertificateDetail
data CertificateDetail Source #
Contains detailed metadata about an ACM Certificate. This structure is returned in the response to a DescribeCertificate
request.
See: certificateDetail
smart constructor.
certificateDetail :: CertificateDetail Source #
Creates a value of CertificateDetail
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cdSubject
- The name of the entity that is associated with the public key contained in the certificate.cdStatus
- The status of the certificate.cdFailureReason
- The reason the certificate request failed. This value exists only when the certificate status isFAILED
. For more information, see Certificate Request Failed in the AWS Certificate Manager User Guide .cdSubjectAlternativeNames
- 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.cdInUseBy
- A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.cdCreatedAt
- The time at which the certificate was requested. This value exists only when the certificate type isAMAZON_ISSUED
.cdCertificateARN
- The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .cdSerial
- The serial number of the certificate.cdImportedAt
- The date and time at which the certificate was imported. This value exists only when the certificate type isIMPORTED
.cdRevokedAt
- The time at which the certificate was revoked. This value exists only when the certificate status isREVOKED
.cdNotBefore
- The time before which the certificate is not valid.cdRevocationReason
- The reason the certificate was revoked. This value exists only when the certificate status isREVOKED
.cdDomainName
- The fully qualified domain name for the certificate, such as www.example.com or example.com.cdKeyAlgorithm
- The algorithm that was used to generate the key pair (the public and private key).cdType
- The source of the certificate. For certificates provided by ACM, this value isAMAZON_ISSUED
. For certificates that you imported withImportCertificate
, this value isIMPORTED
. 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 AWS Certificate Manager User Guide .cdIssuedAt
- The time at which the certificate was issued. This value exists only when the certificate type isAMAZON_ISSUED
.cdSignatureAlgorithm
- The algorithm that was used to sign the certificate.cdDomainValidationOptions
- Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type isAMAZON_ISSUED
.cdIssuer
- The name of the certificate authority that issued and signed the certificate.cdNotAfter
- The time after which the certificate is not valid.
cdSubject :: Lens' CertificateDetail (Maybe Text) Source #
The name of the entity that is associated with the public key contained in the certificate.
cdStatus :: Lens' CertificateDetail (Maybe CertificateStatus) Source #
The status of the certificate.
cdFailureReason :: Lens' CertificateDetail (Maybe FailureReason) Source #
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 AWS Certificate Manager User Guide .
cdSubjectAlternativeNames :: Lens' CertificateDetail (Maybe (NonEmpty Text)) Source #
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.
cdInUseBy :: Lens' CertificateDetail [Text] Source #
A list of ARNs for the AWS resources that are using the certificate. A certificate can be used by multiple AWS resources.
cdCreatedAt :: Lens' CertificateDetail (Maybe UTCTime) Source #
The time at which the certificate was requested. This value exists only when the certificate type is AMAZON_ISSUED
.
cdCertificateARN :: Lens' CertificateDetail (Maybe Text) Source #
The Amazon Resource Name (ARN) of the certificate. For more information about ARNs, see Amazon Resource Names (ARNs) and AWS Service Namespaces in the AWS General Reference .
cdImportedAt :: Lens' CertificateDetail (Maybe UTCTime) Source #
The date and time at which the certificate was imported. This value exists only when the certificate type is IMPORTED
.
cdRevokedAt :: Lens' CertificateDetail (Maybe UTCTime) Source #
The time at which the certificate was revoked. This value exists only when the certificate status is REVOKED
.
cdNotBefore :: Lens' CertificateDetail (Maybe UTCTime) Source #
The time before which the certificate is not valid.
cdRevocationReason :: Lens' CertificateDetail (Maybe RevocationReason) Source #
The reason the certificate was revoked. This value exists only when the certificate status is REVOKED
.
cdDomainName :: Lens' CertificateDetail (Maybe Text) Source #
The fully qualified domain name for the certificate, such as www.example.com or example.com.
cdKeyAlgorithm :: Lens' CertificateDetail (Maybe KeyAlgorithm) Source #
The algorithm that was used to generate the key pair (the public and private key).
cdType :: Lens' CertificateDetail (Maybe CertificateType) Source #
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 AWS Certificate Manager User Guide .
cdIssuedAt :: Lens' CertificateDetail (Maybe UTCTime) Source #
The time at which the certificate was issued. This value exists only when the certificate type is AMAZON_ISSUED
.
cdSignatureAlgorithm :: Lens' CertificateDetail (Maybe Text) Source #
The algorithm that was used to sign the certificate.
cdDomainValidationOptions :: Lens' CertificateDetail (Maybe (NonEmpty DomainValidation)) Source #
Contains information about the email address or addresses used for domain validation. This field exists only when the certificate type is AMAZON_ISSUED
.
cdIssuer :: Lens' CertificateDetail (Maybe Text) Source #
The name of the certificate authority that issued and signed the certificate.
cdNotAfter :: Lens' CertificateDetail (Maybe UTCTime) Source #
The time after which the certificate is not valid.
CertificateSummary
data CertificateSummary Source #
This structure is returned in the response object of ListCertificates
action.
See: certificateSummary
smart constructor.
certificateSummary :: CertificateSummary Source #
Creates a value of CertificateSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csCertificateARN
- 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) and AWS Service Namespaces .csDomainName
- Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
csCertificateARN :: Lens' CertificateSummary (Maybe Text) Source #
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) and AWS Service Namespaces .
csDomainName :: Lens' CertificateSummary (Maybe Text) Source #
Fully qualified domain name (FQDN), such as www.example.com or example.com, for the certificate.
DomainValidation
data DomainValidation Source #
Structure that contains the domain name, the base validation domain to which validation email is sent, and the email addresses used to validate the domain identity.
See: domainValidation
smart constructor.
Creates a value of DomainValidation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvValidationEmails
- A list of contact address for the domain registrant.dvValidationDomain
- The base validation domain that acts as the suffix of the email addresses that are used to send the emails.dvDomainName
- Fully Qualified Domain Name (FQDN) of the formwww.example.com or
example.com
.
dvValidationEmails :: Lens' DomainValidation [Text] Source #
A list of contact address for the domain registrant.
dvValidationDomain :: Lens' DomainValidation (Maybe Text) Source #
The base validation domain that acts as the suffix of the email addresses that are used to send the emails.
dvDomainName :: Lens' DomainValidation Text Source #
Fully Qualified Domain Name (FQDN) of the form www.example.com or
example.com
.
DomainValidationOption
data DomainValidationOption Source #
This structure is used in the request object of the RequestCertificate
action.
See: domainValidationOption
smart constructor.
domainValidationOption Source #
Creates a value of DomainValidationOption
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvoDomainName
- Fully Qualified Domain Name (FQDN) of the certificate being requested.dvoValidationDomain
- The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as theDomainName
value or a superdomain of theDomainName
value. For example, if you requested a certificate forsite.subdomain.example.com
and specify a ValidationDomain ofsubdomain.example.com
, ACM sends email to the domain registrant, technical contact, and administrative contact in WHOIS for the base domain and the following five addresses: * adminsubdomain.example.com * administrator
subdomain.example.com * hostmastersubdomain.example.com * postmaster
subdomain.example.com * webmaster@subdomain.example.com
dvoDomainName :: Lens' DomainValidationOption Text Source #
Fully Qualified Domain Name (FQDN) of the certificate being requested.
dvoValidationDomain :: Lens' DomainValidationOption Text Source #
The domain to which validation email is sent. This is the base validation domain that will act as the suffix of the email addresses. This must be the same as the DomainName
value or a superdomain of the DomainName
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 for the base domain and the following five addresses: * adminsubdomain.example.com * administrator
subdomain.example.com * hostmastersubdomain.example.com * postmaster
subdomain.example.com * webmaster@subdomain.example.com
Tag
A key-value pair that identifies or specifies metadata about an ACM resource.
See: tag
smart constructor.