Class: Aws::ACM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ACM::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-acm/client.rb
Overview
An API client for ACM. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ACM::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#add_tags_to_certificate(params = {}) ⇒ Struct
Adds one or more tags to an ACM certificate.
-
#delete_certificate(params = {}) ⇒ Struct
Deletes a certificate and its associated private key.
-
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
Returns detailed metadata about the specified ACM certificate.
-
#export_certificate(params = {}) ⇒ Types::ExportCertificateResponse
Exports a private certificate issued by a private certificate authority (CA) for use anywhere.
-
#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse
Returns the account configuration options associated with an Amazon Web Services account.
-
#get_certificate(params = {}) ⇒ Types::GetCertificateResponse
Retrieves an Amazon-issued certificate and its certificate chain.
-
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
Imports a certificate into Certificate Manager (ACM) to use with services that are integrated with ACM.
-
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
Retrieves a list of certificate ARNs and domain names.
-
#list_tags_for_certificate(params = {}) ⇒ Types::ListTagsForCertificateResponse
Lists the tags that have been applied to the ACM certificate.
-
#put_account_configuration(params = {}) ⇒ Struct
Adds or modifies account-level configurations in ACM.
-
#remove_tags_from_certificate(params = {}) ⇒ Struct
Remove one or more tags from an ACM certificate.
-
#renew_certificate(params = {}) ⇒ Struct
Renews an eligible ACM certificate.
-
#request_certificate(params = {}) ⇒ Types::RequestCertificateResponse
Requests an ACM certificate for use with other Amazon Web Services services.
-
#resend_validation_email(params = {}) ⇒ Struct
Resends the email that requests domain ownership validation.
-
#update_certificate_options(params = {}) ⇒ Struct
Updates a certificate.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'lib/aws-sdk-acm/client.rb', line 419 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1582 1583 1584 |
# File 'lib/aws-sdk-acm/client.rb', line 1582 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1585 1586 1587 |
# File 'lib/aws-sdk-acm/client.rb', line 1585 def errors_module Errors end |
Instance Method Details
#add_tags_to_certificate(params = {}) ⇒ Struct
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.
483 484 485 486 |
# File 'lib/aws-sdk-acm/client.rb', line 483 def (params = {}, = {}) req = build_request(:add_tags_to_certificate, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 |
# File 'lib/aws-sdk-acm/client.rb', line 1447 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-acm' context[:gem_version] = '1.66.0' Seahorse::Client::Request.new(handlers, context) end |
#delete_certificate(params = {}) ⇒ Struct
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.
<note markdown=“1”> 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.
</note>
525 526 527 528 |
# File 'lib/aws-sdk-acm/client.rb', line 525 def delete_certificate(params = {}, = {}) req = build_request(:delete_certificate, params) req.send_request() end |
#describe_certificate(params = {}) ⇒ Types::DescribeCertificateResponse
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 following waiters are defined for this operation (see #wait_until for detailed usage):
* certificate_validated
623 624 625 626 |
# File 'lib/aws-sdk-acm/client.rb', line 623 def describe_certificate(params = {}, = {}) req = build_request(:describe_certificate, params) req.send_request() end |
#export_certificate(params = {}) ⇒ Types::ExportCertificateResponse
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].
[1]: docs.aws.amazon.com/acm/latest/userguide/gs-acm-export-private.html
686 687 688 689 |
# File 'lib/aws-sdk-acm/client.rb', line 686 def export_certificate(params = {}, = {}) req = build_request(:export_certificate, params) req.send_request() end |
#get_account_configuration(params = {}) ⇒ Types::GetAccountConfigurationResponse
Returns the account configuration options associated with an Amazon Web Services account.
706 707 708 709 |
# File 'lib/aws-sdk-acm/client.rb', line 706 def get_account_configuration(params = {}, = {}) req = build_request(:get_account_configuration, params) req.send_request() end |
#get_certificate(params = {}) ⇒ Types::GetCertificateResponse
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.
753 754 755 756 |
# File 'lib/aws-sdk-acm/client.rb', line 753 def get_certificate(params = {}, = {}) req = build_request(:get_certificate, params) req.send_request() end |
#import_certificate(params = {}) ⇒ Types::ImportCertificateResponse
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*.
<note markdown=“1”> ACM does not provide [managed renewal] for certificates that you import.
</note>
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:tempcertificate_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.
[1]: docs.aws.amazon.com/acm/latest/userguide/acm-services.html [2]: docs.aws.amazon.com/acm/latest/userguide/import-certificate.html [3]: docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html [4]: docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
876 877 878 879 |
# File 'lib/aws-sdk-acm/client.rb', line 876 def import_certificate(params = {}, = {}) req = build_request(:import_certificate, params) req.send_request() end |
#list_certificates(params = {}) ⇒ Types::ListCertificatesResponse
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
967 968 969 970 |
# File 'lib/aws-sdk-acm/client.rb', line 967 def list_certificates(params = {}, = {}) req = build_request(:list_certificates, params) req.send_request() end |
#list_tags_for_certificate(params = {}) ⇒ Types::ListTagsForCertificateResponse
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.
1010 1011 1012 1013 |
# File 'lib/aws-sdk-acm/client.rb', line 1010 def (params = {}, = {}) req = build_request(:list_tags_for_certificate, params) req.send_request() end |
#put_account_configuration(params = {}) ⇒ Struct
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.
1049 1050 1051 1052 |
# File 'lib/aws-sdk-acm/client.rb', line 1049 def put_account_configuration(params = {}, = {}) req = build_request(:put_account_configuration, params) req.send_request() end |
#remove_tags_from_certificate(params = {}) ⇒ Struct
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.
1098 1099 1100 1101 |
# File 'lib/aws-sdk-acm/client.rb', line 1098 def (params = {}, = {}) req = build_request(:remove_tags_from_certificate, params) req.send_request() end |
#renew_certificate(params = {}) ⇒ Struct
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.
[1]: docs.aws.amazon.com/privateca/latest/userguide/PcaPermissions.html [2]: docs.aws.amazon.com/acm/latest/userguide/manual-renewal.html
1140 1141 1142 1143 |
# File 'lib/aws-sdk-acm/client.rb', line 1140 def renew_certificate(params = {}, = {}) req = build_request(:renew_certificate, params) req.send_request() end |
#request_certificate(params = {}) ⇒ Types::RequestCertificateResponse
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.
<note markdown=“1”> 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).
</note>
After successful completion of the ‘RequestCertificate` action, there is a delay of several seconds before you can retrieve information about the new certificate.
[1]: docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html [2]: docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html [3]: datatracker.ietf.org/doc/html/rfc6125#appendix-B.2
1326 1327 1328 1329 |
# File 'lib/aws-sdk-acm/client.rb', line 1326 def request_certificate(params = {}, = {}) req = build_request(:request_certificate, params) req.send_request() end |
#resend_validation_email(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/acm/latest/userguide/setup-email.html
1395 1396 1397 1398 |
# File 'lib/aws-sdk-acm/client.rb', line 1395 def resend_validation_email(params = {}, = {}) req = build_request(:resend_validation_email, params) req.send_request() end |
#update_certificate_options(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency
1438 1439 1440 1441 |
# File 'lib/aws-sdk-acm/client.rb', line 1438 def (params = {}, = {}) req = build_request(:update_certificate_options, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ——————— | —————————– | ——– | ————- | | certificate_validated | #describe_certificate | 60 | 40 |
1548 1549 1550 1551 1552 |
# File 'lib/aws-sdk-acm/client.rb', line 1548 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1556 1557 1558 |
# File 'lib/aws-sdk-acm/client.rb', line 1556 def waiter_names waiters.keys end |