Class: Aws::ACM::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ACM::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-acm/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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 a 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.
Instance Method Summary collapse
-
#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.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 429 def initialize(*args) super 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.
493 494 495 496 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 493 def (params = {}, = {}) req = build_request(:add_tags_to_certificate, params) req.send_request() 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.
535 536 537 538 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 535 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
633 634 635 636 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 633 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.
696 697 698 699 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 696 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.
716 717 718 719 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 716 def get_account_configuration(params = {}, = {}) req = build_request(:get_account_configuration, params) req.send_request() end |
#get_certificate(params = {}) ⇒ Types::GetCertificateResponse
Retrieves a certificate and its certificate chain. The certificate may
be either a public or private certificate issued using the ACM
RequestCertificate
action, or a certificate imported into ACM using
the ImportCertificate
action. 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.
766 767 768 769 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 766 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 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).
The certificate, private key, and certificate chain must be PEM-encoded.
The current time must be between the
Not Before
andNot 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 theC:\temp
folder asfileb://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.
883 884 885 886 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 883 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. By default, the
API returns RSA_2048 certificates. To return all certificates in the
account, include the keyType
filter with the values [RSA_1024,
RSA_2048, RSA_3072, RSA_4096, EC_prime256v1, EC_secp384r1,
EC_secp521r1]
.
In addition to keyType
, you can also filter by the
CertificateStatuses
, keyUsage
, and extendedKeyUsage
attributes
on the certificate. For more information, see Filters.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
978 979 980 981 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 978 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.
1021 1022 1023 1024 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1021 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.
1060 1061 1062 1063 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1060 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.
1109 1110 1111 1112 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1109 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.
1151 1152 1153 1154 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1151 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.
After successful completion of the RequestCertificate
action, there
is a delay of several seconds before you can retrieve information
about the new certificate.
1360 1361 1362 1363 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1360 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.
1429 1430 1431 1432 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1429 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.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1472 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 |
1582 1583 1584 1585 1586 |
# File 'gems/aws-sdk-acm/lib/aws-sdk-acm/client.rb', line 1582 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |