lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.14.0 vs lib/aws-sdk-acm/client.rb in aws-sdk-acm-1.15.0

- old
+ new

@@ -235,11 +235,11 @@ # 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 + # [1]: https://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 # is to be applied. This must be of the form: # @@ -248,11 +248,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [required, Array<Types::Tag>] :tags # The key-value pair that defines the tag. The tag value is optional. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -299,11 +299,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # @@ -331,11 +331,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @return [Types::DescribeCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeCertificateResponse#certificate #certificate} => Types::CertificateDetail # @@ -374,11 +374,11 @@ # resp.certificate.not_after #=> Time # resp.certificate.key_algorithm #=> String, one of "RSA_2048", "RSA_1024", "RSA_4096", "EC_prime256v1", "EC_secp384r1", "EC_secp521r1" # resp.certificate.signature_algorithm #=> String # resp.certificate.in_use_by #=> Array # resp.certificate.in_use_by[0] #=> String - # resp.certificate.failure_reason #=> String, one of "NO_AVAILABLE_CONTACTS", "ADDITIONAL_VERIFICATION_REQUIRED", "DOMAIN_NOT_ALLOWED", "INVALID_PUBLIC_DOMAIN", "CAA_ERROR", "PCA_LIMIT_EXCEEDED", "PCA_INVALID_ARN", "PCA_INVALID_STATE", "PCA_REQUEST_FAILED", "PCA_RESOURCE_NOT_FOUND", "PCA_INVALID_ARGS", "OTHER" + # resp.certificate.failure_reason #=> String, one of "NO_AVAILABLE_CONTACTS", "ADDITIONAL_VERIFICATION_REQUIRED", "DOMAIN_NOT_ALLOWED", "INVALID_PUBLIC_DOMAIN", "DOMAIN_VALIDATION_DENIED", "CAA_ERROR", "PCA_LIMIT_EXCEEDED", "PCA_INVALID_ARN", "PCA_INVALID_STATE", "PCA_REQUEST_FAILED", "PCA_RESOURCE_NOT_FOUND", "PCA_INVALID_ARGS", "PCA_INVALID_DURATION", "PCA_ACCESS_DENIED", "OTHER" # resp.certificate.type #=> String, one of "IMPORTED", "AMAZON_ISSUED", "PRIVATE" # resp.certificate.renewal_summary.renewal_status #=> String, one of "PENDING_AUTO_RENEWAL", "PENDING_VALIDATION", "SUCCESS", "FAILED" # resp.certificate.renewal_summary.domain_validation_options #=> Array # resp.certificate.renewal_summary.domain_validation_options[0].domain_name #=> String # resp.certificate.renewal_summary.domain_validation_options[0].validation_emails #=> Array @@ -387,10 +387,12 @@ # resp.certificate.renewal_summary.domain_validation_options[0].validation_status #=> String, one of "PENDING_VALIDATION", "SUCCESS", "FAILED" # resp.certificate.renewal_summary.domain_validation_options[0].resource_record.name #=> String # resp.certificate.renewal_summary.domain_validation_options[0].resource_record.type #=> String, one of "CNAME" # resp.certificate.renewal_summary.domain_validation_options[0].resource_record.value #=> String # resp.certificate.renewal_summary.domain_validation_options[0].validation_method #=> String, one of "EMAIL", "DNS" + # resp.certificate.renewal_summary.renewal_status_reason #=> String, one of "NO_AVAILABLE_CONTACTS", "ADDITIONAL_VERIFICATION_REQUIRED", "DOMAIN_NOT_ALLOWED", "INVALID_PUBLIC_DOMAIN", "DOMAIN_VALIDATION_DENIED", "CAA_ERROR", "PCA_LIMIT_EXCEEDED", "PCA_INVALID_ARN", "PCA_INVALID_STATE", "PCA_REQUEST_FAILED", "PCA_RESOURCE_NOT_FOUND", "PCA_INVALID_ARGS", "PCA_INVALID_DURATION", "PCA_ACCESS_DENIED", "OTHER" + # resp.certificate.renewal_summary.updated_at #=> Time # 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 @@ -475,11 +477,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @return [Types::GetCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetCertificateResponse#certificate #certificate} => String # * {Types::GetCertificateResponse#certificate_chain #certificate_chain} => String @@ -560,22 +562,22 @@ # This operation returns the [Amazon Resource Name (ARN)][4] of the # imported certificate. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html - # [2]: http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html - # [3]: http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html - # [4]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/acm-services.html + # [2]: https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html + # [3]: https://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html + # [4]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [String] :certificate_arn # The [Amazon Resource Name (ARN)][1] of an imported certificate to # replace. To import a new certificate, omit this field. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [required, String, IO] :certificate # The certificate to import. # # @option params [required, String, IO] :private_key @@ -682,11 +684,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @return [Types::ListTagsForCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForCertificateResponse#tags #tags} => Array&lt;Types::Tag&gt; # @@ -730,11 +732,11 @@ # For more information about ARNs, see [Amazon Resource Names (ARNs) and # AWS Service Namespaces][1]. # # # - # [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html # # @option params [required, Array<Types::Tag>] :tags # The key-value pair that defines the tag to remove. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. @@ -758,10 +760,49 @@ def remove_tags_from_certificate(params = {}, options = {}) req = build_request(:remove_tags_from_certificate, params) req.send_request(options) end + # Renews an eligable ACM certificate. At this time, only exported + # private certificates can be renewed with this operation. In order to + # renew your ACM PCA certificates with ACM, you must first [grant the + # ACM service principal permission to do + # so](acm-pca/latest/userguide/PcaPermissions.html). For more + # information, see [Testing Managed + # Renewal](acm/latest/userguide/manuel-renewal.html) in the ACM User + # Guide. + # + # @option params [required, String] :certificate_arn + # String that contains the ARN of the ACM certificate to be renewed. + # 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 + # AWS Service Namespaces][1]. + # + # + # + # [1]: https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html + # + # @return [Struct] Returns an empty {Seahorse::Client::Response response}. + # + # @example Request syntax with placeholder values + # + # resp = client.renew_certificate({ + # certificate_arn: "Arn", # required + # }) + # + # @see http://docs.aws.amazon.com/goto/WebAPI/acm-2015-12-08/RenewCertificate AWS API Documentation + # + # @overload renew_certificate(params = {}) + # @param [Hash] params ({}) + def renew_certificate(params = {}, options = {}) + req = build_request(:renew_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 a fully qualified domain # name (FQDN) in the `DomainName` parameter. You can also specify # additional FQDNs in the `SubjectAlternativeNames` parameter. # @@ -772,12 +813,12 @@ # We recommend that you use DNS validation. ACM issues public # certificates after receiving approval from the domain owner. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html - # [2]: http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html + # [2]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html # # @option params [required, String] :domain_name # 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. @@ -794,12 +835,12 @@ # DNS][1] or [validate with email][2]. We recommend that you use DNS # validation. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html - # [2]: http://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html + # [2]: https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html # # @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 # www.example.net to a certificate for which the `DomainName` field is @@ -825,11 +866,11 @@ # because the total length of the DNS name (63+1+63+1+63+1+62) exceeds # 253 octets. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html # # @option params [String] :idempotency_token # Customer chosen string that can be used to distinguish between calls # to `RequestCertificate`. Idempotency tokens time out after one hour. # Therefore, if you call `RequestCertificate` multiple times with the @@ -850,11 +891,11 @@ # been logged typically produce an error message in a browser. For more # information, see [Opting Out of Certificate Transparency Logging][1]. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency # # @option params [String] :certificate_authority_arn # The Amazon Resource Name (ARN) of the private certificate authority # (CA) that will be used to issue the certificate. If you do not provide # an ARN and you are trying to request a private certificate, ACM will @@ -864,11 +905,11 @@ # # `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012` # # # - # [1]: http://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html + # [1]: https://docs.aws.amazon.com/acm-pca/latest/userguide/PcaWelcome.html # # @return [Types::RequestCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RequestCertificateResponse#certificate_arn #certificate_arn} => String # @@ -917,11 +958,11 @@ # For more information about setting up your contact email addresses, # see [Configure Email for your Domain][1]. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html + # [1]: https://docs.aws.amazon.com/acm/latest/userguide/setup-email.html # # @option params [required, String] :certificate_arn # String that contains the ARN of the requested certificate. The # certificate ARN is generated and returned by the RequestCertificate # action as soon as the request is made. By default, using this @@ -978,11 +1019,11 @@ # certificate transparency log. For more information, see [ Opting Out # of Certificate Transparency Logging][1]. # # # - # [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-bestpractices.html#best-practices-transparency + # [1]: https://docs.aws.amazon.com/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 @@ -1027,10 +1068,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-acm' - context[:gem_version] = '1.14.0' + context[:gem_version] = '1.15.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #