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