/* * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ /* * Do not modify this file. This file is generated from the acm-2015-12-08.normal.json service model. */ using System; using System.Threading; using System.Threading.Tasks; using System.Collections.Generic; using Amazon.Runtime; using Amazon.CertificateManager.Model; namespace Amazon.CertificateManager { ///

/// Interface for accessing CertificateManager /// /// 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. /// ///

public partial interface IAmazonCertificateManager : IAmazonService, IDisposable { #if AWS_ASYNC_ENUMERABLES_API ///

/// Paginators for the service ///

ICertificateManagerPaginatorFactory Paginators { get; } #endif #region AddTagsToCertificate ///

/// Adds one or more tags to an ACM certificate. Tags are labels that you can use to identify /// and organize your Amazon Web Services resources. Each tag consists of a key /// and an optional value. You specify the certificate on input by its Amazon /// Resource Name (ARN). You specify the tag by using a key-value pair. /// /// /// /// You can apply a tag to just one certificate if you want to identify a specific characteristic /// of that certificate, or you can apply the same tag to multiple certificates if you /// want to filter for a common relationship among those certificates. Similarly, you /// can apply the same tag to multiple resources if you want to specify a relationship /// among those resources. For example, you can add the same tag to an ACM certificate /// and an Elastic Load Balancing load balancer to indicate that they are both used by /// the same website. For more information, see Tagging /// ACM certificates. /// /// /// /// To remove one or more tags, use the RemoveTagsFromCertificate action. To view /// all of the tags that have been applied to the certificate, use the ListTagsForCertificate /// action. /// ///

/// Container for the necessary parameters to execute the AddTagsToCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the AddTagsToCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// An input parameter was invalid. /// /// /// 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:. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// /// A specified tag did not comply with an existing tag policy and was rejected. /// /// /// The request was denied because it exceeded a quota. /// /// /// The request contains too many tags. Try the request again with fewer tags. /// /// REST API Reference for AddTagsToCertificate Operation Task AddTagsToCertificateAsync(AddTagsToCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DeleteCertificate ///

/// Deletes a certificate and its associated private key. If this action succeeds, the /// certificate no longer appears in the list that can be displayed by calling the ListCertificates /// action or be retrieved by calling the GetCertificate action. The certificate /// will not be available for use by Amazon Web Services services integrated with ACM. /// /// /// /// /// You cannot delete an ACM certificate that is being used by another Amazon Web Services /// service. To delete a certificate that is in use, the certificate association must /// first be removed. /// /// ///

/// 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). /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCertificate service method, as returned by CertificateManager. /// /// You do not have access required to perform this action. /// /// /// 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. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The certificate is in use by another Amazon Web Services service in the caller's account. /// Remove the association and try again. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// /// The request was denied because it exceeded a quota. /// /// REST API Reference for DeleteCertificate Operation Task DeleteCertificateAsync(string certificateArn, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); ///

/// Container for the necessary parameters to execute the DeleteCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DeleteCertificate service method, as returned by CertificateManager. /// /// You do not have access required to perform this action. /// /// /// 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. /// /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The certificate is in use by another Amazon Web Services service in the caller's account. /// Remove the association and try again. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// /// The request was denied because it exceeded a quota. /// /// REST API Reference for DeleteCertificate Operation Task DeleteCertificateAsync(DeleteCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region DescribeCertificate ///

/// Returns detailed metadata about the specified ACM certificate. /// /// /// /// If you have just created a certificate using the RequestCertificate action, /// there is a delay of several seconds before you can retrieve information about it. /// ///

/// 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). /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for DescribeCertificate Operation Task DescribeCertificateAsync(string certificateArn, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); ///

/// Container for the necessary parameters to execute the DescribeCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the DescribeCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for DescribeCertificate Operation Task DescribeCertificateAsync(DescribeCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ExportCertificate ///

/// Exports a private certificate issued by a private certificate authority (CA) for use /// anywhere. The exported file contains the certificate, the certificate chain, and the /// encrypted private 2048-bit RSA key associated with the public key that is embedded /// in the certificate. For security, you must assign a passphrase for the private key /// when exporting it. /// /// /// /// For information about exporting and formatting a certificate using the ACM console /// or CLI, see Export /// a Private Certificate. /// ///

/// Container for the necessary parameters to execute the ExportCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ExportCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The certificate request is in process and the certificate in your account has not /// yet been issued. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for ExportCertificate Operation Task ExportCertificateAsync(ExportCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetAccountConfiguration ///

/// Returns the account configuration options associated with an Amazon Web Services account. ///

/// Container for the necessary parameters to execute the GetAccountConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetAccountConfiguration service method, as returned by CertificateManager. /// /// You do not have access required to perform this action. /// /// /// The request was denied because it exceeded a quota. /// /// REST API Reference for GetAccountConfiguration Operation Task GetAccountConfigurationAsync(GetAccountConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region GetCertificate ///

/// Retrieves an Amazon-issued certificate and its certificate chain. The chain consists /// of the certificate of the issuing CA and the intermediate certificates of any other /// subordinate CAs. All of the certificates are base64 encoded. You can use OpenSSL /// to decode the certificates and inspect individual fields. ///

/// 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). /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The certificate request is in process and the certificate in your account has not /// yet been issued. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for GetCertificate Operation Task GetCertificateAsync(string certificateArn, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); ///

/// Container for the necessary parameters to execute the GetCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the GetCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The certificate request is in process and the certificate in your account has not /// yet been issued. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for GetCertificate Operation Task GetCertificateAsync(GetCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ImportCertificate ///

/// Imports a certificate into Certificate Manager (ACM) to use with services that are /// integrated with ACM. Note that integrated /// services allow only certificate types and keys they support to be associated with /// their resources. Further, their support differs depending on whether the certificate /// is imported into IAM or into ACM. For more information, see the documentation for /// each service. For more information about importing certificates into ACM, see Importing /// Certificates in the Certificate Manager User Guide. /// /// /// /// ACM does not provide managed /// renewal for certificates that you import. /// /// /// /// Note the following guidelines when importing third party certificates: /// ///

/// /// You must enter the private key that matches the certificate you are importing. /// ///
/// /// The private key must be unencrypted. You cannot import a private key that is protected /// by a password or a passphrase. /// ///
/// /// The private key must be no larger than 5 KB (5,120 bytes). /// ///
/// /// If the certificate you are importing is not self-signed, you must enter its certificate /// chain. /// ///
/// /// If a certificate chain is included, the issuer must be the subject of one of the certificates /// in the chain. /// ///
/// /// The certificate, private key, and certificate chain must be PEM-encoded. /// ///
/// /// The current time must be between the Not Before and Not After /// certificate fields. /// ///
/// /// The Issuer field must not be empty. /// ///
/// /// The OCSP authority URL, if present, must not exceed 1000 characters. /// ///
/// /// To import a new certificate, omit the CertificateArn argument. Include /// this argument only when you want to replace a previously imported certificate. /// ///
/// /// When you import a certificate by using the CLI, you must specify the certificate, /// the certificate chain, and the private key by their file names preceded by fileb://. /// For example, you can specify a certificate saved in the C:\temp folder /// as fileb://C:\temp\certificate_to_import.pem. If you are making an HTTP /// or HTTPS Query request, include these arguments as BLOBs. /// ///
/// /// When you import a certificate by using an SDK, you must specify the certificate, the /// certificate chain, and the private key files in the manner required by the programming /// language you're using. /// ///
/// /// The cryptographic algorithm of an imported certificate must match the algorithm of /// the signing CA. For example, if the signing CA key type is RSA, then the certificate /// key type must also be RSA. /// ///

/// /// This operation returns the Amazon /// Resource Name (ARN) of the imported certificate. /// ///

/// Container for the necessary parameters to execute the ImportCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ImportCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// An input parameter was invalid. /// /// /// 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:. /// /// /// An ACM quota has been exceeded. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// /// A specified tag did not comply with an existing tag policy and was rejected. /// /// /// The request contains too many tags. Try the request again with fewer tags. /// /// REST API Reference for ImportCertificate Operation Task ImportCertificateAsync(ImportCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListCertificates ///

/// Retrieves a list of certificate ARNs and domain names. You can request that only certificates /// that match a specific status be listed. You can also filter by specific attributes /// of the certificate. Default filtering returns only RSA_2048 certificates. /// For more information, see Filters. ///

/// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListCertificates service method, as returned by CertificateManager. /// /// One or more of of request parameters specified is not valid. /// /// /// The supplied input failed to satisfy constraints of an Amazon Web Services service. /// /// REST API Reference for ListCertificates Operation Task ListCertificatesAsync(System.Threading.CancellationToken cancellationToken = default(CancellationToken)); ///

/// Container for the necessary parameters to execute the ListCertificates service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListCertificates service method, as returned by CertificateManager. /// /// One or more of of request parameters specified is not valid. /// /// /// The supplied input failed to satisfy constraints of an Amazon Web Services service. /// /// REST API Reference for ListCertificates Operation Task ListCertificatesAsync(ListCertificatesRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ListTagsForCertificate ///

/// Lists the tags that have been applied to the ACM certificate. Use the certificate's /// Amazon Resource Name (ARN) to specify the certificate. To add a tag to an ACM certificate, /// use the AddTagsToCertificate action. To delete a tag, use the RemoveTagsFromCertificate /// action. ///

/// Container for the necessary parameters to execute the ListTagsForCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ListTagsForCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for ListTagsForCertificate Operation Task ListTagsForCertificateAsync(ListTagsForCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region PutAccountConfiguration ///

/// Adds or modifies account-level configurations in ACM. /// /// /// /// The supported configuration option is DaysBeforeExpiry. This option 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. /// ///

/// Container for the necessary parameters to execute the PutAccountConfiguration service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the PutAccountConfiguration service method, as returned by CertificateManager. /// /// You do not have access required to perform this action. /// /// /// 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. /// /// /// The request was denied because it exceeded a quota. /// /// /// The supplied input failed to satisfy constraints of an Amazon Web Services service. /// /// REST API Reference for PutAccountConfiguration Operation Task PutAccountConfigurationAsync(PutAccountConfigurationRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RemoveTagsFromCertificate ///

/// Remove one or more tags from an ACM certificate. A tag consists of a key-value pair. /// If you do not specify the value portion of the tag when calling this function, the /// tag will be removed regardless of value. If you specify a value, the tag is removed /// only if it is associated with the specified value. /// /// /// /// To add tags to a certificate, use the AddTagsToCertificate action. To view /// all of the tags that have been applied to a specific ACM certificate, use the ListTagsForCertificate /// action. /// ///

/// Container for the necessary parameters to execute the RemoveTagsFromCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RemoveTagsFromCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// An input parameter was invalid. /// /// /// 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:. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// /// A specified tag did not comply with an existing tag policy and was rejected. /// /// /// The request was denied because it exceeded a quota. /// /// REST API Reference for RemoveTagsFromCertificate Operation Task RemoveTagsFromCertificateAsync(RemoveTagsFromCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RenewCertificate ///

/// Renews an eligible ACM certificate. At this time, only exported private certificates /// can be renewed with this operation. In order to renew your Amazon Web Services Private /// CA certificates with ACM, you must first grant /// the ACM service principal permission to do so. For more information, see Testing /// Managed Renewal in the ACM User Guide. ///

/// Container for the necessary parameters to execute the RenewCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RenewCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for RenewCertificate Operation Task RenewCertificateAsync(RenewCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region RequestCertificate ///

/// Requests an ACM certificate for use with other Amazon Web Services services. To request /// an ACM certificate, you must specify a fully qualified domain name (FQDN) in the DomainName /// parameter. You can also specify additional FQDNs in the SubjectAlternativeNames /// parameter. /// /// /// /// If you are requesting a private certificate, domain validation is not required. If /// you are requesting a public certificate, each domain name that you specify must be /// validated to verify that you own or control the domain. You can use DNS /// validation or email /// validation. We recommend that you use DNS validation. ACM issues public certificates /// after receiving approval from the domain owner. /// /// /// /// ACM behavior differs from the RFC /// 6125 specification of the certificate validation process. ACM first checks for /// a Subject Alternative Name, and, if it finds one, ignores the common name (CN). /// /// /// /// After successful completion of the RequestCertificate action, there is /// a delay of several seconds before you can retrieve information about the new certificate. /// ///

/// 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. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RequestCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// One or more values in the DomainValidationOption structure is incorrect. /// /// /// An input parameter was invalid. /// /// /// 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:. /// /// /// An ACM quota has been exceeded. /// /// /// A specified tag did not comply with an existing tag policy and was rejected. /// /// /// The request contains too many tags. Try the request again with fewer tags. /// /// REST API Reference for RequestCertificate Operation Task RequestCertificateAsync(string domainName, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); ///

/// Container for the necessary parameters to execute the RequestCertificate service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the RequestCertificate service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// One or more values in the DomainValidationOption structure is incorrect. /// /// /// An input parameter was invalid. /// /// /// 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:. /// /// /// An ACM quota has been exceeded. /// /// /// A specified tag did not comply with an existing tag policy and was rejected. /// /// /// The request contains too many tags. Try the request again with fewer tags. /// /// REST API Reference for RequestCertificate Operation Task RequestCertificateAsync(RequestCertificateRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region ResendValidationEmail ///

/// Resends the email that requests domain ownership validation. The domain owner or an /// authorized representative must approve the ACM certificate before it can be issued. /// The certificate can be approved by clicking a link in the mail to navigate to the /// Amazon certificate approval website and then clicking I Approve. However, the /// validation email can be blocked by spam filters. Therefore, if you do not receive /// the original mail, you can request that the mail be resent within 72 hours of requesting /// the ACM certificate. If more than 72 hours have elapsed since your original request /// or since your last attempt to resend validation mail, you must request a new certificate. /// For more information about setting up your contact email addresses, see Configure /// Email for your Domain. ///

/// Container for the necessary parameters to execute the ResendValidationEmail service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the ResendValidationEmail service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// One or more values in the DomainValidationOption structure is incorrect. /// /// /// Processing has reached an invalid state. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for ResendValidationEmail Operation Task ResendValidationEmailAsync(ResendValidationEmailRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion #region UpdateCertificateOptions ///

/// Updates a certificate. Currently, you can use this function to specify whether to /// opt in to or out of recording your certificate in a certificate transparency log. /// For more information, see /// Opting Out of Certificate Transparency Logging. ///

/// Container for the necessary parameters to execute the UpdateCertificateOptions service method. /// /// A cancellation token that can be used by other objects or threads to receive notice of cancellation. /// /// /// The response from the UpdateCertificateOptions service method, as returned by CertificateManager. /// /// The requested Amazon Resource Name (ARN) does not refer to an existing resource. /// /// /// Processing has reached an invalid state. /// /// /// An ACM quota has been exceeded. /// /// /// The specified certificate cannot be found in the caller's account or the caller's /// account cannot be found. /// /// REST API Reference for UpdateCertificateOptions Operation Task UpdateCertificateOptionsAsync(UpdateCertificateOptionsRequest request, System.Threading.CancellationToken cancellationToken = default(CancellationToken)); #endregion } }