lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.3.0 vs lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.4.0

- old
+ new

@@ -153,11 +153,11 @@ super end # @!group API Operations - # Adds one or more tags to an ACM Certificate. Tags are labels that you + # Adds one or more tags to an ACM certificate. Tags are labels that you # can use to identify and organize your AWS 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. # @@ -165,24 +165,24 @@ # 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 + # 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][1]. + # [Tagging ACM certificates][1]. # # 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. # # # # [1]: http://docs.aws.amazon.com/acm/latest/userguide/tags.html # # @option params [required, String] :certificate_arn - # String that contains the ARN of the ACM Certificate to which the tag + # String that contains the ARN of the ACM certificate to which the tag # is to be applied. 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) and @@ -222,18 +222,18 @@ # 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 AWS services integrated with ACM. # - # <note markdown="1"> You cannot delete an ACM Certificate that is being used by another AWS + # <note markdown="1"> You cannot delete an ACM certificate that is being used by another AWS # service. To delete a certificate that is in use, the certificate # association must first be removed. # # </note> # # @option params [required, String] :certificate_arn - # String that contains the ARN of the ACM Certificate to be deleted. + # 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) and @@ -258,14 +258,14 @@ def delete_certificate(params = {}, options = {}) req = build_request(:delete_certificate, params) req.send_request(options) end - # Returns detailed metadata about the specified ACM Certificate. + # Returns detailed metadata about the specified ACM certificate. # # @option params [required, String] :certificate_arn - # The Amazon Resource Name (ARN) of the ACM Certificate. The ARN must + # 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) and @@ -332,10 +332,11 @@ # resp.certificate.key_usages #=> Array # resp.certificate.key_usages[0].name #=> String, one of "DIGITAL_SIGNATURE", "NON_REPUDIATION", "KEY_ENCIPHERMENT", "DATA_ENCIPHERMENT", "KEY_AGREEMENT", "CERTIFICATE_SIGNING", "CRL_SIGNING", "ENCIPHER_ONLY", "DECIPHER_ONLY", "ANY", "CUSTOM" # resp.certificate.extended_key_usages #=> Array # resp.certificate.extended_key_usages[0].name #=> String, one of "TLS_WEB_SERVER_AUTHENTICATION", "TLS_WEB_CLIENT_AUTHENTICATION", "CODE_SIGNING", "EMAIL_PROTECTION", "TIME_STAMPING", "OCSP_SIGNING", "IPSEC_END_SYSTEM", "IPSEC_TUNNEL", "IPSEC_USER", "ANY", "NONE", "CUSTOM" # resp.certificate.extended_key_usages[0].oid #=> String + # resp.certificate.options.certificate_transparency_logging_preference #=> String, one of "ENABLED", "DISABLED" # # @see http://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/DescribeCertificate AWS API Documentation # # @overload describe_certificate(params = {}) # @param [Hash] params ({}) @@ -546,17 +547,17 @@ def list_certificates(params = {}, options = {}) req = build_request(:list_certificates, params) req.send_request(options) end - # Lists the tags that have been applied to the ACM Certificate. Use the + # 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 + # To add a tag to an ACM certificate, use the AddTagsToCertificate # action. To delete a tag, use the RemoveTagsFromCertificate action. # # @option params [required, String] :certificate_arn - # String that contains the ARN of the ACM Certificate for which you want + # String that contains the ARN of the ACM certificate for which you want # to list the tags. This 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) and @@ -589,19 +590,19 @@ def list_tags_for_certificate(params = {}, options = {}) req = build_request(:list_tags_for_certificate, params) req.send_request(options) end - # Remove one or more tags from an ACM Certificate. A tag consists of a + # 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. + # certificate, use the ListTagsForCertificate action. # # @option params [required, String] :certificate_arn # String that contains the ARN of the ACM Certificate with one or more # tags that you want to remove. This must be of the form: # @@ -638,12 +639,12 @@ def remove_tags_from_certificate(params = {}, options = {}) req = build_request(:remove_tags_from_certificate, params) req.send_request(options) end - # Requests an ACM Certificate for use with other AWS services. To - # request an ACM Certificate, you must specify the fully qualified + # Requests an ACM certificate for use with other AWS services. To + # request an ACM certificate, you must specify the fully qualified # domain name (FQDN) for your site in the `DomainName` parameter. You # can also specify additional FQDNs in the `SubjectAlternativeNames` # parameter if users can reach your site by using other names. # # For each domain name you specify, email is sent to the domain owner to @@ -651,11 +652,11 @@ # registered contact addresses in the WHOIS database and to five common # system administration addresses formed from the `DomainName` you enter # or the optional `ValidationDomain` parameter. For more information, # see [Validate Domain Ownership][1]. # - # After receiving approval from the domain owner, the ACM Certificate is + # After receiving approval from the domain owner, the ACM certificate is # issued. For more information, see the [AWS Certificate Manager User # Guide][2]. # # # @@ -676,14 +677,14 @@ # @option params [String] :validation_method # The method you want to use to validate your domain. # # @option params [Array<String>] :subject_alternative_names # Additional FQDNs to be included in the Subject Alternative Name - # extension of the ACM Certificate. For example, add the 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 + # 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]. # # The maximum length of a SAN DNS name is 253 octets. The name is made @@ -717,10 +718,19 @@ # # @option params [Array<Types::DomainValidationOption>] :domain_validation_options # The domain name that you want ACM to use to send you emails so that # you can validate domain ownership. # + # @option params [Types::CertificateOptions] :options + # Currently, you can use this parameter to specify whether to add the + # certificate to a certificate transparency log. Certificate + # transparency makes it possible to detect SSL/TLS certificates that + # have been mistakenly or maliciously issued. Certificates that have not + # been logged typically produce an error message in a browser. For more + # information, see [ Opting Out of Certificate Transparency + # Logging](acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). + # # @return [Types::RequestCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RequestCertificateResponse#certificate_arn #certificate_arn} => String # # @example Request syntax with placeholder values @@ -734,10 +744,13 @@ # { # domain_name: "DomainNameString", # required # validation_domain: "DomainNameString", # required # }, # ], + # options: { + # certificate_transparency_logging_preference: "ENABLED", # accepts ENABLED, DISABLED + # }, # }) # # @example Response structure # # resp.certificate_arn #=> String @@ -751,16 +764,16 @@ req.send_request(options) end # 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 + # 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 + # 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]. # @@ -818,10 +831,50 @@ def resend_validation_email(params = {}, options = {}) req = build_request(:resend_validation_email, params) req.send_request(options) end + # 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](acm/latest/userguide/acm-bestpractices.html#best-practices-transparency). + # + # @option params [required, String] :certificate_arn + # ARN of the requested certificate to update. This must be of the form: + # + # `arn:aws:acm:us-east-1:account:certificate/12345678-1234-1234-1234-123456789012 + # ` + # + # @option params [required, Types::CertificateOptions] :options + # Use to update the options for your certificate. Currently, you can + # specify whether to add your certificate to a transparency log. + # Certificate transparency makes it possible to detect SSL/TLS + # certificates that have been mistakenly or maliciously issued. + # Certificates that have not been logged typically produce an error + # message in a browser. + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.update_certificate_options({ + # certificate_arn: "Arn", # required + # options: { # required + # certificate_transparency_logging_preference: "ENABLED", # accepts ENABLED, DISABLED + # }, + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/UpdateCertificateOptions AWS API Documentation + # + # @overload update_certificate_options(params = {}) + # @param [Hash] params ({}) + def update_certificate_options(params = {}, options = {}) + req = build_request(:update_certificate_options, params) + req.send_request(options) + end + # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) @@ -831,10 +884,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-acm' - context[:gem_version] = '1.3.0' + context[:gem_version] = '1.4.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated