lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.28.0 vs lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.29.0
- old
+ new
@@ -30,15 +30,15 @@
Aws::Plugins::GlobalConfiguration.add_identifier(:acm)
module Aws::ACM
# 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,
- # # ...
- # )
+ # 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.
@@ -227,20 +227,24 @@
# used by the default backoff function. This option is only used in the
# `legacy` retry mode.
#
# @option options [String] :retry_mode ("legacy")
# Specifies which retry algorithm to use. Values are:
- # * `legacy` - The pre-existing retry behavior. This is default value if
- # no retry mode is provided.
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
- # This includes support for retry quotas, which limit the number of
- # unsuccessful retries a client can make.
- # * `adaptive` - An experimental retry mode that includes all the
- # functionality of `standard` mode along with automatic client side
- # throttling. This is a provisional mode that may change behavior
- # in the future.
#
+ # * `legacy` - The pre-existing retry behavior. This is default value if
+ # no retry mode is provided.
+ #
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
+ # This includes support for retry quotas, which limit the number of
+ # unsuccessful retries a client can make.
+ #
+ # * `adaptive` - An experimental retry mode that includes all the
+ # functionality of `standard` mode along with automatic client side
+ # throttling. This is a provisional mode that may change behavior
+ # in the future.
+ #
+ #
# @option options [String] :secret_access_key
#
# @option options [String] :session_token
#
# @option options [Boolean] :simple_json (false)
@@ -498,10 +502,15 @@
# resp.certificate.extended_key_usages[0].oid #=> String
# resp.certificate.certificate_authority_arn #=> String
# resp.certificate.renewal_eligibility #=> String, one of "ELIGIBLE", "INELIGIBLE"
# resp.certificate.options.certificate_transparency_logging_preference #=> String, one of "ENABLED", "DISABLED"
#
+ #
+ # The following waiters are defined for this operation (see {Client#wait_for} for detailed usage):
+ #
+ # * certificate_validated
+ #
# @see http://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/DescribeCertificate AWS API Documentation
#
# @overload describe_certificate(params = {})
# @param [Hash] params ({})
def describe_certificate(params = {}, options = {})
@@ -563,17 +572,20 @@
def export_certificate(params = {}, options = {})
req = build_request(:export_certificate, params)
req.send_request(options)
end
- # Retrieves a certificate specified by an ARN and its certificate chain
- # . The chain is an ordered list of certificates that contains the end
- # entity certificate, intermediate certificates of subordinate CAs, and
- # the root certificate in that order. The certificate and certificate
- # chain are base64 encoded. If you want to decode the certificate to see
- # the individual fields, you can use OpenSSL.
+ # 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][1] to decode
+ # the certificates and inspect individual fields.
#
+ #
+ #
+ # [1]: https://wiki.openssl.org/index.php/Command_Line_Utilities
+ #
# @option params [required, String] :certificate_arn
# String that contains a certificate ARN in the following format:
#
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
#
@@ -759,10 +771,12 @@
# @return [Types::ListCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
#
# * {Types::ListCertificatesResponse#next_token #next_token} => String
# * {Types::ListCertificatesResponse#certificate_summary_list #certificate_summary_list} => Array<Types::CertificateSummary>
#
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+ #
# @example Request syntax with placeholder values
#
# resp = client.list_certificates({
# certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED
# includes: {
@@ -966,13 +980,13 @@
# 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 limit is 10 domain names. If you need
- # more than 10 names, you must request a limit increase. For more
- # information, see [Limits][1].
+ # 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][1].
#
# 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:
#
@@ -1199,10 +1213,10 @@
operation: config.api.operation(operation_name),
client: self,
params: params,
config: config)
context[:gem_name] = 'aws-sdk-acm'
- context[:gem_version] = '1.28.0'
+ context[:gem_version] = '1.29.0'
Seahorse::Client::Request.new(handlers, context)
end
# Polls an API operation until a resource enters a desired state.
#