aws-sdk-route53domains 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-route53domains.rb +47 -0
- data/lib/aws-sdk-route53domains/client.rb +1766 -0
- data/lib/aws-sdk-route53domains/client_api.rb +692 -0
- data/lib/aws-sdk-route53domains/customizations.rb +7 -0
- data/lib/aws-sdk-route53domains/errors.rb +23 -0
- data/lib/aws-sdk-route53domains/resource.rb +25 -0
- data/lib/aws-sdk-route53domains/types.rb +2388 -0
- metadata +80 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 4593fb4440f82c61b27a7218e699d800f555a0d5
|
4
|
+
data.tar.gz: c3cca09c3f50174904ace2146083eebb0d89c7e3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 98383f3010d93bd3d04cd3697268f578c1909c0be17fd1dee098be44ad15b3a9a17b187914863a7f0d00e5b8ad0cc4ce7013971edea4121937561d786f05f53b
|
7
|
+
data.tar.gz: 3a3f6feefd1a60af8246090b5f518bece7874c2e7c4db79a2ca9749b60eaa5ddd455b94ea21cb129c1a372b66d7e2fdeabc4291c327a4dc140b5ca55fe6ed365
|
@@ -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-route53domains/types'
|
12
|
+
require_relative 'aws-sdk-route53domains/client_api'
|
13
|
+
require_relative 'aws-sdk-route53domains/client'
|
14
|
+
require_relative 'aws-sdk-route53domains/errors'
|
15
|
+
require_relative 'aws-sdk-route53domains/resource'
|
16
|
+
require_relative 'aws-sdk-route53domains/customizations'
|
17
|
+
|
18
|
+
# This module provides support for Amazon Route 53 Domains. This module is available in the
|
19
|
+
# `aws-sdk-route53domains` 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 Amazon Route 53 Domains all
|
32
|
+
# extend {Errors::ServiceError}.
|
33
|
+
#
|
34
|
+
# begin
|
35
|
+
# # do stuff
|
36
|
+
# rescue Aws::Route53Domains::Errors::ServiceError
|
37
|
+
# # rescues all service API errors
|
38
|
+
# end
|
39
|
+
#
|
40
|
+
# See {Errors} for more information.
|
41
|
+
#
|
42
|
+
# @service
|
43
|
+
module Aws::Route53Domains
|
44
|
+
|
45
|
+
GEM_VERSION = '1.0.0.rc1'
|
46
|
+
|
47
|
+
end
|
@@ -0,0 +1,1766 @@
|
|
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(:route53domains)
|
25
|
+
|
26
|
+
module Aws
|
27
|
+
module Route53Domains
|
28
|
+
class Client < Seahorse::Client::Base
|
29
|
+
|
30
|
+
include Aws::ClientStubs
|
31
|
+
|
32
|
+
@identifier = :route53domains
|
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
|
+
# This operation checks the availability of one domain name. Note that
|
143
|
+
# if the availability status of a domain is pending, you must submit
|
144
|
+
# another request to determine the availability of the domain name.
|
145
|
+
# @option params [required, String] :domain_name
|
146
|
+
# The name of a domain.
|
147
|
+
#
|
148
|
+
# Type: String
|
149
|
+
#
|
150
|
+
# Default: None
|
151
|
+
#
|
152
|
+
# Constraints: The domain name can contain only the letters a through z,
|
153
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
154
|
+
# Names are not supported.
|
155
|
+
#
|
156
|
+
# Required: Yes
|
157
|
+
# @option params [String] :idn_lang_code
|
158
|
+
# Reserved for future use.
|
159
|
+
# @return [Types::CheckDomainAvailabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
160
|
+
#
|
161
|
+
# * {Types::CheckDomainAvailabilityResponse#availability #Availability} => String
|
162
|
+
#
|
163
|
+
# @example Request syntax with placeholder values
|
164
|
+
# resp = client.check_domain_availability({
|
165
|
+
# domain_name: "DomainName", # required
|
166
|
+
# idn_lang_code: "LangCode",
|
167
|
+
# })
|
168
|
+
#
|
169
|
+
# @example Response structure
|
170
|
+
# resp.availability #=> String, one of "AVAILABLE", "AVAILABLE_RESERVED", "AVAILABLE_PREORDER", "UNAVAILABLE", "UNAVAILABLE_PREMIUM", "UNAVAILABLE_RESTRICTED", "RESERVED", "DONT_KNOW"
|
171
|
+
# @overload check_domain_availability(params = {})
|
172
|
+
# @param [Hash] params ({})
|
173
|
+
def check_domain_availability(params = {}, options = {})
|
174
|
+
req = build_request(:check_domain_availability, params)
|
175
|
+
req.send_request(options)
|
176
|
+
end
|
177
|
+
|
178
|
+
# This operation deletes the specified tags for a domain.
|
179
|
+
#
|
180
|
+
# All tag operations are eventually consistent; subsequent operations
|
181
|
+
# may not immediately represent all issued operations.
|
182
|
+
# @option params [required, String] :domain_name
|
183
|
+
# The domain for which you want to delete one or more tags.
|
184
|
+
#
|
185
|
+
# The name of a domain.
|
186
|
+
#
|
187
|
+
# Type: String
|
188
|
+
#
|
189
|
+
# Default: None
|
190
|
+
#
|
191
|
+
# Constraints: The domain name can contain only the letters a through z,
|
192
|
+
# the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when
|
193
|
+
# they're surrounded by letters, numbers, or other hyphens. You can't
|
194
|
+
# specify a hyphen at the beginning or end of a label. To specify an
|
195
|
+
# Internationalized Domain Name, you must convert the name to Punycode.
|
196
|
+
#
|
197
|
+
# Required: Yes
|
198
|
+
# @option params [required, Array<String>] :tags_to_delete
|
199
|
+
# A list of tag keys to delete.
|
200
|
+
#
|
201
|
+
# Type: A list that contains the keys of the tags that you want to
|
202
|
+
# delete.
|
203
|
+
#
|
204
|
+
# Default: None
|
205
|
+
#
|
206
|
+
# Required: No
|
207
|
+
#
|
208
|
+
# '>
|
209
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
210
|
+
#
|
211
|
+
# @example Request syntax with placeholder values
|
212
|
+
# resp = client.delete_tags_for_domain({
|
213
|
+
# domain_name: "DomainName", # required
|
214
|
+
# tags_to_delete: ["TagKey"], # required
|
215
|
+
# })
|
216
|
+
# @overload delete_tags_for_domain(params = {})
|
217
|
+
# @param [Hash] params ({})
|
218
|
+
def delete_tags_for_domain(params = {}, options = {})
|
219
|
+
req = build_request(:delete_tags_for_domain, params)
|
220
|
+
req.send_request(options)
|
221
|
+
end
|
222
|
+
|
223
|
+
# This operation disables automatic renewal of domain registration for
|
224
|
+
# the specified domain.
|
225
|
+
# @option params [required, String] :domain_name
|
226
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
227
|
+
#
|
228
|
+
# @example Request syntax with placeholder values
|
229
|
+
# resp = client.disable_domain_auto_renew({
|
230
|
+
# domain_name: "DomainName", # required
|
231
|
+
# })
|
232
|
+
# @overload disable_domain_auto_renew(params = {})
|
233
|
+
# @param [Hash] params ({})
|
234
|
+
def disable_domain_auto_renew(params = {}, options = {})
|
235
|
+
req = build_request(:disable_domain_auto_renew, params)
|
236
|
+
req.send_request(options)
|
237
|
+
end
|
238
|
+
|
239
|
+
# This operation removes the transfer lock on the domain (specifically
|
240
|
+
# the `clientTransferProhibited` status) to allow domain transfers. We
|
241
|
+
# recommend you refrain from performing this action unless you intend to
|
242
|
+
# transfer the domain to a different registrar. Successful submission
|
243
|
+
# returns an operation ID that you can use to track the progress and
|
244
|
+
# completion of the action. If the request is not completed
|
245
|
+
# successfully, the domain registrant will be notified by email.
|
246
|
+
# @option params [required, String] :domain_name
|
247
|
+
# The name of a domain.
|
248
|
+
#
|
249
|
+
# Type: String
|
250
|
+
#
|
251
|
+
# Default: None
|
252
|
+
#
|
253
|
+
# Constraints: The domain name can contain only the letters a through z,
|
254
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
255
|
+
# Names are not supported.
|
256
|
+
#
|
257
|
+
# Required: Yes
|
258
|
+
# @return [Types::DisableDomainTransferLockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
259
|
+
#
|
260
|
+
# * {Types::DisableDomainTransferLockResponse#operation_id #OperationId} => String
|
261
|
+
#
|
262
|
+
# @example Request syntax with placeholder values
|
263
|
+
# resp = client.disable_domain_transfer_lock({
|
264
|
+
# domain_name: "DomainName", # required
|
265
|
+
# })
|
266
|
+
#
|
267
|
+
# @example Response structure
|
268
|
+
# resp.operation_id #=> String
|
269
|
+
# @overload disable_domain_transfer_lock(params = {})
|
270
|
+
# @param [Hash] params ({})
|
271
|
+
def disable_domain_transfer_lock(params = {}, options = {})
|
272
|
+
req = build_request(:disable_domain_transfer_lock, params)
|
273
|
+
req.send_request(options)
|
274
|
+
end
|
275
|
+
|
276
|
+
# This operation configures Amazon Route 53 to automatically renew the
|
277
|
+
# specified domain before the domain registration expires. The cost of
|
278
|
+
# renewing your domain registration is billed to your AWS account.
|
279
|
+
#
|
280
|
+
# The period during which you can renew a domain name varies by TLD. For
|
281
|
+
# a list of TLDs and their renewal policies, see ["Renewal,
|
282
|
+
# restoration, and deletion times"][1] on the website for our registrar
|
283
|
+
# partner, Gandi. Route 53 requires that you renew before the end of the
|
284
|
+
# renewal period that is listed on the Gandi website so we can complete
|
285
|
+
# processing before the deadline.
|
286
|
+
#
|
287
|
+
#
|
288
|
+
#
|
289
|
+
# [1]: http://wiki.gandi.net/en/domains/renew#renewal_restoration_and_deletion_times
|
290
|
+
# @option params [required, String] :domain_name
|
291
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
292
|
+
#
|
293
|
+
# @example Request syntax with placeholder values
|
294
|
+
# resp = client.enable_domain_auto_renew({
|
295
|
+
# domain_name: "DomainName", # required
|
296
|
+
# })
|
297
|
+
# @overload enable_domain_auto_renew(params = {})
|
298
|
+
# @param [Hash] params ({})
|
299
|
+
def enable_domain_auto_renew(params = {}, options = {})
|
300
|
+
req = build_request(:enable_domain_auto_renew, params)
|
301
|
+
req.send_request(options)
|
302
|
+
end
|
303
|
+
|
304
|
+
# This operation sets the transfer lock on the domain (specifically the
|
305
|
+
# `clientTransferProhibited` status) to prevent domain transfers.
|
306
|
+
# Successful submission returns an operation ID that you can use to
|
307
|
+
# track the progress and completion of the action. If the request is not
|
308
|
+
# completed successfully, the domain registrant will be notified by
|
309
|
+
# email.
|
310
|
+
# @option params [required, String] :domain_name
|
311
|
+
# The name of a domain.
|
312
|
+
#
|
313
|
+
# Type: String
|
314
|
+
#
|
315
|
+
# Default: None
|
316
|
+
#
|
317
|
+
# Constraints: The domain name can contain only the letters a through z,
|
318
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
319
|
+
# Names are not supported.
|
320
|
+
#
|
321
|
+
# Required: Yes
|
322
|
+
# @return [Types::EnableDomainTransferLockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
323
|
+
#
|
324
|
+
# * {Types::EnableDomainTransferLockResponse#operation_id #OperationId} => String
|
325
|
+
#
|
326
|
+
# @example Request syntax with placeholder values
|
327
|
+
# resp = client.enable_domain_transfer_lock({
|
328
|
+
# domain_name: "DomainName", # required
|
329
|
+
# })
|
330
|
+
#
|
331
|
+
# @example Response structure
|
332
|
+
# resp.operation_id #=> String
|
333
|
+
# @overload enable_domain_transfer_lock(params = {})
|
334
|
+
# @param [Hash] params ({})
|
335
|
+
def enable_domain_transfer_lock(params = {}, options = {})
|
336
|
+
req = build_request(:enable_domain_transfer_lock, params)
|
337
|
+
req.send_request(options)
|
338
|
+
end
|
339
|
+
|
340
|
+
# For operations that require confirmation that the email address for
|
341
|
+
# the registrant contact is valid, such as registering a new domain,
|
342
|
+
# this operation returns information about whether the registrant
|
343
|
+
# contact has responded.
|
344
|
+
#
|
345
|
+
# If you want us to resend the email, use the
|
346
|
+
# `ResendContactReachabilityEmail` operation.
|
347
|
+
# @option params [String] :domain_name
|
348
|
+
# The name of the domain for which you want to know whether the
|
349
|
+
# registrant contact has confirmed that the email address is valid.
|
350
|
+
#
|
351
|
+
# Type: String
|
352
|
+
#
|
353
|
+
# Default: None
|
354
|
+
#
|
355
|
+
# Required: Yes
|
356
|
+
# @return [Types::GetContactReachabilityStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
357
|
+
#
|
358
|
+
# * {Types::GetContactReachabilityStatusResponse#domain_name #domainName} => String
|
359
|
+
# * {Types::GetContactReachabilityStatusResponse#status #status} => String
|
360
|
+
#
|
361
|
+
# @example Request syntax with placeholder values
|
362
|
+
# resp = client.get_contact_reachability_status({
|
363
|
+
# domain_name: "DomainName",
|
364
|
+
# })
|
365
|
+
#
|
366
|
+
# @example Response structure
|
367
|
+
# resp.domain_name #=> String
|
368
|
+
# resp.status #=> String, one of "PENDING", "DONE", "EXPIRED"
|
369
|
+
# @overload get_contact_reachability_status(params = {})
|
370
|
+
# @param [Hash] params ({})
|
371
|
+
def get_contact_reachability_status(params = {}, options = {})
|
372
|
+
req = build_request(:get_contact_reachability_status, params)
|
373
|
+
req.send_request(options)
|
374
|
+
end
|
375
|
+
|
376
|
+
# This operation returns detailed information about the domain. The
|
377
|
+
# domain's contact information is also returned as part of the output.
|
378
|
+
# @option params [required, String] :domain_name
|
379
|
+
# The name of a domain.
|
380
|
+
#
|
381
|
+
# Type: String
|
382
|
+
#
|
383
|
+
# Default: None
|
384
|
+
#
|
385
|
+
# Constraints: The domain name can contain only the letters a through z,
|
386
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
387
|
+
# Names are not supported.
|
388
|
+
#
|
389
|
+
# Required: Yes
|
390
|
+
# @return [Types::GetDomainDetailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
391
|
+
#
|
392
|
+
# * {Types::GetDomainDetailResponse#domain_name #DomainName} => String
|
393
|
+
# * {Types::GetDomainDetailResponse#nameservers #Nameservers} => Array<Types::Nameserver>
|
394
|
+
# * {Types::GetDomainDetailResponse#auto_renew #AutoRenew} => Boolean
|
395
|
+
# * {Types::GetDomainDetailResponse#admin_contact #AdminContact} => Types::ContactDetail
|
396
|
+
# * {Types::GetDomainDetailResponse#registrant_contact #RegistrantContact} => Types::ContactDetail
|
397
|
+
# * {Types::GetDomainDetailResponse#tech_contact #TechContact} => Types::ContactDetail
|
398
|
+
# * {Types::GetDomainDetailResponse#admin_privacy #AdminPrivacy} => Boolean
|
399
|
+
# * {Types::GetDomainDetailResponse#registrant_privacy #RegistrantPrivacy} => Boolean
|
400
|
+
# * {Types::GetDomainDetailResponse#tech_privacy #TechPrivacy} => Boolean
|
401
|
+
# * {Types::GetDomainDetailResponse#registrar_name #RegistrarName} => String
|
402
|
+
# * {Types::GetDomainDetailResponse#who_is_server #WhoIsServer} => String
|
403
|
+
# * {Types::GetDomainDetailResponse#registrar_url #RegistrarUrl} => String
|
404
|
+
# * {Types::GetDomainDetailResponse#abuse_contact_email #AbuseContactEmail} => String
|
405
|
+
# * {Types::GetDomainDetailResponse#abuse_contact_phone #AbuseContactPhone} => String
|
406
|
+
# * {Types::GetDomainDetailResponse#registry_domain_id #RegistryDomainId} => String
|
407
|
+
# * {Types::GetDomainDetailResponse#creation_date #CreationDate} => Time
|
408
|
+
# * {Types::GetDomainDetailResponse#updated_date #UpdatedDate} => Time
|
409
|
+
# * {Types::GetDomainDetailResponse#expiration_date #ExpirationDate} => Time
|
410
|
+
# * {Types::GetDomainDetailResponse#reseller #Reseller} => String
|
411
|
+
# * {Types::GetDomainDetailResponse#dns_sec #DnsSec} => String
|
412
|
+
# * {Types::GetDomainDetailResponse#status_list #StatusList} => Array<String>
|
413
|
+
#
|
414
|
+
# @example Request syntax with placeholder values
|
415
|
+
# resp = client.get_domain_detail({
|
416
|
+
# domain_name: "DomainName", # required
|
417
|
+
# })
|
418
|
+
#
|
419
|
+
# @example Response structure
|
420
|
+
# resp.domain_name #=> String
|
421
|
+
# resp.nameservers #=> Array
|
422
|
+
# resp.nameservers[0].name #=> String
|
423
|
+
# resp.nameservers[0].glue_ips #=> Array
|
424
|
+
# resp.nameservers[0].glue_ips[0] #=> String
|
425
|
+
# resp.auto_renew #=> Boolean
|
426
|
+
# resp.admin_contact.first_name #=> String
|
427
|
+
# resp.admin_contact.last_name #=> String
|
428
|
+
# resp.admin_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
|
429
|
+
# resp.admin_contact.organization_name #=> String
|
430
|
+
# resp.admin_contact.address_line_1 #=> String
|
431
|
+
# resp.admin_contact.address_line_2 #=> String
|
432
|
+
# resp.admin_contact.city #=> String
|
433
|
+
# resp.admin_contact.state #=> String
|
434
|
+
# resp.admin_contact.country_code #=> String, one of "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GH", "GI", "GL", "GM", "GN", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"
|
435
|
+
# resp.admin_contact.zip_code #=> String
|
436
|
+
# resp.admin_contact.phone_number #=> String
|
437
|
+
# resp.admin_contact.email #=> String
|
438
|
+
# resp.admin_contact.fax #=> String
|
439
|
+
# resp.admin_contact.extra_params #=> Array
|
440
|
+
# resp.admin_contact.extra_params[0].name #=> String, one of "DUNS_NUMBER", "BRAND_NUMBER", "BIRTH_DEPARTMENT", "BIRTH_DATE_IN_YYYY_MM_DD", "BIRTH_COUNTRY", "BIRTH_CITY", "DOCUMENT_NUMBER", "AU_ID_NUMBER", "AU_ID_TYPE", "CA_LEGAL_TYPE", "CA_BUSINESS_ENTITY_TYPE", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
|
441
|
+
# resp.admin_contact.extra_params[0].value #=> String
|
442
|
+
# resp.registrant_contact.first_name #=> String
|
443
|
+
# resp.registrant_contact.last_name #=> String
|
444
|
+
# resp.registrant_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
|
445
|
+
# resp.registrant_contact.organization_name #=> String
|
446
|
+
# resp.registrant_contact.address_line_1 #=> String
|
447
|
+
# resp.registrant_contact.address_line_2 #=> String
|
448
|
+
# resp.registrant_contact.city #=> String
|
449
|
+
# resp.registrant_contact.state #=> String
|
450
|
+
# resp.registrant_contact.country_code #=> String, one of "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GH", "GI", "GL", "GM", "GN", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"
|
451
|
+
# resp.registrant_contact.zip_code #=> String
|
452
|
+
# resp.registrant_contact.phone_number #=> String
|
453
|
+
# resp.registrant_contact.email #=> String
|
454
|
+
# resp.registrant_contact.fax #=> String
|
455
|
+
# resp.registrant_contact.extra_params #=> Array
|
456
|
+
# resp.registrant_contact.extra_params[0].name #=> String, one of "DUNS_NUMBER", "BRAND_NUMBER", "BIRTH_DEPARTMENT", "BIRTH_DATE_IN_YYYY_MM_DD", "BIRTH_COUNTRY", "BIRTH_CITY", "DOCUMENT_NUMBER", "AU_ID_NUMBER", "AU_ID_TYPE", "CA_LEGAL_TYPE", "CA_BUSINESS_ENTITY_TYPE", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
|
457
|
+
# resp.registrant_contact.extra_params[0].value #=> String
|
458
|
+
# resp.tech_contact.first_name #=> String
|
459
|
+
# resp.tech_contact.last_name #=> String
|
460
|
+
# resp.tech_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER"
|
461
|
+
# resp.tech_contact.organization_name #=> String
|
462
|
+
# resp.tech_contact.address_line_1 #=> String
|
463
|
+
# resp.tech_contact.address_line_2 #=> String
|
464
|
+
# resp.tech_contact.city #=> String
|
465
|
+
# resp.tech_contact.state #=> String
|
466
|
+
# resp.tech_contact.country_code #=> String, one of "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GH", "GI", "GL", "GM", "GN", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PT", "PW", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SY", "SZ", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW"
|
467
|
+
# resp.tech_contact.zip_code #=> String
|
468
|
+
# resp.tech_contact.phone_number #=> String
|
469
|
+
# resp.tech_contact.email #=> String
|
470
|
+
# resp.tech_contact.fax #=> String
|
471
|
+
# resp.tech_contact.extra_params #=> Array
|
472
|
+
# resp.tech_contact.extra_params[0].name #=> String, one of "DUNS_NUMBER", "BRAND_NUMBER", "BIRTH_DEPARTMENT", "BIRTH_DATE_IN_YYYY_MM_DD", "BIRTH_COUNTRY", "BIRTH_CITY", "DOCUMENT_NUMBER", "AU_ID_NUMBER", "AU_ID_TYPE", "CA_LEGAL_TYPE", "CA_BUSINESS_ENTITY_TYPE", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "IT_PIN", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER"
|
473
|
+
# resp.tech_contact.extra_params[0].value #=> String
|
474
|
+
# resp.admin_privacy #=> Boolean
|
475
|
+
# resp.registrant_privacy #=> Boolean
|
476
|
+
# resp.tech_privacy #=> Boolean
|
477
|
+
# resp.registrar_name #=> String
|
478
|
+
# resp.who_is_server #=> String
|
479
|
+
# resp.registrar_url #=> String
|
480
|
+
# resp.abuse_contact_email #=> String
|
481
|
+
# resp.abuse_contact_phone #=> String
|
482
|
+
# resp.registry_domain_id #=> String
|
483
|
+
# resp.creation_date #=> Time
|
484
|
+
# resp.updated_date #=> Time
|
485
|
+
# resp.expiration_date #=> Time
|
486
|
+
# resp.reseller #=> String
|
487
|
+
# resp.dns_sec #=> String
|
488
|
+
# resp.status_list #=> Array
|
489
|
+
# resp.status_list[0] #=> String
|
490
|
+
# @overload get_domain_detail(params = {})
|
491
|
+
# @param [Hash] params ({})
|
492
|
+
def get_domain_detail(params = {}, options = {})
|
493
|
+
req = build_request(:get_domain_detail, params)
|
494
|
+
req.send_request(options)
|
495
|
+
end
|
496
|
+
|
497
|
+
# The GetDomainSuggestions operation returns a list of suggested domain
|
498
|
+
# names given a string, which can either be a domain name or simply a
|
499
|
+
# word or phrase (without spaces).
|
500
|
+
#
|
501
|
+
# Parameters: * DomainName (string): The basis for your domain
|
502
|
+
# suggestion search, a
|
503
|
+
# string with (or without) top-level domain specified.
|
504
|
+
# * SuggestionCount (int): The number of domain suggestions to be
|
505
|
+
# returned, maximum 50, minimum 1.
|
506
|
+
# * OnlyAvailable (bool): If true, availability check will be performed
|
507
|
+
# on suggestion results, and only available domains will be returned.
|
508
|
+
# If false, suggestions will be returned without checking whether the
|
509
|
+
# domain is actually available, and caller will have to call
|
510
|
+
# checkDomainAvailability for each suggestion to determine
|
511
|
+
# availability for registration.
|
512
|
+
# @option params [required, String] :domain_name
|
513
|
+
# @option params [required, Integer] :suggestion_count
|
514
|
+
# @option params [required, Boolean] :only_available
|
515
|
+
# @return [Types::GetDomainSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
516
|
+
#
|
517
|
+
# * {Types::GetDomainSuggestionsResponse#suggestions_list #SuggestionsList} => Array<Types::DomainSuggestion>
|
518
|
+
#
|
519
|
+
# @example Request syntax with placeholder values
|
520
|
+
# resp = client.get_domain_suggestions({
|
521
|
+
# domain_name: "DomainName", # required
|
522
|
+
# suggestion_count: 1, # required
|
523
|
+
# only_available: false, # required
|
524
|
+
# })
|
525
|
+
#
|
526
|
+
# @example Response structure
|
527
|
+
# resp.suggestions_list #=> Array
|
528
|
+
# resp.suggestions_list[0].domain_name #=> String
|
529
|
+
# resp.suggestions_list[0].availability #=> String
|
530
|
+
# @overload get_domain_suggestions(params = {})
|
531
|
+
# @param [Hash] params ({})
|
532
|
+
def get_domain_suggestions(params = {}, options = {})
|
533
|
+
req = build_request(:get_domain_suggestions, params)
|
534
|
+
req.send_request(options)
|
535
|
+
end
|
536
|
+
|
537
|
+
# This operation returns the current status of an operation that is not
|
538
|
+
# completed.
|
539
|
+
# @option params [required, String] :operation_id
|
540
|
+
# The identifier for the operation for which you want to get the status.
|
541
|
+
# Amazon Route 53 returned the identifier in the response to the
|
542
|
+
# original request.
|
543
|
+
#
|
544
|
+
# Type: String
|
545
|
+
#
|
546
|
+
# Default: None
|
547
|
+
#
|
548
|
+
# Required: Yes
|
549
|
+
# @return [Types::GetOperationDetailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
550
|
+
#
|
551
|
+
# * {Types::GetOperationDetailResponse#operation_id #OperationId} => String
|
552
|
+
# * {Types::GetOperationDetailResponse#status #Status} => String
|
553
|
+
# * {Types::GetOperationDetailResponse#message #Message} => String
|
554
|
+
# * {Types::GetOperationDetailResponse#domain_name #DomainName} => String
|
555
|
+
# * {Types::GetOperationDetailResponse#type #Type} => String
|
556
|
+
# * {Types::GetOperationDetailResponse#submitted_date #SubmittedDate} => Time
|
557
|
+
#
|
558
|
+
# @example Request syntax with placeholder values
|
559
|
+
# resp = client.get_operation_detail({
|
560
|
+
# operation_id: "OperationId", # required
|
561
|
+
# })
|
562
|
+
#
|
563
|
+
# @example Response structure
|
564
|
+
# resp.operation_id #=> String
|
565
|
+
# resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED"
|
566
|
+
# resp.message #=> String
|
567
|
+
# resp.domain_name #=> String
|
568
|
+
# resp.type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
|
569
|
+
# resp.submitted_date #=> Time
|
570
|
+
# @overload get_operation_detail(params = {})
|
571
|
+
# @param [Hash] params ({})
|
572
|
+
def get_operation_detail(params = {}, options = {})
|
573
|
+
req = build_request(:get_operation_detail, params)
|
574
|
+
req.send_request(options)
|
575
|
+
end
|
576
|
+
|
577
|
+
# This operation returns all the domain names registered with Amazon
|
578
|
+
# Route 53 for the current AWS account.
|
579
|
+
# @option params [String] :marker
|
580
|
+
# For an initial request for a list of domains, omit this element. If
|
581
|
+
# the number of domains that are associated with the current AWS account
|
582
|
+
# is greater than the value that you specified for `MaxItems`, you can
|
583
|
+
# use `Marker` to return additional domains. Get the value of
|
584
|
+
# `NextPageMarker` from the previous response, and submit another
|
585
|
+
# request that includes the value of `NextPageMarker` in the `Marker`
|
586
|
+
# element.
|
587
|
+
#
|
588
|
+
# Type: String
|
589
|
+
#
|
590
|
+
# Default: None
|
591
|
+
#
|
592
|
+
# Constraints: The marker must match the value specified in the previous
|
593
|
+
# request.
|
594
|
+
#
|
595
|
+
# Required: No
|
596
|
+
# @option params [Integer] :max_items
|
597
|
+
# Number of domains to be returned.
|
598
|
+
#
|
599
|
+
# Type: Integer
|
600
|
+
#
|
601
|
+
# Default: 20
|
602
|
+
#
|
603
|
+
# Constraints: A numeral between 1 and 100.
|
604
|
+
#
|
605
|
+
# Required: No
|
606
|
+
# @return [Types::ListDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
607
|
+
#
|
608
|
+
# * {Types::ListDomainsResponse#domains #Domains} => Array<Types::DomainSummary>
|
609
|
+
# * {Types::ListDomainsResponse#next_page_marker #NextPageMarker} => String
|
610
|
+
#
|
611
|
+
# @example Request syntax with placeholder values
|
612
|
+
# resp = client.list_domains({
|
613
|
+
# marker: "PageMarker",
|
614
|
+
# max_items: 1,
|
615
|
+
# })
|
616
|
+
#
|
617
|
+
# @example Response structure
|
618
|
+
# resp.domains #=> Array
|
619
|
+
# resp.domains[0].domain_name #=> String
|
620
|
+
# resp.domains[0].auto_renew #=> Boolean
|
621
|
+
# resp.domains[0].transfer_lock #=> Boolean
|
622
|
+
# resp.domains[0].expiry #=> Time
|
623
|
+
# resp.next_page_marker #=> String
|
624
|
+
# @overload list_domains(params = {})
|
625
|
+
# @param [Hash] params ({})
|
626
|
+
def list_domains(params = {}, options = {})
|
627
|
+
req = build_request(:list_domains, params)
|
628
|
+
req.send_request(options)
|
629
|
+
end
|
630
|
+
|
631
|
+
# This operation returns the operation IDs of operations that are not
|
632
|
+
# yet complete.
|
633
|
+
# @option params [String] :marker
|
634
|
+
# For an initial request for a list of operations, omit this element. If
|
635
|
+
# the number of operations that are not yet complete is greater than the
|
636
|
+
# value that you specified for `MaxItems`, you can use `Marker` to
|
637
|
+
# return additional operations. Get the value of `NextPageMarker` from
|
638
|
+
# the previous response, and submit another request that includes the
|
639
|
+
# value of `NextPageMarker` in the `Marker` element.
|
640
|
+
#
|
641
|
+
# Type: String
|
642
|
+
#
|
643
|
+
# Default: None
|
644
|
+
#
|
645
|
+
# Required: No
|
646
|
+
# @option params [Integer] :max_items
|
647
|
+
# Number of domains to be returned.
|
648
|
+
#
|
649
|
+
# Type: Integer
|
650
|
+
#
|
651
|
+
# Default: 20
|
652
|
+
#
|
653
|
+
# Constraints: A value between 1 and 100.
|
654
|
+
#
|
655
|
+
# Required: No
|
656
|
+
# @return [Types::ListOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
657
|
+
#
|
658
|
+
# * {Types::ListOperationsResponse#operations #Operations} => Array<Types::OperationSummary>
|
659
|
+
# * {Types::ListOperationsResponse#next_page_marker #NextPageMarker} => String
|
660
|
+
#
|
661
|
+
# @example Request syntax with placeholder values
|
662
|
+
# resp = client.list_operations({
|
663
|
+
# marker: "PageMarker",
|
664
|
+
# max_items: 1,
|
665
|
+
# })
|
666
|
+
#
|
667
|
+
# @example Response structure
|
668
|
+
# resp.operations #=> Array
|
669
|
+
# resp.operations[0].operation_id #=> String
|
670
|
+
# resp.operations[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED"
|
671
|
+
# resp.operations[0].type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
|
672
|
+
# resp.operations[0].submitted_date #=> Time
|
673
|
+
# resp.next_page_marker #=> String
|
674
|
+
# @overload list_operations(params = {})
|
675
|
+
# @param [Hash] params ({})
|
676
|
+
def list_operations(params = {}, options = {})
|
677
|
+
req = build_request(:list_operations, params)
|
678
|
+
req.send_request(options)
|
679
|
+
end
|
680
|
+
|
681
|
+
# This operation returns all of the tags that are associated with the
|
682
|
+
# specified domain.
|
683
|
+
#
|
684
|
+
# All tag operations are eventually consistent; subsequent operations
|
685
|
+
# may not immediately represent all issued operations.
|
686
|
+
# @option params [required, String] :domain_name
|
687
|
+
# The domain for which you want to get a list of tags.
|
688
|
+
# @return [Types::ListTagsForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
689
|
+
#
|
690
|
+
# * {Types::ListTagsForDomainResponse#tag_list #TagList} => Array<Types::Tag>
|
691
|
+
#
|
692
|
+
# @example Request syntax with placeholder values
|
693
|
+
# resp = client.list_tags_for_domain({
|
694
|
+
# domain_name: "DomainName", # required
|
695
|
+
# })
|
696
|
+
#
|
697
|
+
# @example Response structure
|
698
|
+
# resp.tag_list #=> Array
|
699
|
+
# resp.tag_list[0].key #=> String
|
700
|
+
# resp.tag_list[0].value #=> String
|
701
|
+
# @overload list_tags_for_domain(params = {})
|
702
|
+
# @param [Hash] params ({})
|
703
|
+
def list_tags_for_domain(params = {}, options = {})
|
704
|
+
req = build_request(:list_tags_for_domain, params)
|
705
|
+
req.send_request(options)
|
706
|
+
end
|
707
|
+
|
708
|
+
# This operation registers a domain. Domains are registered by the AWS
|
709
|
+
# registrar partner, Gandi. For some top-level domains (TLDs), this
|
710
|
+
# operation requires extra parameters.
|
711
|
+
#
|
712
|
+
# When you register a domain, Amazon Route 53 does the following:
|
713
|
+
#
|
714
|
+
# * Creates a Amazon Route 53 hosted zone that has the same name as the
|
715
|
+
# domain. Amazon Route 53 assigns four name servers to your hosted
|
716
|
+
# zone and automatically updates your domain registration with the
|
717
|
+
# names of these name servers.
|
718
|
+
# * Enables autorenew, so your domain registration will renew
|
719
|
+
# automatically each year. We'll notify you in advance of the renewal
|
720
|
+
# date so you can choose whether to renew the registration.
|
721
|
+
# * Optionally enables privacy protection, so WHOIS queries return
|
722
|
+
# contact information for our registrar partner, Gandi, instead of the
|
723
|
+
# information you entered for registrant, admin, and tech contacts.
|
724
|
+
# * If registration is successful, returns an operation ID that you can
|
725
|
+
# use to track the progress and completion of the action. If the
|
726
|
+
# request is not completed successfully, the domain registrant is
|
727
|
+
# notified by email.
|
728
|
+
# * Charges your AWS account an amount based on the top-level domain.
|
729
|
+
# For more information, see [Amazon Route 53 Pricing][1].
|
730
|
+
#
|
731
|
+
#
|
732
|
+
#
|
733
|
+
# [1]: http://aws.amazon.com/route53/pricing/
|
734
|
+
# @option params [required, String] :domain_name
|
735
|
+
# The name of a domain.
|
736
|
+
#
|
737
|
+
# Type: String
|
738
|
+
#
|
739
|
+
# Default: None
|
740
|
+
#
|
741
|
+
# Constraints: The domain name can contain only the letters a through z,
|
742
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
743
|
+
# Names are not supported.
|
744
|
+
#
|
745
|
+
# Required: Yes
|
746
|
+
# @option params [String] :idn_lang_code
|
747
|
+
# Reserved for future use.
|
748
|
+
# @option params [required, Integer] :duration_in_years
|
749
|
+
# The number of years the domain will be registered. Domains are
|
750
|
+
# registered for a minimum of one year. The maximum period depends on
|
751
|
+
# the top-level domain.
|
752
|
+
#
|
753
|
+
# Type: Integer
|
754
|
+
#
|
755
|
+
# Default: 1
|
756
|
+
#
|
757
|
+
# Valid values: Integer from 1 to 10
|
758
|
+
#
|
759
|
+
# Required: Yes
|
760
|
+
# @option params [Boolean] :auto_renew
|
761
|
+
# Indicates whether the domain will be automatically renewed (`true`) or
|
762
|
+
# not (`false`). Autorenewal only takes effect after the account is
|
763
|
+
# charged.
|
764
|
+
#
|
765
|
+
# Type: Boolean
|
766
|
+
#
|
767
|
+
# Valid values: `true` \| `false`
|
768
|
+
#
|
769
|
+
# Default: `true`
|
770
|
+
#
|
771
|
+
# Required: No
|
772
|
+
# @option params [required, Types::ContactDetail] :admin_contact
|
773
|
+
# Provides detailed contact information.
|
774
|
+
#
|
775
|
+
# Type: Complex
|
776
|
+
#
|
777
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
778
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
779
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
780
|
+
#
|
781
|
+
# Required: Yes
|
782
|
+
# @option params [required, Types::ContactDetail] :registrant_contact
|
783
|
+
# Provides detailed contact information.
|
784
|
+
#
|
785
|
+
# Type: Complex
|
786
|
+
#
|
787
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
788
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
789
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
790
|
+
#
|
791
|
+
# Required: Yes
|
792
|
+
# @option params [required, Types::ContactDetail] :tech_contact
|
793
|
+
# Provides detailed contact information.
|
794
|
+
#
|
795
|
+
# Type: Complex
|
796
|
+
#
|
797
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
798
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
799
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
800
|
+
#
|
801
|
+
# Required: Yes
|
802
|
+
# @option params [Boolean] :privacy_protect_admin_contact
|
803
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
804
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
805
|
+
# information for our registrar partner, Gandi, instead of the contact
|
806
|
+
# information that you enter.
|
807
|
+
#
|
808
|
+
# Type: Boolean
|
809
|
+
#
|
810
|
+
# Default: `true`
|
811
|
+
#
|
812
|
+
# Valid values: `true` \| `false`
|
813
|
+
#
|
814
|
+
# Required: No
|
815
|
+
# @option params [Boolean] :privacy_protect_registrant_contact
|
816
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
817
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
818
|
+
# information for our registrar partner, Gandi, instead of the contact
|
819
|
+
# information that you enter.
|
820
|
+
#
|
821
|
+
# Type: Boolean
|
822
|
+
#
|
823
|
+
# Default: `true`
|
824
|
+
#
|
825
|
+
# Valid values: `true` \| `false`
|
826
|
+
#
|
827
|
+
# Required: No
|
828
|
+
# @option params [Boolean] :privacy_protect_tech_contact
|
829
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
830
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
831
|
+
# information for our registrar partner, Gandi, instead of the contact
|
832
|
+
# information that you enter.
|
833
|
+
#
|
834
|
+
# Type: Boolean
|
835
|
+
#
|
836
|
+
# Default: `true`
|
837
|
+
#
|
838
|
+
# Valid values: `true` \| `false`
|
839
|
+
#
|
840
|
+
# Required: No
|
841
|
+
# @return [Types::RegisterDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
842
|
+
#
|
843
|
+
# * {Types::RegisterDomainResponse#operation_id #OperationId} => String
|
844
|
+
#
|
845
|
+
# @example Request syntax with placeholder values
|
846
|
+
# resp = client.register_domain({
|
847
|
+
# domain_name: "DomainName", # required
|
848
|
+
# idn_lang_code: "LangCode",
|
849
|
+
# duration_in_years: 1, # required
|
850
|
+
# auto_renew: false,
|
851
|
+
# admin_contact: { # required
|
852
|
+
# first_name: "ContactName",
|
853
|
+
# last_name: "ContactName",
|
854
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
855
|
+
# organization_name: "ContactName",
|
856
|
+
# address_line_1: "AddressLine",
|
857
|
+
# address_line_2: "AddressLine",
|
858
|
+
# city: "City",
|
859
|
+
# state: "State",
|
860
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
861
|
+
# zip_code: "ZipCode",
|
862
|
+
# phone_number: "ContactNumber",
|
863
|
+
# email: "Email",
|
864
|
+
# fax: "ContactNumber",
|
865
|
+
# extra_params: [
|
866
|
+
# {
|
867
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
868
|
+
# value: "ExtraParamValue", # required
|
869
|
+
# },
|
870
|
+
# ],
|
871
|
+
# },
|
872
|
+
# registrant_contact: { # required
|
873
|
+
# first_name: "ContactName",
|
874
|
+
# last_name: "ContactName",
|
875
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
876
|
+
# organization_name: "ContactName",
|
877
|
+
# address_line_1: "AddressLine",
|
878
|
+
# address_line_2: "AddressLine",
|
879
|
+
# city: "City",
|
880
|
+
# state: "State",
|
881
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
882
|
+
# zip_code: "ZipCode",
|
883
|
+
# phone_number: "ContactNumber",
|
884
|
+
# email: "Email",
|
885
|
+
# fax: "ContactNumber",
|
886
|
+
# extra_params: [
|
887
|
+
# {
|
888
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
889
|
+
# value: "ExtraParamValue", # required
|
890
|
+
# },
|
891
|
+
# ],
|
892
|
+
# },
|
893
|
+
# tech_contact: { # required
|
894
|
+
# first_name: "ContactName",
|
895
|
+
# last_name: "ContactName",
|
896
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
897
|
+
# organization_name: "ContactName",
|
898
|
+
# address_line_1: "AddressLine",
|
899
|
+
# address_line_2: "AddressLine",
|
900
|
+
# city: "City",
|
901
|
+
# state: "State",
|
902
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
903
|
+
# zip_code: "ZipCode",
|
904
|
+
# phone_number: "ContactNumber",
|
905
|
+
# email: "Email",
|
906
|
+
# fax: "ContactNumber",
|
907
|
+
# extra_params: [
|
908
|
+
# {
|
909
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
910
|
+
# value: "ExtraParamValue", # required
|
911
|
+
# },
|
912
|
+
# ],
|
913
|
+
# },
|
914
|
+
# privacy_protect_admin_contact: false,
|
915
|
+
# privacy_protect_registrant_contact: false,
|
916
|
+
# privacy_protect_tech_contact: false,
|
917
|
+
# })
|
918
|
+
#
|
919
|
+
# @example Response structure
|
920
|
+
# resp.operation_id #=> String
|
921
|
+
# @overload register_domain(params = {})
|
922
|
+
# @param [Hash] params ({})
|
923
|
+
def register_domain(params = {}, options = {})
|
924
|
+
req = build_request(:register_domain, params)
|
925
|
+
req.send_request(options)
|
926
|
+
end
|
927
|
+
|
928
|
+
# This operation renews a domain for the specified number of years. The
|
929
|
+
# cost of renewing your domain is billed to your AWS account.
|
930
|
+
#
|
931
|
+
# We recommend that you renew your domain several weeks before the
|
932
|
+
# expiration date. Some TLD registries delete domains before the
|
933
|
+
# expiration date if you haven't renewed far enough in advance. For
|
934
|
+
# more information about renewing domain registration, see [Renewing
|
935
|
+
# Registration for a Domain][1] in the Amazon Route 53 documentation.
|
936
|
+
#
|
937
|
+
#
|
938
|
+
#
|
939
|
+
# [1]: http://docs.aws.amazon.com/console/route53/domain-renew
|
940
|
+
# @option params [required, String] :domain_name
|
941
|
+
# @option params [Integer] :duration_in_years
|
942
|
+
# The number of years that you want to renew the domain for. The maximum
|
943
|
+
# number of years depends on the top-level domain. For the range of
|
944
|
+
# valid values for your domain, see [Domains that You Can Register with
|
945
|
+
# Amazon Route 53][1] in the Amazon Route 53 documentation.
|
946
|
+
#
|
947
|
+
# Type: Integer
|
948
|
+
#
|
949
|
+
# Default: 1
|
950
|
+
#
|
951
|
+
# Valid values: Integer from 1 to 10
|
952
|
+
#
|
953
|
+
# Required: No
|
954
|
+
#
|
955
|
+
#
|
956
|
+
#
|
957
|
+
# [1]: http://docs.aws.amazon.com/console/route53/domain-tld-list
|
958
|
+
# @option params [required, Integer] :current_expiry_year
|
959
|
+
# The year when the registration for the domain is set to expire. This
|
960
|
+
# value must match the current expiration date for the domain.
|
961
|
+
#
|
962
|
+
# Type: Integer
|
963
|
+
#
|
964
|
+
# Default: None
|
965
|
+
#
|
966
|
+
# Valid values: Integer
|
967
|
+
#
|
968
|
+
# Required: Yes
|
969
|
+
# @return [Types::RenewDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
970
|
+
#
|
971
|
+
# * {Types::RenewDomainResponse#operation_id #OperationId} => String
|
972
|
+
#
|
973
|
+
# @example Request syntax with placeholder values
|
974
|
+
# resp = client.renew_domain({
|
975
|
+
# domain_name: "DomainName", # required
|
976
|
+
# duration_in_years: 1,
|
977
|
+
# current_expiry_year: 1, # required
|
978
|
+
# })
|
979
|
+
#
|
980
|
+
# @example Response structure
|
981
|
+
# resp.operation_id #=> String
|
982
|
+
# @overload renew_domain(params = {})
|
983
|
+
# @param [Hash] params ({})
|
984
|
+
def renew_domain(params = {}, options = {})
|
985
|
+
req = build_request(:renew_domain, params)
|
986
|
+
req.send_request(options)
|
987
|
+
end
|
988
|
+
|
989
|
+
# For operations that require confirmation that the email address for
|
990
|
+
# the registrant contact is valid, such as registering a new domain,
|
991
|
+
# this operation resends the confirmation email to the current email
|
992
|
+
# address for the registrant contact.
|
993
|
+
# @option params [String] :domain_name
|
994
|
+
# The name of the domain for which you want Amazon Route 53 to resend a
|
995
|
+
# confirmation email to the registrant contact.
|
996
|
+
#
|
997
|
+
# Type: String
|
998
|
+
#
|
999
|
+
# Default: None
|
1000
|
+
#
|
1001
|
+
# Required: Yes
|
1002
|
+
# @return [Types::ResendContactReachabilityEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1003
|
+
#
|
1004
|
+
# * {Types::ResendContactReachabilityEmailResponse#domain_name #domainName} => String
|
1005
|
+
# * {Types::ResendContactReachabilityEmailResponse#email_address #emailAddress} => String
|
1006
|
+
# * {Types::ResendContactReachabilityEmailResponse#is_already_verified #isAlreadyVerified} => Boolean
|
1007
|
+
#
|
1008
|
+
# @example Request syntax with placeholder values
|
1009
|
+
# resp = client.resend_contact_reachability_email({
|
1010
|
+
# domain_name: "DomainName",
|
1011
|
+
# })
|
1012
|
+
#
|
1013
|
+
# @example Response structure
|
1014
|
+
# resp.domain_name #=> String
|
1015
|
+
# resp.email_address #=> String
|
1016
|
+
# resp.is_already_verified #=> Boolean
|
1017
|
+
# @overload resend_contact_reachability_email(params = {})
|
1018
|
+
# @param [Hash] params ({})
|
1019
|
+
def resend_contact_reachability_email(params = {}, options = {})
|
1020
|
+
req = build_request(:resend_contact_reachability_email, params)
|
1021
|
+
req.send_request(options)
|
1022
|
+
end
|
1023
|
+
|
1024
|
+
# This operation returns the AuthCode for the domain. To transfer a
|
1025
|
+
# domain to another registrar, you provide this value to the new
|
1026
|
+
# registrar.
|
1027
|
+
# @option params [required, String] :domain_name
|
1028
|
+
# The name of a domain.
|
1029
|
+
#
|
1030
|
+
# Type: String
|
1031
|
+
#
|
1032
|
+
# Default: None
|
1033
|
+
#
|
1034
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1035
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
1036
|
+
# Names are not supported.
|
1037
|
+
#
|
1038
|
+
# Required: Yes
|
1039
|
+
# @return [Types::RetrieveDomainAuthCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1040
|
+
#
|
1041
|
+
# * {Types::RetrieveDomainAuthCodeResponse#auth_code #AuthCode} => String
|
1042
|
+
#
|
1043
|
+
# @example Request syntax with placeholder values
|
1044
|
+
# resp = client.retrieve_domain_auth_code({
|
1045
|
+
# domain_name: "DomainName", # required
|
1046
|
+
# })
|
1047
|
+
#
|
1048
|
+
# @example Response structure
|
1049
|
+
# resp.auth_code #=> String
|
1050
|
+
# @overload retrieve_domain_auth_code(params = {})
|
1051
|
+
# @param [Hash] params ({})
|
1052
|
+
def retrieve_domain_auth_code(params = {}, options = {})
|
1053
|
+
req = build_request(:retrieve_domain_auth_code, params)
|
1054
|
+
req.send_request(options)
|
1055
|
+
end
|
1056
|
+
|
1057
|
+
# This operation transfers a domain from another registrar to Amazon
|
1058
|
+
# Route 53. When the transfer is complete, the domain is registered with
|
1059
|
+
# the AWS registrar partner, Gandi.
|
1060
|
+
#
|
1061
|
+
# For transfer requirements, a detailed procedure, and information about
|
1062
|
+
# viewing the status of a domain transfer, see [Transferring
|
1063
|
+
# Registration for a Domain to Amazon Route 53][1] in the Amazon Route
|
1064
|
+
# 53 Developer Guide.
|
1065
|
+
#
|
1066
|
+
# If the registrar for your domain is also the DNS service provider for
|
1067
|
+
# the domain, we highly recommend that you consider transferring your
|
1068
|
+
# DNS service to Amazon Route 53 or to another DNS service provider
|
1069
|
+
# before you transfer your registration. Some registrars provide free
|
1070
|
+
# DNS service when you purchase a domain registration. When you transfer
|
1071
|
+
# the registration, the previous registrar will not renew your domain
|
1072
|
+
# registration and could end your DNS service at any time.
|
1073
|
+
#
|
1074
|
+
# <note>Caution! If the registrar for your domain is also the DNS service provider for the domain and you don't transfer DNS service to another provider, your website, email, and the web applications associated with the domain might become unavailable.</note>
|
1075
|
+
#
|
1076
|
+
# If the transfer is successful, this method returns an operation ID
|
1077
|
+
# that you can use to track the progress and completion of the action.
|
1078
|
+
# If the transfer doesn't complete successfully, the domain registrant
|
1079
|
+
# will be notified by email.
|
1080
|
+
#
|
1081
|
+
#
|
1082
|
+
#
|
1083
|
+
# [1]: http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html
|
1084
|
+
# @option params [required, String] :domain_name
|
1085
|
+
# The name of a domain.
|
1086
|
+
#
|
1087
|
+
# Type: String
|
1088
|
+
#
|
1089
|
+
# Default: None
|
1090
|
+
#
|
1091
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1092
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
1093
|
+
# Names are not supported.
|
1094
|
+
#
|
1095
|
+
# Required: Yes
|
1096
|
+
# @option params [String] :idn_lang_code
|
1097
|
+
# Reserved for future use.
|
1098
|
+
# @option params [required, Integer] :duration_in_years
|
1099
|
+
# The number of years the domain will be registered. Domains are
|
1100
|
+
# registered for a minimum of one year. The maximum period depends on
|
1101
|
+
# the top-level domain.
|
1102
|
+
#
|
1103
|
+
# Type: Integer
|
1104
|
+
#
|
1105
|
+
# Default: 1
|
1106
|
+
#
|
1107
|
+
# Valid values: Integer from 1 to 10
|
1108
|
+
#
|
1109
|
+
# Required: Yes
|
1110
|
+
# @option params [Array<Types::Nameserver>] :nameservers
|
1111
|
+
# Contains details for the host and glue IP addresses.
|
1112
|
+
#
|
1113
|
+
# Type: Complex
|
1114
|
+
#
|
1115
|
+
# Children: `GlueIps`, `Name`
|
1116
|
+
#
|
1117
|
+
# Required: No
|
1118
|
+
# @option params [String] :auth_code
|
1119
|
+
# The authorization code for the domain. You get this value from the
|
1120
|
+
# current registrar.
|
1121
|
+
#
|
1122
|
+
# Type: String
|
1123
|
+
#
|
1124
|
+
# Required: Yes
|
1125
|
+
# @option params [Boolean] :auto_renew
|
1126
|
+
# Indicates whether the domain will be automatically renewed (true) or
|
1127
|
+
# not (false). Autorenewal only takes effect after the account is
|
1128
|
+
# charged.
|
1129
|
+
#
|
1130
|
+
# Type: Boolean
|
1131
|
+
#
|
1132
|
+
# Valid values: `true` \| `false`
|
1133
|
+
#
|
1134
|
+
# Default: true
|
1135
|
+
#
|
1136
|
+
# Required: No
|
1137
|
+
# @option params [required, Types::ContactDetail] :admin_contact
|
1138
|
+
# Provides detailed contact information.
|
1139
|
+
#
|
1140
|
+
# Type: Complex
|
1141
|
+
#
|
1142
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1143
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1144
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1145
|
+
#
|
1146
|
+
# Required: Yes
|
1147
|
+
# @option params [required, Types::ContactDetail] :registrant_contact
|
1148
|
+
# Provides detailed contact information.
|
1149
|
+
#
|
1150
|
+
# Type: Complex
|
1151
|
+
#
|
1152
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1153
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1154
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1155
|
+
#
|
1156
|
+
# Required: Yes
|
1157
|
+
# @option params [required, Types::ContactDetail] :tech_contact
|
1158
|
+
# Provides detailed contact information.
|
1159
|
+
#
|
1160
|
+
# Type: Complex
|
1161
|
+
#
|
1162
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1163
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1164
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1165
|
+
#
|
1166
|
+
# Required: Yes
|
1167
|
+
# @option params [Boolean] :privacy_protect_admin_contact
|
1168
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1169
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1170
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1171
|
+
# information that you enter.
|
1172
|
+
#
|
1173
|
+
# Type: Boolean
|
1174
|
+
#
|
1175
|
+
# Default: `true`
|
1176
|
+
#
|
1177
|
+
# Valid values: `true` \| `false`
|
1178
|
+
#
|
1179
|
+
# Required: No
|
1180
|
+
# @option params [Boolean] :privacy_protect_registrant_contact
|
1181
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1182
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1183
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1184
|
+
# information that you enter.
|
1185
|
+
#
|
1186
|
+
# Type: Boolean
|
1187
|
+
#
|
1188
|
+
# Default: `true`
|
1189
|
+
#
|
1190
|
+
# Valid values: `true` \| `false`
|
1191
|
+
#
|
1192
|
+
# Required: No
|
1193
|
+
# @option params [Boolean] :privacy_protect_tech_contact
|
1194
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1195
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1196
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1197
|
+
# information that you enter.
|
1198
|
+
#
|
1199
|
+
# Type: Boolean
|
1200
|
+
#
|
1201
|
+
# Default: `true`
|
1202
|
+
#
|
1203
|
+
# Valid values: `true` \| `false`
|
1204
|
+
#
|
1205
|
+
# Required: No
|
1206
|
+
# @return [Types::TransferDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1207
|
+
#
|
1208
|
+
# * {Types::TransferDomainResponse#operation_id #OperationId} => String
|
1209
|
+
#
|
1210
|
+
# @example Request syntax with placeholder values
|
1211
|
+
# resp = client.transfer_domain({
|
1212
|
+
# domain_name: "DomainName", # required
|
1213
|
+
# idn_lang_code: "LangCode",
|
1214
|
+
# duration_in_years: 1, # required
|
1215
|
+
# nameservers: [
|
1216
|
+
# {
|
1217
|
+
# name: "HostName", # required
|
1218
|
+
# glue_ips: ["GlueIp"],
|
1219
|
+
# },
|
1220
|
+
# ],
|
1221
|
+
# auth_code: "DomainAuthCode",
|
1222
|
+
# auto_renew: false,
|
1223
|
+
# admin_contact: { # required
|
1224
|
+
# first_name: "ContactName",
|
1225
|
+
# last_name: "ContactName",
|
1226
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1227
|
+
# organization_name: "ContactName",
|
1228
|
+
# address_line_1: "AddressLine",
|
1229
|
+
# address_line_2: "AddressLine",
|
1230
|
+
# city: "City",
|
1231
|
+
# state: "State",
|
1232
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1233
|
+
# zip_code: "ZipCode",
|
1234
|
+
# phone_number: "ContactNumber",
|
1235
|
+
# email: "Email",
|
1236
|
+
# fax: "ContactNumber",
|
1237
|
+
# extra_params: [
|
1238
|
+
# {
|
1239
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1240
|
+
# value: "ExtraParamValue", # required
|
1241
|
+
# },
|
1242
|
+
# ],
|
1243
|
+
# },
|
1244
|
+
# registrant_contact: { # required
|
1245
|
+
# first_name: "ContactName",
|
1246
|
+
# last_name: "ContactName",
|
1247
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1248
|
+
# organization_name: "ContactName",
|
1249
|
+
# address_line_1: "AddressLine",
|
1250
|
+
# address_line_2: "AddressLine",
|
1251
|
+
# city: "City",
|
1252
|
+
# state: "State",
|
1253
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1254
|
+
# zip_code: "ZipCode",
|
1255
|
+
# phone_number: "ContactNumber",
|
1256
|
+
# email: "Email",
|
1257
|
+
# fax: "ContactNumber",
|
1258
|
+
# extra_params: [
|
1259
|
+
# {
|
1260
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1261
|
+
# value: "ExtraParamValue", # required
|
1262
|
+
# },
|
1263
|
+
# ],
|
1264
|
+
# },
|
1265
|
+
# tech_contact: { # required
|
1266
|
+
# first_name: "ContactName",
|
1267
|
+
# last_name: "ContactName",
|
1268
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1269
|
+
# organization_name: "ContactName",
|
1270
|
+
# address_line_1: "AddressLine",
|
1271
|
+
# address_line_2: "AddressLine",
|
1272
|
+
# city: "City",
|
1273
|
+
# state: "State",
|
1274
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1275
|
+
# zip_code: "ZipCode",
|
1276
|
+
# phone_number: "ContactNumber",
|
1277
|
+
# email: "Email",
|
1278
|
+
# fax: "ContactNumber",
|
1279
|
+
# extra_params: [
|
1280
|
+
# {
|
1281
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1282
|
+
# value: "ExtraParamValue", # required
|
1283
|
+
# },
|
1284
|
+
# ],
|
1285
|
+
# },
|
1286
|
+
# privacy_protect_admin_contact: false,
|
1287
|
+
# privacy_protect_registrant_contact: false,
|
1288
|
+
# privacy_protect_tech_contact: false,
|
1289
|
+
# })
|
1290
|
+
#
|
1291
|
+
# @example Response structure
|
1292
|
+
# resp.operation_id #=> String
|
1293
|
+
# @overload transfer_domain(params = {})
|
1294
|
+
# @param [Hash] params ({})
|
1295
|
+
def transfer_domain(params = {}, options = {})
|
1296
|
+
req = build_request(:transfer_domain, params)
|
1297
|
+
req.send_request(options)
|
1298
|
+
end
|
1299
|
+
|
1300
|
+
# This operation updates the contact information for a particular
|
1301
|
+
# domain. Information for at least one contact (registrant,
|
1302
|
+
# administrator, or technical) must be supplied for update.
|
1303
|
+
#
|
1304
|
+
# If the update is successful, this method returns an operation ID that
|
1305
|
+
# you can use to track the progress and completion of the action. If the
|
1306
|
+
# request is not completed successfully, the domain registrant will be
|
1307
|
+
# notified by email.
|
1308
|
+
# @option params [required, String] :domain_name
|
1309
|
+
# The name of a domain.
|
1310
|
+
#
|
1311
|
+
# Type: String
|
1312
|
+
#
|
1313
|
+
# Default: None
|
1314
|
+
#
|
1315
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1316
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
1317
|
+
# Names are not supported.
|
1318
|
+
#
|
1319
|
+
# Required: Yes
|
1320
|
+
# @option params [Types::ContactDetail] :admin_contact
|
1321
|
+
# Provides detailed contact information.
|
1322
|
+
#
|
1323
|
+
# Type: Complex
|
1324
|
+
#
|
1325
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1326
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1327
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1328
|
+
#
|
1329
|
+
# Required: Yes
|
1330
|
+
# @option params [Types::ContactDetail] :registrant_contact
|
1331
|
+
# Provides detailed contact information.
|
1332
|
+
#
|
1333
|
+
# Type: Complex
|
1334
|
+
#
|
1335
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1336
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1337
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1338
|
+
#
|
1339
|
+
# Required: Yes
|
1340
|
+
# @option params [Types::ContactDetail] :tech_contact
|
1341
|
+
# Provides detailed contact information.
|
1342
|
+
#
|
1343
|
+
# Type: Complex
|
1344
|
+
#
|
1345
|
+
# Children: `FirstName`, `MiddleName`, `LastName`, `ContactType`,
|
1346
|
+
# `OrganizationName`, `AddressLine1`, `AddressLine2`, `City`, `State`,
|
1347
|
+
# `CountryCode`, `ZipCode`, `PhoneNumber`, `Email`, `Fax`, `ExtraParams`
|
1348
|
+
#
|
1349
|
+
# Required: Yes
|
1350
|
+
# @return [Types::UpdateDomainContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1351
|
+
#
|
1352
|
+
# * {Types::UpdateDomainContactResponse#operation_id #OperationId} => String
|
1353
|
+
#
|
1354
|
+
# @example Request syntax with placeholder values
|
1355
|
+
# resp = client.update_domain_contact({
|
1356
|
+
# domain_name: "DomainName", # required
|
1357
|
+
# admin_contact: {
|
1358
|
+
# first_name: "ContactName",
|
1359
|
+
# last_name: "ContactName",
|
1360
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1361
|
+
# organization_name: "ContactName",
|
1362
|
+
# address_line_1: "AddressLine",
|
1363
|
+
# address_line_2: "AddressLine",
|
1364
|
+
# city: "City",
|
1365
|
+
# state: "State",
|
1366
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1367
|
+
# zip_code: "ZipCode",
|
1368
|
+
# phone_number: "ContactNumber",
|
1369
|
+
# email: "Email",
|
1370
|
+
# fax: "ContactNumber",
|
1371
|
+
# extra_params: [
|
1372
|
+
# {
|
1373
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1374
|
+
# value: "ExtraParamValue", # required
|
1375
|
+
# },
|
1376
|
+
# ],
|
1377
|
+
# },
|
1378
|
+
# registrant_contact: {
|
1379
|
+
# first_name: "ContactName",
|
1380
|
+
# last_name: "ContactName",
|
1381
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1382
|
+
# organization_name: "ContactName",
|
1383
|
+
# address_line_1: "AddressLine",
|
1384
|
+
# address_line_2: "AddressLine",
|
1385
|
+
# city: "City",
|
1386
|
+
# state: "State",
|
1387
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1388
|
+
# zip_code: "ZipCode",
|
1389
|
+
# phone_number: "ContactNumber",
|
1390
|
+
# email: "Email",
|
1391
|
+
# fax: "ContactNumber",
|
1392
|
+
# extra_params: [
|
1393
|
+
# {
|
1394
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1395
|
+
# value: "ExtraParamValue", # required
|
1396
|
+
# },
|
1397
|
+
# ],
|
1398
|
+
# },
|
1399
|
+
# tech_contact: {
|
1400
|
+
# first_name: "ContactName",
|
1401
|
+
# last_name: "ContactName",
|
1402
|
+
# contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER
|
1403
|
+
# organization_name: "ContactName",
|
1404
|
+
# address_line_1: "AddressLine",
|
1405
|
+
# address_line_2: "AddressLine",
|
1406
|
+
# city: "City",
|
1407
|
+
# state: "State",
|
1408
|
+
# country_code: "AD", # accepts AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BR, BS, BT, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GH, GI, GL, GM, GN, GQ, GR, GT, GU, GW, GY, HK, HN, HR, HT, HU, ID, IE, IL, IM, IN, IQ, IR, IS, IT, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PT, PW, PY, QA, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SK, SL, SM, SN, SO, SR, ST, SV, SY, SZ, TC, TD, TG, TH, TJ, TK, TL, TM, TN, TO, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW
|
1409
|
+
# zip_code: "ZipCode",
|
1410
|
+
# phone_number: "ContactNumber",
|
1411
|
+
# email: "Email",
|
1412
|
+
# fax: "ContactNumber",
|
1413
|
+
# extra_params: [
|
1414
|
+
# {
|
1415
|
+
# name: "DUNS_NUMBER", # required, accepts DUNS_NUMBER, BRAND_NUMBER, BIRTH_DEPARTMENT, BIRTH_DATE_IN_YYYY_MM_DD, BIRTH_COUNTRY, BIRTH_CITY, DOCUMENT_NUMBER, AU_ID_NUMBER, AU_ID_TYPE, CA_LEGAL_TYPE, CA_BUSINESS_ENTITY_TYPE, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, IT_PIN, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER
|
1416
|
+
# value: "ExtraParamValue", # required
|
1417
|
+
# },
|
1418
|
+
# ],
|
1419
|
+
# },
|
1420
|
+
# })
|
1421
|
+
#
|
1422
|
+
# @example Response structure
|
1423
|
+
# resp.operation_id #=> String
|
1424
|
+
# @overload update_domain_contact(params = {})
|
1425
|
+
# @param [Hash] params ({})
|
1426
|
+
def update_domain_contact(params = {}, options = {})
|
1427
|
+
req = build_request(:update_domain_contact, params)
|
1428
|
+
req.send_request(options)
|
1429
|
+
end
|
1430
|
+
|
1431
|
+
# This operation updates the specified domain contact's privacy
|
1432
|
+
# setting. When the privacy option is enabled, personal information such
|
1433
|
+
# as postal or email address is hidden from the results of a public
|
1434
|
+
# WHOIS query. The privacy services are provided by the AWS registrar,
|
1435
|
+
# Gandi. For more information, see the [Gandi privacy features][1].
|
1436
|
+
#
|
1437
|
+
# This operation only affects the privacy of the specified contact type
|
1438
|
+
# (registrant, administrator, or tech). Successful acceptance returns an
|
1439
|
+
# operation ID that you can use with GetOperationDetail to track the
|
1440
|
+
# progress and completion of the action. If the request is not completed
|
1441
|
+
# successfully, the domain registrant will be notified by email.
|
1442
|
+
#
|
1443
|
+
#
|
1444
|
+
#
|
1445
|
+
# [1]: http://www.gandi.net/domain/whois/?currency=USD&amp;lang=en
|
1446
|
+
# @option params [required, String] :domain_name
|
1447
|
+
# The name of a domain.
|
1448
|
+
#
|
1449
|
+
# Type: String
|
1450
|
+
#
|
1451
|
+
# Default: None
|
1452
|
+
#
|
1453
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1454
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
1455
|
+
# Names are not supported.
|
1456
|
+
#
|
1457
|
+
# Required: Yes
|
1458
|
+
# @option params [Boolean] :admin_privacy
|
1459
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1460
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1461
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1462
|
+
# information that you enter.
|
1463
|
+
#
|
1464
|
+
# Type: Boolean
|
1465
|
+
#
|
1466
|
+
# Default: None
|
1467
|
+
#
|
1468
|
+
# Valid values: `true` \| `false`
|
1469
|
+
#
|
1470
|
+
# Required: No
|
1471
|
+
# @option params [Boolean] :registrant_privacy
|
1472
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1473
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1474
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1475
|
+
# information that you enter.
|
1476
|
+
#
|
1477
|
+
# Type: Boolean
|
1478
|
+
#
|
1479
|
+
# Default: None
|
1480
|
+
#
|
1481
|
+
# Valid values: `true` \| `false`
|
1482
|
+
#
|
1483
|
+
# Required: No
|
1484
|
+
# @option params [Boolean] :tech_privacy
|
1485
|
+
# Whether you want to conceal contact information from WHOIS queries. If
|
1486
|
+
# you specify true, WHOIS ("who is") queries will return contact
|
1487
|
+
# information for our registrar partner, Gandi, instead of the contact
|
1488
|
+
# information that you enter.
|
1489
|
+
#
|
1490
|
+
# Type: Boolean
|
1491
|
+
#
|
1492
|
+
# Default: None
|
1493
|
+
#
|
1494
|
+
# Valid values: `true` \| `false`
|
1495
|
+
#
|
1496
|
+
# Required: No
|
1497
|
+
# @return [Types::UpdateDomainContactPrivacyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1498
|
+
#
|
1499
|
+
# * {Types::UpdateDomainContactPrivacyResponse#operation_id #OperationId} => String
|
1500
|
+
#
|
1501
|
+
# @example Request syntax with placeholder values
|
1502
|
+
# resp = client.update_domain_contact_privacy({
|
1503
|
+
# domain_name: "DomainName", # required
|
1504
|
+
# admin_privacy: false,
|
1505
|
+
# registrant_privacy: false,
|
1506
|
+
# tech_privacy: false,
|
1507
|
+
# })
|
1508
|
+
#
|
1509
|
+
# @example Response structure
|
1510
|
+
# resp.operation_id #=> String
|
1511
|
+
# @overload update_domain_contact_privacy(params = {})
|
1512
|
+
# @param [Hash] params ({})
|
1513
|
+
def update_domain_contact_privacy(params = {}, options = {})
|
1514
|
+
req = build_request(:update_domain_contact_privacy, params)
|
1515
|
+
req.send_request(options)
|
1516
|
+
end
|
1517
|
+
|
1518
|
+
# This operation replaces the current set of name servers for the domain
|
1519
|
+
# with the specified set of name servers. If you use Amazon Route 53 as
|
1520
|
+
# your DNS service, specify the four name servers in the delegation set
|
1521
|
+
# for the hosted zone for the domain.
|
1522
|
+
#
|
1523
|
+
# If successful, this operation returns an operation ID that you can use
|
1524
|
+
# to track the progress and completion of the action. If the request is
|
1525
|
+
# not completed successfully, the domain registrant will be notified by
|
1526
|
+
# email.
|
1527
|
+
# @option params [required, String] :domain_name
|
1528
|
+
# The name of a domain.
|
1529
|
+
#
|
1530
|
+
# Type: String
|
1531
|
+
#
|
1532
|
+
# Default: None
|
1533
|
+
#
|
1534
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1535
|
+
# the numbers 0 through 9, and hyphen (-). Internationalized Domain
|
1536
|
+
# Names are not supported.
|
1537
|
+
#
|
1538
|
+
# Required: Yes
|
1539
|
+
# @option params [String] :fi_auth_key
|
1540
|
+
# The authorization key for .fi domains
|
1541
|
+
# @option params [required, Array<Types::Nameserver>] :nameservers
|
1542
|
+
# A list of new name servers for the domain.
|
1543
|
+
#
|
1544
|
+
# Type: Complex
|
1545
|
+
#
|
1546
|
+
# Children: `Name`, `GlueIps`
|
1547
|
+
#
|
1548
|
+
# Required: Yes
|
1549
|
+
# @return [Types::UpdateDomainNameserversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1550
|
+
#
|
1551
|
+
# * {Types::UpdateDomainNameserversResponse#operation_id #OperationId} => String
|
1552
|
+
#
|
1553
|
+
# @example Request syntax with placeholder values
|
1554
|
+
# resp = client.update_domain_nameservers({
|
1555
|
+
# domain_name: "DomainName", # required
|
1556
|
+
# fi_auth_key: "FIAuthKey",
|
1557
|
+
# nameservers: [ # required
|
1558
|
+
# {
|
1559
|
+
# name: "HostName", # required
|
1560
|
+
# glue_ips: ["GlueIp"],
|
1561
|
+
# },
|
1562
|
+
# ],
|
1563
|
+
# })
|
1564
|
+
#
|
1565
|
+
# @example Response structure
|
1566
|
+
# resp.operation_id #=> String
|
1567
|
+
# @overload update_domain_nameservers(params = {})
|
1568
|
+
# @param [Hash] params ({})
|
1569
|
+
def update_domain_nameservers(params = {}, options = {})
|
1570
|
+
req = build_request(:update_domain_nameservers, params)
|
1571
|
+
req.send_request(options)
|
1572
|
+
end
|
1573
|
+
|
1574
|
+
# This operation adds or updates tags for a specified domain.
|
1575
|
+
#
|
1576
|
+
# All tag operations are eventually consistent; subsequent operations
|
1577
|
+
# may not immediately represent all issued operations.
|
1578
|
+
# @option params [required, String] :domain_name
|
1579
|
+
# The domain for which you want to add or update tags.
|
1580
|
+
#
|
1581
|
+
# The name of a domain.
|
1582
|
+
#
|
1583
|
+
# Type: String
|
1584
|
+
#
|
1585
|
+
# Default: None
|
1586
|
+
#
|
1587
|
+
# Constraints: The domain name can contain only the letters a through z,
|
1588
|
+
# the numbers 0 through 9, and hyphen (-). Hyphens are allowed only when
|
1589
|
+
# they're surrounded by letters, numbers, or other hyphens. You can't
|
1590
|
+
# specify a hyphen at the beginning or end of a label. To specify an
|
1591
|
+
# Internationalized Domain Name, you must convert the name to Punycode.
|
1592
|
+
#
|
1593
|
+
# Required: Yes
|
1594
|
+
# @option params [Array<Types::Tag>] :tags_to_update
|
1595
|
+
# A list of the tag keys and values that you want to add or update. If
|
1596
|
+
# you specify a key that already exists, the corresponding value will be
|
1597
|
+
# replaced.
|
1598
|
+
#
|
1599
|
+
# Type: A complex type containing a list of tags
|
1600
|
+
#
|
1601
|
+
# Default: None
|
1602
|
+
#
|
1603
|
+
# Required: No
|
1604
|
+
#
|
1605
|
+
# '> Each tag includes the following elements:
|
1606
|
+
#
|
1607
|
+
# * Key
|
1608
|
+
#
|
1609
|
+
# The key (name) of a tag.
|
1610
|
+
#
|
1611
|
+
# Type: String
|
1612
|
+
#
|
1613
|
+
# Default: None
|
1614
|
+
#
|
1615
|
+
# Valid values: Unicode characters including alphanumeric, space, and
|
1616
|
+
# ".:/=+\\-@"
|
1617
|
+
#
|
1618
|
+
# Constraints: Each key can be 1-128 characters long.
|
1619
|
+
#
|
1620
|
+
# Required: Yes
|
1621
|
+
#
|
1622
|
+
# * Value
|
1623
|
+
#
|
1624
|
+
# The value of a tag.
|
1625
|
+
#
|
1626
|
+
# Type: String
|
1627
|
+
#
|
1628
|
+
# Default: None
|
1629
|
+
#
|
1630
|
+
# Valid values: Unicode characters including alphanumeric, space, and
|
1631
|
+
# ".:/=+\\-@"
|
1632
|
+
#
|
1633
|
+
# Constraints: Each value can be 0-256 characters long.
|
1634
|
+
#
|
1635
|
+
# Required: Yes
|
1636
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1637
|
+
#
|
1638
|
+
# @example Request syntax with placeholder values
|
1639
|
+
# resp = client.update_tags_for_domain({
|
1640
|
+
# domain_name: "DomainName", # required
|
1641
|
+
# tags_to_update: [
|
1642
|
+
# {
|
1643
|
+
# key: "TagKey",
|
1644
|
+
# value: "TagValue",
|
1645
|
+
# },
|
1646
|
+
# ],
|
1647
|
+
# })
|
1648
|
+
# @overload update_tags_for_domain(params = {})
|
1649
|
+
# @param [Hash] params ({})
|
1650
|
+
def update_tags_for_domain(params = {}, options = {})
|
1651
|
+
req = build_request(:update_tags_for_domain, params)
|
1652
|
+
req.send_request(options)
|
1653
|
+
end
|
1654
|
+
|
1655
|
+
# This operation returns all the domain-related billing records for the
|
1656
|
+
# current AWS account for a specified period
|
1657
|
+
# @option params [Time,DateTime,Date,Integer,String] :start
|
1658
|
+
# The beginning date and time for the time period for which you want a
|
1659
|
+
# list of billing records. Specify the date in Unix time format.
|
1660
|
+
#
|
1661
|
+
# Type: Double
|
1662
|
+
#
|
1663
|
+
# Default: None
|
1664
|
+
#
|
1665
|
+
# Required: Yes
|
1666
|
+
# @option params [Time,DateTime,Date,Integer,String] :end
|
1667
|
+
# The end date and time for the time period for which you want a list of
|
1668
|
+
# billing records. Specify the date in Unix time format.
|
1669
|
+
#
|
1670
|
+
# Type: Double
|
1671
|
+
#
|
1672
|
+
# Default: None
|
1673
|
+
#
|
1674
|
+
# Required: Yes
|
1675
|
+
# @option params [String] :marker
|
1676
|
+
# For an initial request for a list of billing records, omit this
|
1677
|
+
# element. If the number of billing records that are associated with the
|
1678
|
+
# current AWS account during the specified period is greater than the
|
1679
|
+
# value that you specified for `MaxItems`, you can use `Marker` to
|
1680
|
+
# return additional billing records. Get the value of `NextPageMarker`
|
1681
|
+
# from the previous response, and submit another request that includes
|
1682
|
+
# the value of `NextPageMarker` in the `Marker` element.
|
1683
|
+
#
|
1684
|
+
# Type: String
|
1685
|
+
#
|
1686
|
+
# Default: None
|
1687
|
+
#
|
1688
|
+
# Constraints: The marker must match the value of `NextPageMarker` that
|
1689
|
+
# was returned in the previous response.
|
1690
|
+
#
|
1691
|
+
# Required: No
|
1692
|
+
# @option params [Integer] :max_items
|
1693
|
+
# The number of billing records to be returned.
|
1694
|
+
#
|
1695
|
+
# Type: Integer
|
1696
|
+
#
|
1697
|
+
# Default: 20
|
1698
|
+
#
|
1699
|
+
# Constraints: A value between 1 and 100.
|
1700
|
+
#
|
1701
|
+
# Required: No
|
1702
|
+
# @return [Types::ViewBillingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1703
|
+
#
|
1704
|
+
# * {Types::ViewBillingResponse#next_page_marker #NextPageMarker} => String
|
1705
|
+
# * {Types::ViewBillingResponse#billing_records #BillingRecords} => Array<Types::BillingRecord>
|
1706
|
+
#
|
1707
|
+
# @example Request syntax with placeholder values
|
1708
|
+
# resp = client.view_billing({
|
1709
|
+
# start: Time.now,
|
1710
|
+
# end: Time.now,
|
1711
|
+
# marker: "PageMarker",
|
1712
|
+
# max_items: 1,
|
1713
|
+
# })
|
1714
|
+
#
|
1715
|
+
# @example Response structure
|
1716
|
+
# resp.next_page_marker #=> String
|
1717
|
+
# resp.billing_records #=> Array
|
1718
|
+
# resp.billing_records[0].domain_name #=> String
|
1719
|
+
# resp.billing_records[0].operation #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK"
|
1720
|
+
# resp.billing_records[0].invoice_id #=> String
|
1721
|
+
# resp.billing_records[0].bill_date #=> Time
|
1722
|
+
# resp.billing_records[0].price #=> Float
|
1723
|
+
# @overload view_billing(params = {})
|
1724
|
+
# @param [Hash] params ({})
|
1725
|
+
def view_billing(params = {}, options = {})
|
1726
|
+
req = build_request(:view_billing, params)
|
1727
|
+
req.send_request(options)
|
1728
|
+
end
|
1729
|
+
|
1730
|
+
# @!endgroup
|
1731
|
+
|
1732
|
+
# @param params ({})
|
1733
|
+
# @api private
|
1734
|
+
def build_request(operation_name, params = {})
|
1735
|
+
handlers = @handlers.for(operation_name)
|
1736
|
+
context = Seahorse::Client::RequestContext.new(
|
1737
|
+
operation_name: operation_name,
|
1738
|
+
operation: config.api.operation(operation_name),
|
1739
|
+
client: self,
|
1740
|
+
params: params,
|
1741
|
+
config: config)
|
1742
|
+
context[:gem_name] = 'aws-sdk-route53domains'
|
1743
|
+
context[:gem_version] = '1.0.0.rc1'
|
1744
|
+
Seahorse::Client::Request.new(handlers, context)
|
1745
|
+
end
|
1746
|
+
|
1747
|
+
# @api private
|
1748
|
+
# @deprecated
|
1749
|
+
def waiter_names
|
1750
|
+
[]
|
1751
|
+
end
|
1752
|
+
|
1753
|
+
class << self
|
1754
|
+
|
1755
|
+
# @api private
|
1756
|
+
attr_reader :identifier
|
1757
|
+
|
1758
|
+
# @api private
|
1759
|
+
def errors_module
|
1760
|
+
Errors
|
1761
|
+
end
|
1762
|
+
|
1763
|
+
end
|
1764
|
+
end
|
1765
|
+
end
|
1766
|
+
end
|