aws-sdk-acm 1.0.0.rc1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/lib/aws-sdk-acm.rb +47 -0
- data/lib/aws-sdk-acm/client.rb +710 -0
- data/lib/aws-sdk-acm/client_api.rb +319 -0
- data/lib/aws-sdk-acm/customizations.rb +7 -0
- data/lib/aws-sdk-acm/errors.rb +23 -0
- data/lib/aws-sdk-acm/resource.rb +25 -0
- data/lib/aws-sdk-acm/types.rb +709 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 2a776c3ec1c0c60863c71b043248433ae43563a4
|
4
|
+
data.tar.gz: 3bfc0457de962cc38bd256ac92203abd0c0f4654
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 5759b2f12435761dadc6eabcc8f2770389affe20b6a541858bbf88a1438467b9b095d85736a350449bf4afa4798268c5f50592995f914e375d6595da248f3512
|
7
|
+
data.tar.gz: 5845ab43d5583b89f134c16a0eb58f3b7cda16e95c0548c35226cb5c0ec0614dde115ecbb476a6e42a51456fc44560a79b151ee6e80b16ccb09268529a44db94
|
data/lib/aws-sdk-acm.rb
ADDED
@@ -0,0 +1,47 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'aws-sdk-core'
|
9
|
+
require 'aws-sigv4'
|
10
|
+
|
11
|
+
require_relative 'aws-sdk-acm/types'
|
12
|
+
require_relative 'aws-sdk-acm/client_api'
|
13
|
+
require_relative 'aws-sdk-acm/client'
|
14
|
+
require_relative 'aws-sdk-acm/errors'
|
15
|
+
require_relative 'aws-sdk-acm/resource'
|
16
|
+
require_relative 'aws-sdk-acm/customizations'
|
17
|
+
|
18
|
+
# This module provides support for AWS Certificate Manager. This module is available in the
|
19
|
+
# `aws-sdk-acm` gem.
|
20
|
+
#
|
21
|
+
# # Client
|
22
|
+
#
|
23
|
+
# The {Client} class provides one method for each API operation. Operation
|
24
|
+
# methods each accept a hash of request parameters and return a response
|
25
|
+
# structure.
|
26
|
+
#
|
27
|
+
# See {Client} for more information.
|
28
|
+
#
|
29
|
+
# # Errors
|
30
|
+
#
|
31
|
+
# Errors returned from AWS Certificate Manager all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::ACM::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::ACM
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,710 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing for info on making contributions:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
require 'seahorse/client/plugins/content_length.rb'
|
9
|
+
require 'aws-sdk-core/plugins/credentials_configuration.rb'
|
10
|
+
require 'aws-sdk-core/plugins/logging.rb'
|
11
|
+
require 'aws-sdk-core/plugins/param_converter.rb'
|
12
|
+
require 'aws-sdk-core/plugins/param_validator.rb'
|
13
|
+
require 'aws-sdk-core/plugins/user_agent.rb'
|
14
|
+
require 'aws-sdk-core/plugins/helpful_socket_errors.rb'
|
15
|
+
require 'aws-sdk-core/plugins/retry_errors.rb'
|
16
|
+
require 'aws-sdk-core/plugins/global_configuration.rb'
|
17
|
+
require 'aws-sdk-core/plugins/regional_endpoint.rb'
|
18
|
+
require 'aws-sdk-core/plugins/response_paging.rb'
|
19
|
+
require 'aws-sdk-core/plugins/stub_responses.rb'
|
20
|
+
require 'aws-sdk-core/plugins/idempotency_token.rb'
|
21
|
+
require 'aws-sdk-core/plugins/signature_v4.rb'
|
22
|
+
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
23
|
+
|
24
|
+
Aws::Plugins::GlobalConfiguration.add_identifier(:acm)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module ACM
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :acm
|
33
|
+
|
34
|
+
set_api(ClientApi::API)
|
35
|
+
|
36
|
+
add_plugin(Seahorse::Client::Plugins::ContentLength)
|
37
|
+
add_plugin(Aws::Plugins::CredentialsConfiguration)
|
38
|
+
add_plugin(Aws::Plugins::Logging)
|
39
|
+
add_plugin(Aws::Plugins::ParamConverter)
|
40
|
+
add_plugin(Aws::Plugins::ParamValidator)
|
41
|
+
add_plugin(Aws::Plugins::UserAgent)
|
42
|
+
add_plugin(Aws::Plugins::HelpfulSocketErrors)
|
43
|
+
add_plugin(Aws::Plugins::RetryErrors)
|
44
|
+
add_plugin(Aws::Plugins::GlobalConfiguration)
|
45
|
+
add_plugin(Aws::Plugins::RegionalEndpoint)
|
46
|
+
add_plugin(Aws::Plugins::ResponsePaging)
|
47
|
+
add_plugin(Aws::Plugins::StubResponses)
|
48
|
+
add_plugin(Aws::Plugins::IdempotencyToken)
|
49
|
+
add_plugin(Aws::Plugins::SignatureV4)
|
50
|
+
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
51
|
+
|
52
|
+
# @option options [required, Aws::CredentialProvider] :credentials
|
53
|
+
# Your AWS credentials. This can be an instance of any one of the
|
54
|
+
# following classes:
|
55
|
+
#
|
56
|
+
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
57
|
+
# credentials.
|
58
|
+
#
|
59
|
+
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
60
|
+
# from an EC2 IMDS on an EC2 instance.
|
61
|
+
#
|
62
|
+
# * `Aws::SharedCredentials` - Used for loading credentials from a
|
63
|
+
# shared file, such as `~/.aws/config`.
|
64
|
+
#
|
65
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
66
|
+
#
|
67
|
+
# When `:credentials` are not configured directly, the following
|
68
|
+
# locations will be searched for credentials:
|
69
|
+
#
|
70
|
+
# * `Aws.config[:credentials]`
|
71
|
+
# * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
|
72
|
+
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
73
|
+
# * `~/.aws/credentials`
|
74
|
+
# * `~/.aws/config`
|
75
|
+
# * EC2 IMDS instance profile - When used by default, the timeouts are
|
76
|
+
# very aggressive. Construct and pass an instance of
|
77
|
+
# `Aws::InstanceProfileCredentails` to enable retries and extended
|
78
|
+
# timeouts.
|
79
|
+
# @option options [required, String] :region
|
80
|
+
# The AWS region to connect to. The configured `:region` is
|
81
|
+
# used to determine the service `:endpoint`. When not passed,
|
82
|
+
# a default `:region` is search for in the following locations:
|
83
|
+
#
|
84
|
+
# * `Aws.config[:region]`
|
85
|
+
# * `ENV['AWS_REGION']`
|
86
|
+
# * `ENV['AMAZON_REGION']`
|
87
|
+
# * `ENV['AWS_DEFAULT_REGION']`
|
88
|
+
# * `~/.aws/credentials`
|
89
|
+
# * `~/.aws/config`
|
90
|
+
# @option options [String] :access_key_id
|
91
|
+
# @option options [Boolean] :convert_params (true)
|
92
|
+
# When `true`, an attempt is made to coerce request parameters into
|
93
|
+
# the required types.
|
94
|
+
# @option options [String] :endpoint
|
95
|
+
# The client endpoint is normally constructed from the `:region`
|
96
|
+
# option. You should only configure an `:endpoint` when connecting
|
97
|
+
# to test endpoints. This should be avalid HTTP(S) URI.
|
98
|
+
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
99
|
+
# The log formatter.
|
100
|
+
# @option options [Symbol] :log_level (:info)
|
101
|
+
# The log level to send messages to the `:logger` at.
|
102
|
+
# @option options [Logger] :logger
|
103
|
+
# The Logger instance to send log messages to. If this option
|
104
|
+
# is not set, logging will be disabled.
|
105
|
+
# @option options [String] :profile ("default")
|
106
|
+
# Used when loading credentials from the shared credentials file
|
107
|
+
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
108
|
+
# @option options [Integer] :retry_limit (3)
|
109
|
+
# The maximum number of times to retry failed requests. Only
|
110
|
+
# ~ 500 level server errors and certain ~ 400 level client errors
|
111
|
+
# are retried. Generally, these are throttling errors, data
|
112
|
+
# checksum errors, networking errors, timeout errors and auth
|
113
|
+
# errors from expired credentials.
|
114
|
+
# @option options [String] :secret_access_key
|
115
|
+
# @option options [String] :session_token
|
116
|
+
# @option options [Boolean] :simple_json (false)
|
117
|
+
# Disables request parameter conversion, validation, and formatting.
|
118
|
+
# Also disable response data type conversions. This option is useful
|
119
|
+
# when you want to ensure the highest level of performance by
|
120
|
+
# avoiding overhead of walking request parameters and response data
|
121
|
+
# structures.
|
122
|
+
#
|
123
|
+
# When `:simple_json` is enabled, the request parameters hash must
|
124
|
+
# be formatted exactly as the DynamoDB API expects.
|
125
|
+
# @option options [Boolean] :stub_responses (false)
|
126
|
+
# Causes the client to return stubbed responses. By default
|
127
|
+
# fake responses are generated and returned. You can specify
|
128
|
+
# the response data to return or errors to raise by calling
|
129
|
+
# {ClientStubs#stub_responses}. See {ClientStubs} for more information.
|
130
|
+
#
|
131
|
+
# ** Please note ** When response stubbing is enabled, no HTTP
|
132
|
+
# requests are made, and retries are disabled.
|
133
|
+
# @option options [Boolean] :validate_params (true)
|
134
|
+
# When `true`, request parameters are validated before
|
135
|
+
# sending the request.
|
136
|
+
def initialize(*args)
|
137
|
+
super
|
138
|
+
end
|
139
|
+
|
140
|
+
# @!group API Operations
|
141
|
+
|
142
|
+
# Adds one or more tags to an ACM Certificate. Tags are labels that you
|
143
|
+
# can use to identify and organize your AWS resources. Each tag consists
|
144
|
+
# of a `key` and an optional `value`. You specify the certificate on
|
145
|
+
# input by its Amazon Resource Name (ARN). You specify the tag by using
|
146
|
+
# a key-value pair.
|
147
|
+
#
|
148
|
+
# You can apply a tag to just one certificate if you want to identify a
|
149
|
+
# specific characteristic of that certificate, or you can apply the same
|
150
|
+
# tag to multiple certificates if you want to filter for a common
|
151
|
+
# relationship among those certificates. Similarly, you can apply the
|
152
|
+
# same tag to multiple resources if you want to specify a relationship
|
153
|
+
# among those resources. For example, you can add the same tag to an ACM
|
154
|
+
# Certificate and an Elastic Load Balancing load balancer to indicate
|
155
|
+
# that they are both used by the same website. For more information, see
|
156
|
+
# [Tagging ACM Certificates][1].
|
157
|
+
#
|
158
|
+
# To remove one or more tags, use the RemoveTagsFromCertificate action.
|
159
|
+
# To view all of the tags that have been applied to the certificate, use
|
160
|
+
# the ListTagsForCertificate action.
|
161
|
+
#
|
162
|
+
#
|
163
|
+
#
|
164
|
+
# [1]: http://docs.aws.amazon.com/acm/latest/userguide/tags.html
|
165
|
+
# @option params [required, String] :certificate_arn
|
166
|
+
# String that contains the ARN of the ACM Certificate to which the tag
|
167
|
+
# is to be applied. This must be of the form:
|
168
|
+
#
|
169
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
170
|
+
#
|
171
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
172
|
+
# AWS Service Namespaces][1].
|
173
|
+
#
|
174
|
+
#
|
175
|
+
#
|
176
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
177
|
+
# @option params [required, Array<Types::Tag>] :tags
|
178
|
+
# The key-value pair that defines the tag. The tag value is optional.
|
179
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
180
|
+
#
|
181
|
+
# @example Request syntax with placeholder values
|
182
|
+
# resp = client.add_tags_to_certificate({
|
183
|
+
# certificate_arn: "Arn", # required
|
184
|
+
# tags: [ # required
|
185
|
+
# {
|
186
|
+
# key: "TagKey", # required
|
187
|
+
# value: "TagValue",
|
188
|
+
# },
|
189
|
+
# ],
|
190
|
+
# })
|
191
|
+
# @overload add_tags_to_certificate(params = {})
|
192
|
+
# @param [Hash] params ({})
|
193
|
+
def add_tags_to_certificate(params = {}, options = {})
|
194
|
+
req = build_request(:add_tags_to_certificate, params)
|
195
|
+
req.send_request(options)
|
196
|
+
end
|
197
|
+
|
198
|
+
# Deletes an ACM Certificate and its associated private key. If this
|
199
|
+
# action succeeds, the certificate no longer appears in the list of ACM
|
200
|
+
# Certificates that can be displayed by calling the ListCertificates
|
201
|
+
# action or be retrieved by calling the GetCertificate action. The
|
202
|
+
# certificate will not be available for use by other AWS services.
|
203
|
+
#
|
204
|
+
# <note markdown="1"> You cannot delete an ACM Certificate that is being used by another AWS
|
205
|
+
# service. To delete a certificate that is in use, the certificate
|
206
|
+
# association must first be removed.
|
207
|
+
#
|
208
|
+
# </note>
|
209
|
+
# @option params [required, String] :certificate_arn
|
210
|
+
# String that contains the ARN of the ACM Certificate to be deleted.
|
211
|
+
# This must be of the form:
|
212
|
+
#
|
213
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
214
|
+
#
|
215
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
216
|
+
# AWS Service Namespaces][1].
|
217
|
+
#
|
218
|
+
#
|
219
|
+
#
|
220
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
221
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
222
|
+
#
|
223
|
+
# @example Request syntax with placeholder values
|
224
|
+
# resp = client.delete_certificate({
|
225
|
+
# certificate_arn: "Arn", # required
|
226
|
+
# })
|
227
|
+
# @overload delete_certificate(params = {})
|
228
|
+
# @param [Hash] params ({})
|
229
|
+
def delete_certificate(params = {}, options = {})
|
230
|
+
req = build_request(:delete_certificate, params)
|
231
|
+
req.send_request(options)
|
232
|
+
end
|
233
|
+
|
234
|
+
# Returns a list of the fields contained in the specified ACM
|
235
|
+
# Certificate. For example, this action returns the certificate status,
|
236
|
+
# a flag that indicates whether the certificate is associated with any
|
237
|
+
# other AWS service, and the date at which the certificate request was
|
238
|
+
# created. You specify the ACM Certificate on input by its Amazon
|
239
|
+
# Resource Name (ARN).
|
240
|
+
# @option params [required, String] :certificate_arn
|
241
|
+
# String that contains an ACM Certificate ARN. The ARN must be of the
|
242
|
+
# form:
|
243
|
+
#
|
244
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
245
|
+
#
|
246
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
247
|
+
# AWS Service Namespaces][1].
|
248
|
+
#
|
249
|
+
#
|
250
|
+
#
|
251
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
252
|
+
# @return [Types::DescribeCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
253
|
+
#
|
254
|
+
# * {Types::DescribeCertificateResponse#certificate #Certificate} => Types::CertificateDetail
|
255
|
+
#
|
256
|
+
# @example Request syntax with placeholder values
|
257
|
+
# resp = client.describe_certificate({
|
258
|
+
# certificate_arn: "Arn", # required
|
259
|
+
# })
|
260
|
+
#
|
261
|
+
# @example Response structure
|
262
|
+
# resp.certificate.certificate_arn #=> String
|
263
|
+
# resp.certificate.domain_name #=> String
|
264
|
+
# resp.certificate.subject_alternative_names #=> Array
|
265
|
+
# resp.certificate.subject_alternative_names[0] #=> String
|
266
|
+
# resp.certificate.domain_validation_options #=> Array
|
267
|
+
# resp.certificate.domain_validation_options[0].domain_name #=> String
|
268
|
+
# resp.certificate.domain_validation_options[0].validation_emails #=> Array
|
269
|
+
# resp.certificate.domain_validation_options[0].validation_emails[0] #=> String
|
270
|
+
# resp.certificate.domain_validation_options[0].validation_domain #=> String
|
271
|
+
# resp.certificate.serial #=> String
|
272
|
+
# resp.certificate.subject #=> String
|
273
|
+
# resp.certificate.issuer #=> String
|
274
|
+
# resp.certificate.created_at #=> Time
|
275
|
+
# resp.certificate.issued_at #=> Time
|
276
|
+
# resp.certificate.imported_at #=> Time
|
277
|
+
# resp.certificate.status #=> String, one of "PENDING_VALIDATION", "ISSUED", "INACTIVE", "EXPIRED", "VALIDATION_TIMED_OUT", "REVOKED", "FAILED"
|
278
|
+
# resp.certificate.revoked_at #=> Time
|
279
|
+
# resp.certificate.revocation_reason #=> String, one of "UNSPECIFIED", "KEY_COMPROMISE", "CA_COMPROMISE", "AFFILIATION_CHANGED", "SUPERCEDED", "CESSATION_OF_OPERATION", "CERTIFICATE_HOLD", "REMOVE_FROM_CRL", "PRIVILEGE_WITHDRAWN", "A_A_COMPROMISE"
|
280
|
+
# resp.certificate.not_before #=> Time
|
281
|
+
# resp.certificate.not_after #=> Time
|
282
|
+
# resp.certificate.key_algorithm #=> String, one of "RSA_2048", "RSA_1024", "EC_prime256v1"
|
283
|
+
# resp.certificate.signature_algorithm #=> String
|
284
|
+
# resp.certificate.in_use_by #=> Array
|
285
|
+
# resp.certificate.in_use_by[0] #=> String
|
286
|
+
# resp.certificate.failure_reason #=> String, one of "NO_AVAILABLE_CONTACTS", "ADDITIONAL_VERIFICATION_REQUIRED", "DOMAIN_NOT_ALLOWED", "INVALID_PUBLIC_DOMAIN", "OTHER"
|
287
|
+
# resp.certificate.type #=> String, one of "IMPORTED", "AMAZON_ISSUED"
|
288
|
+
# @overload describe_certificate(params = {})
|
289
|
+
# @param [Hash] params ({})
|
290
|
+
def describe_certificate(params = {}, options = {})
|
291
|
+
req = build_request(:describe_certificate, params)
|
292
|
+
req.send_request(options)
|
293
|
+
end
|
294
|
+
|
295
|
+
# Retrieves an ACM Certificate and certificate chain for the certificate
|
296
|
+
# specified by an ARN. The chain is an ordered list of certificates that
|
297
|
+
# contains the root certificate, intermediate certificates of
|
298
|
+
# subordinate CAs, and the ACM Certificate. The certificate and
|
299
|
+
# certificate chain are base64 encoded. If you want to decode the
|
300
|
+
# certificate chain to see the individual certificate fields, you can
|
301
|
+
# use OpenSSL.
|
302
|
+
#
|
303
|
+
# <note markdown="1"> Currently, ACM Certificates can be used only with Elastic Load
|
304
|
+
# Balancing and Amazon CloudFront.
|
305
|
+
#
|
306
|
+
# </note>
|
307
|
+
# @option params [required, String] :certificate_arn
|
308
|
+
# String that contains a certificate ARN in the following format:
|
309
|
+
#
|
310
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
311
|
+
#
|
312
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
313
|
+
# AWS Service Namespaces][1].
|
314
|
+
#
|
315
|
+
#
|
316
|
+
#
|
317
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
318
|
+
# @return [Types::GetCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
319
|
+
#
|
320
|
+
# * {Types::GetCertificateResponse#certificate #Certificate} => String
|
321
|
+
# * {Types::GetCertificateResponse#certificate_chain #CertificateChain} => String
|
322
|
+
#
|
323
|
+
# @example Request syntax with placeholder values
|
324
|
+
# resp = client.get_certificate({
|
325
|
+
# certificate_arn: "Arn", # required
|
326
|
+
# })
|
327
|
+
#
|
328
|
+
# @example Response structure
|
329
|
+
# resp.certificate #=> String
|
330
|
+
# resp.certificate_chain #=> String
|
331
|
+
# @overload get_certificate(params = {})
|
332
|
+
# @param [Hash] params ({})
|
333
|
+
def get_certificate(params = {}, options = {})
|
334
|
+
req = build_request(:get_certificate, params)
|
335
|
+
req.send_request(options)
|
336
|
+
end
|
337
|
+
|
338
|
+
# Imports an SSL/TLS certificate into AWS Certificate Manager (ACM) to
|
339
|
+
# use with [ACM's integrated AWS services][1].
|
340
|
+
#
|
341
|
+
# <note markdown="1"> ACM does not provide [managed renewal][2] for certificates that you
|
342
|
+
# import.
|
343
|
+
#
|
344
|
+
# </note>
|
345
|
+
#
|
346
|
+
# For more information about importing certificates into ACM, including
|
347
|
+
# the differences between certificates that you import and those that
|
348
|
+
# ACM provides, see [Importing Certificates][3] in the *AWS Certificate
|
349
|
+
# Manager User Guide*.
|
350
|
+
#
|
351
|
+
# To import a certificate, you must provide the certificate and the
|
352
|
+
# matching private key. When the certificate is not self-signed, you
|
353
|
+
# must also provide a certificate chain. You can omit the certificate
|
354
|
+
# chain when importing a self-signed certificate.
|
355
|
+
#
|
356
|
+
# The certificate, private key, and certificate chain must be
|
357
|
+
# PEM-encoded. For more information about converting these items to PEM
|
358
|
+
# format, see [Importing Certificates Troubleshooting][4] in the *AWS
|
359
|
+
# Certificate Manager User Guide*.
|
360
|
+
#
|
361
|
+
# To import a new certificate, omit the `CertificateArn` field. Include
|
362
|
+
# this field only when you want to replace a previously imported
|
363
|
+
# certificate.
|
364
|
+
#
|
365
|
+
# This operation returns the [Amazon Resource Name (ARN)][5] of the
|
366
|
+
# imported certificate.
|
367
|
+
#
|
368
|
+
#
|
369
|
+
#
|
370
|
+
# [1]: http://docs.aws.amazon.com/acm/latest/userguide/acm-services.html
|
371
|
+
# [2]: http://docs.aws.amazon.com/acm/latest/userguide/acm-renewal.html
|
372
|
+
# [3]: http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html
|
373
|
+
# [4]: http://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html#import-certificate-troubleshooting
|
374
|
+
# [5]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
375
|
+
# @option params [String] :certificate_arn
|
376
|
+
# The [Amazon Resource Name (ARN)][1] of an imported certificate to
|
377
|
+
# replace. To import a new certificate, omit this field.
|
378
|
+
#
|
379
|
+
#
|
380
|
+
#
|
381
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
382
|
+
# @option params [required, String, IO] :certificate
|
383
|
+
# The certificate to import. It must meet the following requirements:
|
384
|
+
#
|
385
|
+
# * Must be PEM-encoded.
|
386
|
+
#
|
387
|
+
# * Must contain a 1024-bit or 2048-bit RSA public key.
|
388
|
+
#
|
389
|
+
# * Must be valid at the time of import. You cannot import a certificate
|
390
|
+
# before its validity period begins (the certificate's `NotBefore`
|
391
|
+
# date) or after it expires (the certificate's `NotAfter` date).
|
392
|
+
# @option params [required, String, IO] :private_key
|
393
|
+
# The private key that matches the public key in the certificate. It
|
394
|
+
# must meet the following requirements:
|
395
|
+
#
|
396
|
+
# * Must be PEM-encoded.
|
397
|
+
#
|
398
|
+
# * Must be unencrypted. You cannot import a private key that is
|
399
|
+
# protected by a password or passphrase.
|
400
|
+
# @option params [String, IO] :certificate_chain
|
401
|
+
# The certificate chain. It must be PEM-encoded.
|
402
|
+
# @return [Types::ImportCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
403
|
+
#
|
404
|
+
# * {Types::ImportCertificateResponse#certificate_arn #CertificateArn} => String
|
405
|
+
#
|
406
|
+
# @example Request syntax with placeholder values
|
407
|
+
# resp = client.import_certificate({
|
408
|
+
# certificate_arn: "Arn",
|
409
|
+
# certificate: "data", # required
|
410
|
+
# private_key: "data", # required
|
411
|
+
# certificate_chain: "data",
|
412
|
+
# })
|
413
|
+
#
|
414
|
+
# @example Response structure
|
415
|
+
# resp.certificate_arn #=> String
|
416
|
+
# @overload import_certificate(params = {})
|
417
|
+
# @param [Hash] params ({})
|
418
|
+
def import_certificate(params = {}, options = {})
|
419
|
+
req = build_request(:import_certificate, params)
|
420
|
+
req.send_request(options)
|
421
|
+
end
|
422
|
+
|
423
|
+
# Retrieves a list of ACM Certificates and the domain name for each. You
|
424
|
+
# can optionally filter the list to return only the certificates that
|
425
|
+
# match the specified status.
|
426
|
+
# @option params [Array<String>] :certificate_statuses
|
427
|
+
# The status or statuses on which to filter the list of ACM
|
428
|
+
# Certificates.
|
429
|
+
# @option params [String] :next_token
|
430
|
+
# Use this parameter only when paginating results and only in a
|
431
|
+
# subsequent request after you receive a response with truncated
|
432
|
+
# results. Set it to the value of `NextToken` from the response you just
|
433
|
+
# received.
|
434
|
+
# @option params [Integer] :max_items
|
435
|
+
# Use this parameter when paginating results to specify the maximum
|
436
|
+
# number of items to return in the response. If additional items exist
|
437
|
+
# beyond the number you specify, the `NextToken` element is sent in the
|
438
|
+
# response. Use this `NextToken` value in a subsequent request to
|
439
|
+
# retrieve additional items.
|
440
|
+
# @return [Types::ListCertificatesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
441
|
+
#
|
442
|
+
# * {Types::ListCertificatesResponse#next_token #NextToken} => String
|
443
|
+
# * {Types::ListCertificatesResponse#certificate_summary_list #CertificateSummaryList} => Array<Types::CertificateSummary>
|
444
|
+
#
|
445
|
+
# @example Request syntax with placeholder values
|
446
|
+
# resp = client.list_certificates({
|
447
|
+
# certificate_statuses: ["PENDING_VALIDATION"], # accepts PENDING_VALIDATION, ISSUED, INACTIVE, EXPIRED, VALIDATION_TIMED_OUT, REVOKED, FAILED
|
448
|
+
# next_token: "NextToken",
|
449
|
+
# max_items: 1,
|
450
|
+
# })
|
451
|
+
#
|
452
|
+
# @example Response structure
|
453
|
+
# resp.next_token #=> String
|
454
|
+
# resp.certificate_summary_list #=> Array
|
455
|
+
# resp.certificate_summary_list[0].certificate_arn #=> String
|
456
|
+
# resp.certificate_summary_list[0].domain_name #=> String
|
457
|
+
# @overload list_certificates(params = {})
|
458
|
+
# @param [Hash] params ({})
|
459
|
+
def list_certificates(params = {}, options = {})
|
460
|
+
req = build_request(:list_certificates, params)
|
461
|
+
req.send_request(options)
|
462
|
+
end
|
463
|
+
|
464
|
+
# Lists the tags that have been applied to the ACM Certificate. Use the
|
465
|
+
# certificate ARN to specify the certificate. To add a tag to an ACM
|
466
|
+
# Certificate, use the AddTagsToCertificate action. To delete a tag, use
|
467
|
+
# the RemoveTagsFromCertificate action.
|
468
|
+
# @option params [required, String] :certificate_arn
|
469
|
+
# String that contains the ARN of the ACM Certificate for which you want
|
470
|
+
# to list the tags. This must be of the form:
|
471
|
+
#
|
472
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
473
|
+
#
|
474
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
475
|
+
# AWS Service Namespaces][1].
|
476
|
+
#
|
477
|
+
#
|
478
|
+
#
|
479
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
480
|
+
# @return [Types::ListTagsForCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
481
|
+
#
|
482
|
+
# * {Types::ListTagsForCertificateResponse#tags #Tags} => Array<Types::Tag>
|
483
|
+
#
|
484
|
+
# @example Request syntax with placeholder values
|
485
|
+
# resp = client.list_tags_for_certificate({
|
486
|
+
# certificate_arn: "Arn", # required
|
487
|
+
# })
|
488
|
+
#
|
489
|
+
# @example Response structure
|
490
|
+
# resp.tags #=> Array
|
491
|
+
# resp.tags[0].key #=> String
|
492
|
+
# resp.tags[0].value #=> String
|
493
|
+
# @overload list_tags_for_certificate(params = {})
|
494
|
+
# @param [Hash] params ({})
|
495
|
+
def list_tags_for_certificate(params = {}, options = {})
|
496
|
+
req = build_request(:list_tags_for_certificate, params)
|
497
|
+
req.send_request(options)
|
498
|
+
end
|
499
|
+
|
500
|
+
# Remove one or more tags from an ACM Certificate. A tag consists of a
|
501
|
+
# key-value pair. If you do not specify the value portion of the tag
|
502
|
+
# when calling this function, the tag will be removed regardless of
|
503
|
+
# value. If you specify a value, the tag is removed only if it is
|
504
|
+
# associated with the specified value.
|
505
|
+
#
|
506
|
+
# To add tags to a certificate, use the AddTagsToCertificate action. To
|
507
|
+
# view all of the tags that have been applied to a specific ACM
|
508
|
+
# Certificate, use the ListTagsForCertificate action.
|
509
|
+
# @option params [required, String] :certificate_arn
|
510
|
+
# String that contains the ARN of the ACM Certificate with one or more
|
511
|
+
# tags that you want to remove. This must be of the form:
|
512
|
+
#
|
513
|
+
# `arn:aws:acm:region:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
514
|
+
#
|
515
|
+
# For more information about ARNs, see [Amazon Resource Names (ARNs) and
|
516
|
+
# AWS Service Namespaces][1].
|
517
|
+
#
|
518
|
+
#
|
519
|
+
#
|
520
|
+
# [1]: http://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html
|
521
|
+
# @option params [required, Array<Types::Tag>] :tags
|
522
|
+
# The key-value pair that defines the tag to remove.
|
523
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
524
|
+
#
|
525
|
+
# @example Request syntax with placeholder values
|
526
|
+
# resp = client.remove_tags_from_certificate({
|
527
|
+
# certificate_arn: "Arn", # required
|
528
|
+
# tags: [ # required
|
529
|
+
# {
|
530
|
+
# key: "TagKey", # required
|
531
|
+
# value: "TagValue",
|
532
|
+
# },
|
533
|
+
# ],
|
534
|
+
# })
|
535
|
+
# @overload remove_tags_from_certificate(params = {})
|
536
|
+
# @param [Hash] params ({})
|
537
|
+
def remove_tags_from_certificate(params = {}, options = {})
|
538
|
+
req = build_request(:remove_tags_from_certificate, params)
|
539
|
+
req.send_request(options)
|
540
|
+
end
|
541
|
+
|
542
|
+
# Requests an ACM Certificate for use with other AWS services. To
|
543
|
+
# request an ACM Certificate, you must specify the fully qualified
|
544
|
+
# domain name (FQDN) for your site. You can also specify additional
|
545
|
+
# FQDNs if users can reach your site by using other names. For each
|
546
|
+
# domain name you specify, email is sent to the domain owner to request
|
547
|
+
# approval to issue the certificate. After receiving approval from the
|
548
|
+
# domain owner, the ACM Certificate is issued. For more information, see
|
549
|
+
# the [AWS Certificate Manager User Guide][1].
|
550
|
+
#
|
551
|
+
#
|
552
|
+
#
|
553
|
+
# [1]: http://docs.aws.amazon.com/acm/latest/userguide/
|
554
|
+
# @option params [required, String] :domain_name
|
555
|
+
# Fully qualified domain name (FQDN), such as www.example.com, of the
|
556
|
+
# site you want to secure with an ACM Certificate. Use an asterisk (*)
|
557
|
+
# to create a wildcard certificate that protects several sites in the
|
558
|
+
# same domain. For example, *.example.com protects www.example.com,
|
559
|
+
# site.example.com, and images.example.com.
|
560
|
+
# @option params [Array<String>] :subject_alternative_names
|
561
|
+
# Additional FQDNs to be included in the Subject Alternative Name
|
562
|
+
# extension of the ACM Certificate. For example, add the name
|
563
|
+
# www.example.net to a certificate for which the `DomainName` field is
|
564
|
+
# www.example.com if users can reach your site by using either name.
|
565
|
+
# @option params [String] :idempotency_token
|
566
|
+
# Customer chosen string that can be used to distinguish between calls
|
567
|
+
# to `RequestCertificate`. Idempotency tokens time out after one hour.
|
568
|
+
# Therefore, if you call `RequestCertificate` multiple times with the
|
569
|
+
# same idempotency token within one hour, ACM recognizes that you are
|
570
|
+
# requesting only one certificate and will issue only one. If you change
|
571
|
+
# the idempotency token for each call, ACM recognizes that you are
|
572
|
+
# requesting multiple certificates.
|
573
|
+
# @option params [Array<Types::DomainValidationOption>] :domain_validation_options
|
574
|
+
# The base validation domain that will act as the suffix of the email
|
575
|
+
# addresses that are used to send the emails. This must be the same as
|
576
|
+
# the `Domain` value or a superdomain of the `Domain` value. For
|
577
|
+
# example, if you requested a certificate for `test.example.com` and
|
578
|
+
# specify **DomainValidationOptions** of `example.com`, ACM sends email
|
579
|
+
# to the domain registrant, technical contact, and administrative
|
580
|
+
# contact in WHOIS and the following five addresses:
|
581
|
+
#
|
582
|
+
# * admin@example.com
|
583
|
+
#
|
584
|
+
# * administrator@example.com
|
585
|
+
#
|
586
|
+
# * hostmaster@example.com
|
587
|
+
#
|
588
|
+
# * postmaster@example.com
|
589
|
+
#
|
590
|
+
# * webmaster@example.com
|
591
|
+
# @return [Types::RequestCertificateResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
592
|
+
#
|
593
|
+
# * {Types::RequestCertificateResponse#certificate_arn #CertificateArn} => String
|
594
|
+
#
|
595
|
+
# @example Request syntax with placeholder values
|
596
|
+
# resp = client.request_certificate({
|
597
|
+
# domain_name: "DomainNameString", # required
|
598
|
+
# subject_alternative_names: ["DomainNameString"],
|
599
|
+
# idempotency_token: "IdempotencyToken",
|
600
|
+
# domain_validation_options: [
|
601
|
+
# {
|
602
|
+
# domain_name: "DomainNameString", # required
|
603
|
+
# validation_domain: "DomainNameString", # required
|
604
|
+
# },
|
605
|
+
# ],
|
606
|
+
# })
|
607
|
+
#
|
608
|
+
# @example Response structure
|
609
|
+
# resp.certificate_arn #=> String
|
610
|
+
# @overload request_certificate(params = {})
|
611
|
+
# @param [Hash] params ({})
|
612
|
+
def request_certificate(params = {}, options = {})
|
613
|
+
req = build_request(:request_certificate, params)
|
614
|
+
req.send_request(options)
|
615
|
+
end
|
616
|
+
|
617
|
+
# Resends the email that requests domain ownership validation. The
|
618
|
+
# domain owner or an authorized representative must approve the ACM
|
619
|
+
# Certificate before it can be issued. The certificate can be approved
|
620
|
+
# by clicking a link in the mail to navigate to the Amazon certificate
|
621
|
+
# approval website and then clicking **I Approve**. However, the
|
622
|
+
# validation email can be blocked by spam filters. Therefore, if you do
|
623
|
+
# not receive the original mail, you can request that the mail be resent
|
624
|
+
# within 72 hours of requesting the ACM Certificate. If more than 72
|
625
|
+
# hours have elapsed since your original request or since your last
|
626
|
+
# attempt to resend validation mail, you must request a new certificate.
|
627
|
+
# @option params [required, String] :certificate_arn
|
628
|
+
# String that contains the ARN of the requested certificate. The
|
629
|
+
# certificate ARN is generated and returned by the RequestCertificate
|
630
|
+
# action as soon as the request is made. By default, using this
|
631
|
+
# parameter causes email to be sent to all top-level domains you
|
632
|
+
# specified in the certificate request.
|
633
|
+
#
|
634
|
+
# The ARN must be of the form:
|
635
|
+
#
|
636
|
+
# `arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012`
|
637
|
+
# @option params [required, String] :domain
|
638
|
+
# The Fully Qualified Domain Name (FQDN) of the certificate that needs
|
639
|
+
# to be validated.
|
640
|
+
# @option params [required, String] :validation_domain
|
641
|
+
# The base validation domain that will act as the suffix of the email
|
642
|
+
# addresses that are used to send the emails. This must be the same as
|
643
|
+
# the `Domain` value or a superdomain of the `Domain` value. For
|
644
|
+
# example, if you requested a certificate for
|
645
|
+
# `site.subdomain.example.com` and specify a **ValidationDomain** of
|
646
|
+
# `subdomain.example.com`, ACM sends email to the domain registrant,
|
647
|
+
# technical contact, and administrative contact in WHOIS and the
|
648
|
+
# following five addresses:
|
649
|
+
#
|
650
|
+
# * admin@subdomain.example.com
|
651
|
+
#
|
652
|
+
# * administrator@subdomain.example.com
|
653
|
+
#
|
654
|
+
# * hostmaster@subdomain.example.com
|
655
|
+
#
|
656
|
+
# * postmaster@subdomain.example.com
|
657
|
+
#
|
658
|
+
# * webmaster@subdomain.example.com
|
659
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
660
|
+
#
|
661
|
+
# @example Request syntax with placeholder values
|
662
|
+
# resp = client.resend_validation_email({
|
663
|
+
# certificate_arn: "Arn", # required
|
664
|
+
# domain: "DomainNameString", # required
|
665
|
+
# validation_domain: "DomainNameString", # required
|
666
|
+
# })
|
667
|
+
# @overload resend_validation_email(params = {})
|
668
|
+
# @param [Hash] params ({})
|
669
|
+
def resend_validation_email(params = {}, options = {})
|
670
|
+
req = build_request(:resend_validation_email, params)
|
671
|
+
req.send_request(options)
|
672
|
+
end
|
673
|
+
|
674
|
+
# @!endgroup
|
675
|
+
|
676
|
+
# @param params ({})
|
677
|
+
# @api private
|
678
|
+
def build_request(operation_name, params = {})
|
679
|
+
handlers = @handlers.for(operation_name)
|
680
|
+
context = Seahorse::Client::RequestContext.new(
|
681
|
+
operation_name: operation_name,
|
682
|
+
operation: config.api.operation(operation_name),
|
683
|
+
client: self,
|
684
|
+
params: params,
|
685
|
+
config: config)
|
686
|
+
context[:gem_name] = 'aws-sdk-acm'
|
687
|
+
context[:gem_version] = '1.0.0.rc1'
|
688
|
+
Seahorse::Client::Request.new(handlers, context)
|
689
|
+
end
|
690
|
+
|
691
|
+
# @api private
|
692
|
+
# @deprecated
|
693
|
+
def waiter_names
|
694
|
+
[]
|
695
|
+
end
|
696
|
+
|
697
|
+
class << self
|
698
|
+
|
699
|
+
# @api private
|
700
|
+
attr_reader :identifier
|
701
|
+
|
702
|
+
# @api private
|
703
|
+
def errors_module
|
704
|
+
Errors
|
705
|
+
end
|
706
|
+
|
707
|
+
end
|
708
|
+
end
|
709
|
+
end
|
710
|
+
end
|