# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE require 'seahorse/client/plugins/content_length.rb' require 'aws-sdk-core/plugins/credentials_configuration.rb' require 'aws-sdk-core/plugins/logging.rb' require 'aws-sdk-core/plugins/param_converter.rb' require 'aws-sdk-core/plugins/param_validator.rb' require 'aws-sdk-core/plugins/user_agent.rb' require 'aws-sdk-core/plugins/helpful_socket_errors.rb' require 'aws-sdk-core/plugins/retry_errors.rb' require 'aws-sdk-core/plugins/global_configuration.rb' require 'aws-sdk-core/plugins/regional_endpoint.rb' require 'aws-sdk-core/plugins/endpoint_discovery.rb' require 'aws-sdk-core/plugins/endpoint_pattern.rb' require 'aws-sdk-core/plugins/response_paging.rb' require 'aws-sdk-core/plugins/stub_responses.rb' require 'aws-sdk-core/plugins/idempotency_token.rb' require 'aws-sdk-core/plugins/invocation_id.rb' require 'aws-sdk-core/plugins/jsonvalue_converter.rb' require 'aws-sdk-core/plugins/client_metrics_plugin.rb' require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb' require 'aws-sdk-core/plugins/transfer_encoding.rb' require 'aws-sdk-core/plugins/http_checksum.rb' require 'aws-sdk-core/plugins/checksum_algorithm.rb' require 'aws-sdk-core/plugins/request_compression.rb' require 'aws-sdk-core/plugins/defaults_mode.rb' require 'aws-sdk-core/plugins/recursion_detection.rb' require 'aws-sdk-core/plugins/telemetry.rb' require 'aws-sdk-core/plugins/sign.rb' require 'aws-sdk-core/plugins/protocols/json_rpc.rb' Aws::Plugins::GlobalConfiguration.add_identifier(:route53domains) module Aws::Route53Domains # An API client for Route53Domains. To construct a client, you need to configure a `:region` and `:credentials`. # # client = Aws::Route53Domains::Client.new( # region: region_name, # credentials: credentials, # # ... # ) # # For details on configuring region and credentials see # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html). # # See {#initialize} for a full list of supported configuration options. class Client < Seahorse::Client::Base include Aws::ClientStubs @identifier = :route53domains set_api(ClientApi::API) add_plugin(Seahorse::Client::Plugins::ContentLength) add_plugin(Aws::Plugins::CredentialsConfiguration) add_plugin(Aws::Plugins::Logging) add_plugin(Aws::Plugins::ParamConverter) add_plugin(Aws::Plugins::ParamValidator) add_plugin(Aws::Plugins::UserAgent) add_plugin(Aws::Plugins::HelpfulSocketErrors) add_plugin(Aws::Plugins::RetryErrors) add_plugin(Aws::Plugins::GlobalConfiguration) add_plugin(Aws::Plugins::RegionalEndpoint) add_plugin(Aws::Plugins::EndpointDiscovery) add_plugin(Aws::Plugins::EndpointPattern) add_plugin(Aws::Plugins::ResponsePaging) add_plugin(Aws::Plugins::StubResponses) add_plugin(Aws::Plugins::IdempotencyToken) add_plugin(Aws::Plugins::InvocationId) add_plugin(Aws::Plugins::JsonvalueConverter) add_plugin(Aws::Plugins::ClientMetricsPlugin) add_plugin(Aws::Plugins::ClientMetricsSendPlugin) add_plugin(Aws::Plugins::TransferEncoding) add_plugin(Aws::Plugins::HttpChecksum) add_plugin(Aws::Plugins::ChecksumAlgorithm) add_plugin(Aws::Plugins::RequestCompression) add_plugin(Aws::Plugins::DefaultsMode) add_plugin(Aws::Plugins::RecursionDetection) add_plugin(Aws::Plugins::Telemetry) add_plugin(Aws::Plugins::Sign) add_plugin(Aws::Plugins::Protocols::JsonRpc) add_plugin(Aws::Route53Domains::Plugins::Endpoints) # @overload initialize(options) # @param [Hash] options # # @option options [Array] :plugins ([]]) # A list of plugins to apply to the client. Each plugin is either a # class name or an instance of a plugin class. # # @option options [required, Aws::CredentialProvider] :credentials # Your AWS credentials. This can be an instance of any one of the # following classes: # # * `Aws::Credentials` - Used for configuring static, non-refreshing # credentials. # # * `Aws::SharedCredentials` - Used for loading static credentials from a # shared file, such as `~/.aws/config`. # # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role. # # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to # assume a role after providing credentials via the web. # # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an # access token generated from `aws login`. # # * `Aws::ProcessCredentials` - Used for loading credentials from a # process that outputs to stdout. # # * `Aws::InstanceProfileCredentials` - Used for loading credentials # from an EC2 IMDS on an EC2 instance. # # * `Aws::ECSCredentials` - Used for loading credentials from # instances running in ECS. # # * `Aws::CognitoIdentityCredentials` - Used for loading credentials # from the Cognito Identity service. # # When `:credentials` are not configured directly, the following # locations will be searched for credentials: # # * `Aws.config[:credentials]` # * The `:access_key_id`, `:secret_access_key`, `:session_token`, and # `:account_id` options. # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], # ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'] # * `~/.aws/credentials` # * `~/.aws/config` # * EC2/ECS IMDS instance profile - When used by default, the timeouts # are very aggressive. Construct and pass an instance of # `Aws::InstanceProfileCredentials` or `Aws::ECSCredentials` to # enable retries and extended timeouts. Instance profile credential # fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] # to true. # # @option options [required, String] :region # The AWS region to connect to. The configured `:region` is # used to determine the service `:endpoint`. When not passed, # a default `:region` is searched for in the following locations: # # * `Aws.config[:region]` # * `ENV['AWS_REGION']` # * `ENV['AMAZON_REGION']` # * `ENV['AWS_DEFAULT_REGION']` # * `~/.aws/credentials` # * `~/.aws/config` # # @option options [String] :access_key_id # # @option options [String] :account_id # # @option options [Boolean] :active_endpoint_cache (false) # When set to `true`, a thread polling for endpoints will be running in # the background every 60 secs (default). Defaults to `false`. # # @option options [Boolean] :adaptive_retry_wait_to_fill (true) # Used only in `adaptive` retry mode. When true, the request will sleep # until there is sufficent client side capacity to retry the request. # When false, the request will raise a `RetryCapacityNotAvailableError` and will # not retry instead of sleeping. # # @option options [Boolean] :client_side_monitoring (false) # When `true`, client-side metrics will be collected for all API requests from # this client. # # @option options [String] :client_side_monitoring_client_id ("") # Allows you to provide an identifier for this client which will be attached to # all generated client side metrics. Defaults to an empty string. # # @option options [String] :client_side_monitoring_host ("127.0.0.1") # Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client # side monitoring agent is running on, where client metrics will be published via UDP. # # @option options [Integer] :client_side_monitoring_port (31000) # Required for publishing client metrics. The port that the client side monitoring # agent is running on, where client metrics will be published via UDP. # # @option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) # Allows you to provide a custom client-side monitoring publisher class. By default, # will use the Client Side Monitoring Agent Publisher. # # @option options [Boolean] :convert_params (true) # When `true`, an attempt is made to coerce request parameters into # the required types. # # @option options [Boolean] :correct_clock_skew (true) # Used only in `standard` and adaptive retry modes. Specifies whether to apply # a clock skew correction and retry requests with skewed client clocks. # # @option options [String] :defaults_mode ("legacy") # See {Aws::DefaultsModeConfiguration} for a list of the # accepted modes and the configuration defaults that are included. # # @option options [Boolean] :disable_host_prefix_injection (false) # Set to true to disable SDK automatically adding host prefix # to default service endpoint when available. # # @option options [Boolean] :disable_request_compression (false) # When set to 'true' the request body will not be compressed # for supported operations. # # @option options [String, URI::HTTPS, URI::HTTP] :endpoint # Normally you should not configure the `:endpoint` option # directly. This is normally constructed from the `:region` # option. Configuring `:endpoint` is normally reserved for # connecting to test or custom endpoints. The endpoint should # be a URI formatted like: # # 'http://example.com' # 'https://example.com' # 'http://example.com:123' # # @option options [Integer] :endpoint_cache_max_entries (1000) # Used for the maximum size limit of the LRU cache storing endpoints data # for endpoint discovery enabled operations. Defaults to 1000. # # @option options [Integer] :endpoint_cache_max_threads (10) # Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. # # @option options [Integer] :endpoint_cache_poll_interval (60) # When :endpoint_discovery and :active_endpoint_cache is enabled, # Use this option to config the time interval in seconds for making # requests fetching endpoints information. Defaults to 60 sec. # # @option options [Boolean] :endpoint_discovery (false) # When set to `true`, endpoint discovery will be enabled for operations when available. # # @option options [Boolean] :ignore_configured_endpoint_urls # Setting to true disables use of endpoint URLs provided via environment # variables and the shared configuration file. # # @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default) # The log formatter. # # @option options [Symbol] :log_level (:info) # The log level to send messages to the `:logger` at. # # @option options [Logger] :logger # The Logger instance to send log messages to. If this option # is not set, logging will be disabled. # # @option options [Integer] :max_attempts (3) # An integer representing the maximum number attempts that will be made for # a single request, including the initial attempt. For example, # setting this value to 5 will result in a request being retried up to # 4 times. Used in `standard` and `adaptive` retry modes. # # @option options [String] :profile ("default") # Used when loading credentials from the shared credentials file # at HOME/.aws/credentials. When not specified, 'default' is used. # # @option options [Integer] :request_min_compression_size_bytes (10240) # The minimum size in bytes that triggers compression for request # bodies. The value must be non-negative integer value between 0 # and 10485780 bytes inclusive. # # @option options [Proc] :retry_backoff # A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. # This option is only used in the `legacy` retry mode. # # @option options [Float] :retry_base_delay (0.3) # The base delay in seconds used by the default backoff function. This option # is only used in the `legacy` retry mode. # # @option options [Symbol] :retry_jitter (:none) # A delay randomiser function used by the default backoff function. # Some predefined functions can be referenced by name - :none, :equal, :full, # otherwise a Proc that takes and returns a number. This option is only used # in the `legacy` retry mode. # # @see https://www.awsarchitectureblog.com/2015/03/backoff.html # # @option options [Integer] :retry_limit (3) # The maximum number of times to retry failed requests. Only # ~ 500 level server errors and certain ~ 400 level client errors # are retried. Generally, these are throttling errors, data # checksum errors, networking errors, timeout errors, auth errors, # endpoint discovery, and errors from expired credentials. # This option is only used in the `legacy` retry mode. # # @option options [Integer] :retry_max_delay (0) # The maximum number of seconds to delay between retries (0 for no limit) # used by the default backoff function. This option is only used in the # `legacy` retry mode. # # @option options [String] :retry_mode ("legacy") # Specifies which retry algorithm to use. Values are: # # * `legacy` - The pre-existing retry behavior. This is default value if # no retry mode is provided. # # * `standard` - A standardized set of retry rules across the AWS SDKs. # This includes support for retry quotas, which limit the number of # unsuccessful retries a client can make. # # * `adaptive` - An experimental retry mode that includes all the # functionality of `standard` mode along with automatic client side # throttling. This is a provisional mode that may change behavior # in the future. # # @option options [String] :sdk_ua_app_id # A unique and opaque application ID that is appended to the # User-Agent header as app/sdk_ua_app_id. It should have a # maximum length of 50. This variable is sourced from environment # variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id. # # @option options [String] :secret_access_key # # @option options [String] :session_token # # @option options [Array] :sigv4a_signing_region_set # A list of regions that should be signed with SigV4a signing. When # not passed, a default `:sigv4a_signing_region_set` is searched for # in the following locations: # # * `Aws.config[:sigv4a_signing_region_set]` # * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']` # * `~/.aws/config` # # @option options [Boolean] :simple_json (false) # Disables request parameter conversion, validation, and formatting. # Also disables response data type conversions. The request parameters # hash must be formatted exactly as the API expects.This option is useful # when you want to ensure the highest level of performance by avoiding # overhead of walking request parameters and response data structures. # # @option options [Boolean] :stub_responses (false) # Causes the client to return stubbed responses. By default # fake responses are generated and returned. You can specify # the response data to return or errors to raise by calling # {ClientStubs#stub_responses}. See {ClientStubs} for more information. # # ** Please note ** When response stubbing is enabled, no HTTP # requests are made, and retries are disabled. # # @option options [Aws::Telemetry::TelemetryProviderBase] :telemetry_provider (Aws::Telemetry::NoOpTelemetryProvider) # Allows you to provide a telemetry provider, which is used to # emit telemetry data. By default, uses `NoOpTelemetryProvider` which # will not record or emit any telemetry data. The SDK supports the # following telemetry providers: # # * OpenTelemetry (OTel) - To use the OTel provider, install and require the # `opentelemetry-sdk` gem and then, pass in an instance of a # `Aws::Telemetry::OTelProvider` for telemetry provider. # # @option options [Aws::TokenProvider] :token_provider # A Bearer Token Provider. This can be an instance of any one of the # following classes: # # * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing # tokens. # # * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an # access token generated from `aws login`. # # When `:token_provider` is not configured directly, the `Aws::TokenProviderChain` # will be used to search for tokens configured for your profile in shared configuration files. # # @option options [Boolean] :use_dualstack_endpoint # When set to `true`, dualstack enabled endpoints (with `.aws` TLD) # will be used if available. # # @option options [Boolean] :use_fips_endpoint # When set to `true`, fips compatible endpoints will be used if available. # When a `fips` region is used, the region is normalized and this config # is set to `true`. # # @option options [Boolean] :validate_params (true) # When `true`, request parameters are validated before # sending the request. # # @option options [Aws::Route53Domains::EndpointProvider] :endpoint_provider # The endpoint provider used to resolve endpoints. Any object that responds to # `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to # `Aws::Route53Domains::EndpointParameters`. # # @option options [Float] :http_continue_timeout (1) # The number of seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has "Expect" # header set to "100-continue". Defaults to `nil` which disables this # behaviour. This value can safely be set per request on the session. # # @option options [Float] :http_idle_timeout (5) # The number of seconds a connection is allowed to sit idle before it # is considered stale. Stale connections are closed and removed from the # pool before making a request. # # @option options [Float] :http_open_timeout (15) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [URI::HTTP,String] :http_proxy # A proxy to send requests through. Formatted like 'http://proxy.com:123'. # # @option options [Float] :http_read_timeout (60) # The default number of seconds to wait for response data. # This value can safely be set per-request on the session. # # @option options [Boolean] :http_wire_trace (false) # When `true`, HTTP debug output will be sent to the `:logger`. # # @option options [Proc] :on_chunk_received # When a Proc object is provided, it will be used as callback when each chunk # of the response body is received. It provides three arguments: the chunk, # the number of bytes received, and the total number of # bytes in the response (or nil if the server did not send a `content-length`). # # @option options [Proc] :on_chunk_sent # When a Proc object is provided, it will be used as callback when each chunk # of the request body is sent. It provides three arguments: the chunk, # the number of bytes read from the body, and the total number of # bytes in the body. # # @option options [Boolean] :raise_response_errors (true) # When `true`, response errors are raised. # # @option options [String] :ssl_ca_bundle # Full path to the SSL certificate authority bundle file that should be used when # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or # `:ssl_ca_directory` the the system default will be used if available. # # @option options [String] :ssl_ca_directory # Full path of the directory that contains the unbundled SSL certificate # authority files for verifying peer certificates. If you do # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system # default will be used if available. # # @option options [String] :ssl_ca_store # Sets the X509::Store to verify peer certificate. # # @option options [OpenSSL::X509::Certificate] :ssl_cert # Sets a client certificate when creating http connections. # # @option options [OpenSSL::PKey] :ssl_key # Sets a client key when creating http connections. # # @option options [Float] :ssl_timeout # Sets the SSL timeout in seconds # # @option options [Boolean] :ssl_verify_peer (true) # When `true`, SSL peer certificates are verified when establishing a connection. # def initialize(*args) super end # @!group API Operations # Accepts the transfer of a domain from another Amazon Web Services # account to the currentAmazon Web Services account. You initiate a # transfer between Amazon Web Services accounts using # [TransferDomainToAnotherAwsAccount][1]. # # If you use the CLI command at # [accept-domain-transfer-from-another-aws-account][2], use JSON format # as input instead of text because otherwise CLI will throw an error # from domain transfer input that includes single quotes. # # Use either [ListOperations][3] or [GetOperationDetail][4] to determine # whether the operation succeeded. [GetOperationDetail][4] provides # additional information, for example, `Domain Transfer from Aws Account # 111122223333 has been cancelled`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # [2]: https://docs.aws.amazon.com/cli/latest/reference/route53domains/accept-domain-transfer-from-another-aws-account.html # [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html # [4]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html # # @option params [required, String] :domain_name # The name of the domain that was specified when another Amazon Web # Services account submitted a [TransferDomainToAnotherAwsAccount][1] # request. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # # @option params [required, String] :password # The password that was returned by the # [TransferDomainToAnotherAwsAccount][1] request. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # # @return [Types::AcceptDomainTransferFromAnotherAwsAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AcceptDomainTransferFromAnotherAwsAccountResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.accept_domain_transfer_from_another_aws_account({ # domain_name: "DomainName", # required # password: "Password", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/AcceptDomainTransferFromAnotherAwsAccount AWS API Documentation # # @overload accept_domain_transfer_from_another_aws_account(params = {}) # @param [Hash] params ({}) def accept_domain_transfer_from_another_aws_account(params = {}, options = {}) req = build_request(:accept_domain_transfer_from_another_aws_account, params) req.send_request(options) end # Creates a delegation signer (DS) record in the registry zone for this # domain name. # # Note that creating DS record at the registry impacts DNSSEC validation # of your DNS records. This action may render your domain name # unavailable on the internet if the steps are completed in the wrong # order, or with incorrect timing. For more information about DNSSEC # signing, see [Configuring DNSSEC signing][1] in the *Route 53 # developer guide*. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/dns-configuring-dnssec.html # # @option params [required, String] :domain_name # The name of the domain. # # @option params [required, Types::DnssecSigningAttributes] :signing_attributes # The information about a key, including the algorithm, public # key-value, and flags. # # @return [Types::AssociateDelegationSignerToDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::AssociateDelegationSignerToDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.associate_delegation_signer_to_domain({ # domain_name: "DomainName", # required # signing_attributes: { # required # algorithm: 1, # flags: 1, # public_key: "DnssecPublicKey", # }, # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/AssociateDelegationSignerToDomain AWS API Documentation # # @overload associate_delegation_signer_to_domain(params = {}) # @param [Hash] params ({}) def associate_delegation_signer_to_domain(params = {}, options = {}) req = build_request(:associate_delegation_signer_to_domain, params) req.send_request(options) end # Cancels the transfer of a domain from the current Amazon Web Services # account to another Amazon Web Services account. You initiate a # transfer betweenAmazon Web Services accounts using # [TransferDomainToAnotherAwsAccount][1]. # # You must cancel the transfer before the other Amazon Web Services # account accepts the transfer using # [AcceptDomainTransferFromAnotherAwsAccount][2]. # # Use either [ListOperations][3] or [GetOperationDetail][4] to determine # whether the operation succeeded. [GetOperationDetail][4] provides # additional information, for example, `Domain Transfer from Aws Account # 111122223333 has been cancelled`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html # [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html # [4]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html # # @option params [required, String] :domain_name # The name of the domain for which you want to cancel the transfer to # another Amazon Web Services account. # # @return [Types::CancelDomainTransferToAnotherAwsAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CancelDomainTransferToAnotherAwsAccountResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.cancel_domain_transfer_to_another_aws_account({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/CancelDomainTransferToAnotherAwsAccount AWS API Documentation # # @overload cancel_domain_transfer_to_another_aws_account(params = {}) # @param [Hash] params ({}) def cancel_domain_transfer_to_another_aws_account(params = {}, options = {}) req = build_request(:cancel_domain_transfer_to_another_aws_account, params) req.send_request(options) end # This operation checks the availability of one domain name. Note that # if the availability status of a domain is pending, you must submit # another request to determine the availability of the domain name. # # @option params [required, String] :domain_name # The name of the domain that you want to get availability for. The # top-level domain (TLD), such as .com, must be a TLD that Route 53 # supports. For a list of supported TLDs, see [Domains that You Can # Register with Amazon Route 53][1] in the *Amazon Route 53 Developer # Guide*. # # The domain name can contain only the following characters: # # * Letters a through z. Domain names are not case sensitive. # # * Numbers 0 through 9. # # * Hyphen (-). You can't specify a hyphen at the beginning or end of a # label. # # * Period (.) to separate the labels in the name, such as the `.` in # `example.com`. # # Internationalized domain names are not supported for some top-level # domains. To determine whether the TLD that you want to use supports # internationalized domain names, see [Domains that You Can Register # with Amazon Route 53][1]. For more information, see [Formatting # Internationalized Domain Names][2]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns # # @option params [String] :idn_lang_code # Reserved for future use. # # @return [Types::CheckDomainAvailabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CheckDomainAvailabilityResponse#availability #availability} => String # # @example Request syntax with placeholder values # # resp = client.check_domain_availability({ # domain_name: "DomainName", # required # idn_lang_code: "LangCode", # }) # # @example Response structure # # resp.availability #=> String, one of "AVAILABLE", "AVAILABLE_RESERVED", "AVAILABLE_PREORDER", "UNAVAILABLE", "UNAVAILABLE_PREMIUM", "UNAVAILABLE_RESTRICTED", "RESERVED", "DONT_KNOW", "INVALID_NAME_FOR_TLD", "PENDING" # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/CheckDomainAvailability AWS API Documentation # # @overload check_domain_availability(params = {}) # @param [Hash] params ({}) def check_domain_availability(params = {}, options = {}) req = build_request(:check_domain_availability, params) req.send_request(options) end # Checks whether a domain name can be transferred to Amazon Route 53. # # @option params [required, String] :domain_name # The name of the domain that you want to transfer to Route 53. The # top-level domain (TLD), such as .com, must be a TLD that Route 53 # supports. For a list of supported TLDs, see [Domains that You Can # Register with Amazon Route 53][1] in the *Amazon Route 53 Developer # Guide*. # # The domain name can contain only the following characters: # # * Letters a through z. Domain names are not case sensitive. # # * Numbers 0 through 9. # # * Hyphen (-). You can't specify a hyphen at the beginning or end of a # label. # # * Period (.) to separate the labels in the name, such as the `.` in # `example.com`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [String] :auth_code # If the registrar for the top-level domain (TLD) requires an # authorization code to transfer the domain, the code that you got from # the current registrar for the domain. # # @return [Types::CheckDomainTransferabilityResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CheckDomainTransferabilityResponse#transferability #transferability} => Types::DomainTransferability # * {Types::CheckDomainTransferabilityResponse#message #message} => String # # @example Request syntax with placeholder values # # resp = client.check_domain_transferability({ # domain_name: "DomainName", # required # auth_code: "DomainAuthCode", # }) # # @example Response structure # # resp.transferability.transferable #=> String, one of "TRANSFERABLE", "UNTRANSFERABLE", "DONT_KNOW", "DOMAIN_IN_OWN_ACCOUNT", "DOMAIN_IN_ANOTHER_ACCOUNT", "PREMIUM_DOMAIN" # resp.message #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/CheckDomainTransferability AWS API Documentation # # @overload check_domain_transferability(params = {}) # @param [Hash] params ({}) def check_domain_transferability(params = {}, options = {}) req = build_request(:check_domain_transferability, params) req.send_request(options) end # This operation deletes the specified domain. This action is permanent. # For more information, see [Deleting a domain name registration][1]. # # To transfer the domain registration to another registrar, use the # transfer process that’s provided by the registrar to which you want to # transfer the registration. Otherwise, the following apply: # # 1. You can’t get a refund for the cost of a deleted domain # registration. # # 2. The registry for the top-level domain might hold the domain name # for a brief time before releasing it for other users to register # (varies by registry). # # 3. When the registration has been deleted, we'll send you a # confirmation to the registrant contact. The email will come from # `noreply@domainnameverification.net` or # `noreply@registrar.amazon.com`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-delete.html # # @option params [required, String] :domain_name # Name of the domain to be deleted. # # @return [Types::DeleteDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DeleteDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.delete_domain({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/DeleteDomain AWS API Documentation # # @overload delete_domain(params = {}) # @param [Hash] params ({}) def delete_domain(params = {}, options = {}) req = build_request(:delete_domain, params) req.send_request(options) end # This operation deletes the specified tags for a domain. # # All tag operations are eventually consistent; subsequent operations # might not immediately represent all issued operations. # # @option params [required, String] :domain_name # The domain for which you want to delete one or more tags. # # @option params [required, Array] :tags_to_delete # A list of tag keys to delete. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.delete_tags_for_domain({ # domain_name: "DomainName", # required # tags_to_delete: ["TagKey"], # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/DeleteTagsForDomain AWS API Documentation # # @overload delete_tags_for_domain(params = {}) # @param [Hash] params ({}) def delete_tags_for_domain(params = {}, options = {}) req = build_request(:delete_tags_for_domain, params) req.send_request(options) end # This operation disables automatic renewal of domain registration for # the specified domain. # # @option params [required, String] :domain_name # The name of the domain that you want to disable automatic renewal for. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.disable_domain_auto_renew({ # domain_name: "DomainName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/DisableDomainAutoRenew AWS API Documentation # # @overload disable_domain_auto_renew(params = {}) # @param [Hash] params ({}) def disable_domain_auto_renew(params = {}, options = {}) req = build_request(:disable_domain_auto_renew, params) req.send_request(options) end # This operation removes the transfer lock on the domain (specifically # the `clientTransferProhibited` status) to allow domain transfers. We # recommend you refrain from performing this action unless you intend to # transfer the domain to a different registrar. Successful submission # returns an operation ID that you can use to track the progress and # completion of the action. If the request is not completed # successfully, the domain registrant will be notified by email. # # @option params [required, String] :domain_name # The name of the domain that you want to remove the transfer lock for. # # @return [Types::DisableDomainTransferLockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DisableDomainTransferLockResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.disable_domain_transfer_lock({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/DisableDomainTransferLock AWS API Documentation # # @overload disable_domain_transfer_lock(params = {}) # @param [Hash] params ({}) def disable_domain_transfer_lock(params = {}, options = {}) req = build_request(:disable_domain_transfer_lock, params) req.send_request(options) end # Deletes a delegation signer (DS) record in the registry zone for this # domain name. # # @option params [required, String] :domain_name # Name of the domain. # # @option params [required, String] :id # An internal identification number assigned to each DS record after # it’s created. You can retrieve it as part of DNSSEC information # returned by [GetDomainDetail][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetDomainDetail.html # # @return [Types::DisassociateDelegationSignerFromDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DisassociateDelegationSignerFromDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.disassociate_delegation_signer_from_domain({ # domain_name: "DomainName", # required # id: "String", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/DisassociateDelegationSignerFromDomain AWS API Documentation # # @overload disassociate_delegation_signer_from_domain(params = {}) # @param [Hash] params ({}) def disassociate_delegation_signer_from_domain(params = {}, options = {}) req = build_request(:disassociate_delegation_signer_from_domain, params) req.send_request(options) end # This operation configures Amazon Route 53 to automatically renew the # specified domain before the domain registration expires. The cost of # renewing your domain registration is billed to your Amazon Web # Services account. # # The period during which you can renew a domain name varies by TLD. For # a list of TLDs and their renewal policies, see [Domains That You Can # Register with Amazon Route 53][1] in the *Amazon Route 53 Developer # Guide*. Route 53 requires that you renew before the end of the renewal # period so we can complete processing before the deadline. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [required, String] :domain_name # The name of the domain that you want to enable automatic renewal for. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.enable_domain_auto_renew({ # domain_name: "DomainName", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/EnableDomainAutoRenew AWS API Documentation # # @overload enable_domain_auto_renew(params = {}) # @param [Hash] params ({}) def enable_domain_auto_renew(params = {}, options = {}) req = build_request(:enable_domain_auto_renew, params) req.send_request(options) end # This operation sets the transfer lock on the domain (specifically the # `clientTransferProhibited` status) to prevent domain transfers. # Successful submission returns an operation ID that you can use to # track the progress and completion of the action. If the request is not # completed successfully, the domain registrant will be notified by # email. # # @option params [required, String] :domain_name # The name of the domain that you want to set the transfer lock for. # # @return [Types::EnableDomainTransferLockResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::EnableDomainTransferLockResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.enable_domain_transfer_lock({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/EnableDomainTransferLock AWS API Documentation # # @overload enable_domain_transfer_lock(params = {}) # @param [Hash] params ({}) def enable_domain_transfer_lock(params = {}, options = {}) req = build_request(:enable_domain_transfer_lock, params) req.send_request(options) end # For operations that require confirmation that the email address for # the registrant contact is valid, such as registering a new domain, # this operation returns information about whether the registrant # contact has responded. # # If you want us to resend the email, use the # `ResendContactReachabilityEmail` operation. # # @option params [String] :domain_name # The name of the domain for which you want to know whether the # registrant contact has confirmed that the email address is valid. # # @return [Types::GetContactReachabilityStatusResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetContactReachabilityStatusResponse#domain_name #domain_name} => String # * {Types::GetContactReachabilityStatusResponse#status #status} => String # # @example Request syntax with placeholder values # # resp = client.get_contact_reachability_status({ # domain_name: "DomainName", # }) # # @example Response structure # # resp.domain_name #=> String # resp.status #=> String, one of "PENDING", "DONE", "EXPIRED" # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/GetContactReachabilityStatus AWS API Documentation # # @overload get_contact_reachability_status(params = {}) # @param [Hash] params ({}) def get_contact_reachability_status(params = {}, options = {}) req = build_request(:get_contact_reachability_status, params) req.send_request(options) end # This operation returns detailed information about a specified domain # that is associated with the current Amazon Web Services account. # Contact information for the domain is also returned as part of the # output. # # @option params [required, String] :domain_name # The name of the domain that you want to get detailed information # about. # # @return [Types::GetDomainDetailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDomainDetailResponse#domain_name #domain_name} => String # * {Types::GetDomainDetailResponse#nameservers #nameservers} => Array<Types::Nameserver> # * {Types::GetDomainDetailResponse#auto_renew #auto_renew} => Boolean # * {Types::GetDomainDetailResponse#admin_contact #admin_contact} => Types::ContactDetail # * {Types::GetDomainDetailResponse#registrant_contact #registrant_contact} => Types::ContactDetail # * {Types::GetDomainDetailResponse#tech_contact #tech_contact} => Types::ContactDetail # * {Types::GetDomainDetailResponse#admin_privacy #admin_privacy} => Boolean # * {Types::GetDomainDetailResponse#registrant_privacy #registrant_privacy} => Boolean # * {Types::GetDomainDetailResponse#tech_privacy #tech_privacy} => Boolean # * {Types::GetDomainDetailResponse#registrar_name #registrar_name} => String # * {Types::GetDomainDetailResponse#who_is_server #who_is_server} => String # * {Types::GetDomainDetailResponse#registrar_url #registrar_url} => String # * {Types::GetDomainDetailResponse#abuse_contact_email #abuse_contact_email} => String # * {Types::GetDomainDetailResponse#abuse_contact_phone #abuse_contact_phone} => String # * {Types::GetDomainDetailResponse#registry_domain_id #registry_domain_id} => String # * {Types::GetDomainDetailResponse#creation_date #creation_date} => Time # * {Types::GetDomainDetailResponse#updated_date #updated_date} => Time # * {Types::GetDomainDetailResponse#expiration_date #expiration_date} => Time # * {Types::GetDomainDetailResponse#reseller #reseller} => String # * {Types::GetDomainDetailResponse#dns_sec #dns_sec} => String # * {Types::GetDomainDetailResponse#status_list #status_list} => Array<String> # * {Types::GetDomainDetailResponse#dnssec_keys #dnssec_keys} => Array<Types::DnssecKey> # * {Types::GetDomainDetailResponse#billing_contact #billing_contact} => Types::ContactDetail # * {Types::GetDomainDetailResponse#billing_privacy #billing_privacy} => Boolean # # @example Request syntax with placeholder values # # resp = client.get_domain_detail({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.domain_name #=> String # resp.nameservers #=> Array # resp.nameservers[0].name #=> String # resp.nameservers[0].glue_ips #=> Array # resp.nameservers[0].glue_ips[0] #=> String # resp.auto_renew #=> Boolean # resp.admin_contact.first_name #=> String # resp.admin_contact.last_name #=> String # resp.admin_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" # resp.admin_contact.organization_name #=> String # resp.admin_contact.address_line_1 #=> String # resp.admin_contact.address_line_2 #=> String # resp.admin_contact.city #=> String # resp.admin_contact.state #=> String # resp.admin_contact.country_code #=> String, one of "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "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", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" # resp.admin_contact.zip_code #=> String # resp.admin_contact.phone_number #=> String # resp.admin_contact.email #=> String # resp.admin_contact.fax #=> String # resp.admin_contact.extra_params #=> Array # 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", "CA_LEGAL_REPRESENTATIVE", "CA_LEGAL_REPRESENTATIVE_CAPACITY", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "FI_NATIONALITY", "FI_ORGANIZATION_TYPE", "IT_NATIONALITY", "IT_PIN", "IT_REGISTRANT_ENTITY_TYPE", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER", "UK_CONTACT_TYPE", "UK_COMPANY_NUMBER", "EU_COUNTRY_OF_CITIZENSHIP", "AU_PRIORITY_TOKEN" # resp.admin_contact.extra_params[0].value #=> String # resp.registrant_contact.first_name #=> String # resp.registrant_contact.last_name #=> String # resp.registrant_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" # resp.registrant_contact.organization_name #=> String # resp.registrant_contact.address_line_1 #=> String # resp.registrant_contact.address_line_2 #=> String # resp.registrant_contact.city #=> String # resp.registrant_contact.state #=> String # resp.registrant_contact.country_code #=> String, one of "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "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", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" # resp.registrant_contact.zip_code #=> String # resp.registrant_contact.phone_number #=> String # resp.registrant_contact.email #=> String # resp.registrant_contact.fax #=> String # resp.registrant_contact.extra_params #=> Array # 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", "CA_LEGAL_REPRESENTATIVE", "CA_LEGAL_REPRESENTATIVE_CAPACITY", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "FI_NATIONALITY", "FI_ORGANIZATION_TYPE", "IT_NATIONALITY", "IT_PIN", "IT_REGISTRANT_ENTITY_TYPE", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER", "UK_CONTACT_TYPE", "UK_COMPANY_NUMBER", "EU_COUNTRY_OF_CITIZENSHIP", "AU_PRIORITY_TOKEN" # resp.registrant_contact.extra_params[0].value #=> String # resp.tech_contact.first_name #=> String # resp.tech_contact.last_name #=> String # resp.tech_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" # resp.tech_contact.organization_name #=> String # resp.tech_contact.address_line_1 #=> String # resp.tech_contact.address_line_2 #=> String # resp.tech_contact.city #=> String # resp.tech_contact.state #=> String # resp.tech_contact.country_code #=> String, one of "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "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", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" # resp.tech_contact.zip_code #=> String # resp.tech_contact.phone_number #=> String # resp.tech_contact.email #=> String # resp.tech_contact.fax #=> String # resp.tech_contact.extra_params #=> Array # 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", "CA_LEGAL_REPRESENTATIVE", "CA_LEGAL_REPRESENTATIVE_CAPACITY", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "FI_NATIONALITY", "FI_ORGANIZATION_TYPE", "IT_NATIONALITY", "IT_PIN", "IT_REGISTRANT_ENTITY_TYPE", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER", "UK_CONTACT_TYPE", "UK_COMPANY_NUMBER", "EU_COUNTRY_OF_CITIZENSHIP", "AU_PRIORITY_TOKEN" # resp.tech_contact.extra_params[0].value #=> String # resp.admin_privacy #=> Boolean # resp.registrant_privacy #=> Boolean # resp.tech_privacy #=> Boolean # resp.registrar_name #=> String # resp.who_is_server #=> String # resp.registrar_url #=> String # resp.abuse_contact_email #=> String # resp.abuse_contact_phone #=> String # resp.registry_domain_id #=> String # resp.creation_date #=> Time # resp.updated_date #=> Time # resp.expiration_date #=> Time # resp.reseller #=> String # resp.dns_sec #=> String # resp.status_list #=> Array # resp.status_list[0] #=> String # resp.dnssec_keys #=> Array # resp.dnssec_keys[0].algorithm #=> Integer # resp.dnssec_keys[0].flags #=> Integer # resp.dnssec_keys[0].public_key #=> String # resp.dnssec_keys[0].digest_type #=> Integer # resp.dnssec_keys[0].digest #=> String # resp.dnssec_keys[0].key_tag #=> Integer # resp.dnssec_keys[0].id #=> String # resp.billing_contact.first_name #=> String # resp.billing_contact.last_name #=> String # resp.billing_contact.contact_type #=> String, one of "PERSON", "COMPANY", "ASSOCIATION", "PUBLIC_BODY", "RESELLER" # resp.billing_contact.organization_name #=> String # resp.billing_contact.address_line_1 #=> String # resp.billing_contact.address_line_2 #=> String # resp.billing_contact.city #=> String # resp.billing_contact.state #=> String # resp.billing_contact.country_code #=> String, one of "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AN", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "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", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" # resp.billing_contact.zip_code #=> String # resp.billing_contact.phone_number #=> String # resp.billing_contact.email #=> String # resp.billing_contact.fax #=> String # resp.billing_contact.extra_params #=> Array # resp.billing_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", "CA_LEGAL_REPRESENTATIVE", "CA_LEGAL_REPRESENTATIVE_CAPACITY", "ES_IDENTIFICATION", "ES_IDENTIFICATION_TYPE", "ES_LEGAL_FORM", "FI_BUSINESS_NUMBER", "FI_ID_NUMBER", "FI_NATIONALITY", "FI_ORGANIZATION_TYPE", "IT_NATIONALITY", "IT_PIN", "IT_REGISTRANT_ENTITY_TYPE", "RU_PASSPORT_DATA", "SE_ID_NUMBER", "SG_ID_NUMBER", "VAT_NUMBER", "UK_CONTACT_TYPE", "UK_COMPANY_NUMBER", "EU_COUNTRY_OF_CITIZENSHIP", "AU_PRIORITY_TOKEN" # resp.billing_contact.extra_params[0].value #=> String # resp.billing_privacy #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/GetDomainDetail AWS API Documentation # # @overload get_domain_detail(params = {}) # @param [Hash] params ({}) def get_domain_detail(params = {}, options = {}) req = build_request(:get_domain_detail, params) req.send_request(options) end # The GetDomainSuggestions operation returns a list of suggested domain # names. # # @option params [required, String] :domain_name # A domain name that you want to use as the basis for a list of possible # domain names. The top-level domain (TLD), such as .com, must be a TLD # that Route 53 supports. For a list of supported TLDs, see [Domains # that You Can Register with Amazon Route 53][1] in the *Amazon Route 53 # Developer Guide*. # # The domain name can contain only the following characters: # # * Letters a through z. Domain names are not case sensitive. # # * Numbers 0 through 9. # # * Hyphen (-). You can't specify a hyphen at the beginning or end of a # label. # # * Period (.) to separate the labels in the name, such as the `.` in # `example.com`. # # Internationalized domain names are not supported for some top-level # domains. To determine whether the TLD that you want to use supports # internationalized domain names, see [Domains that You Can Register # with Amazon Route 53][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [required, Integer] :suggestion_count # The number of suggested domain names that you want Route 53 to return. # Specify a value between 1 and 50. # # @option params [required, Boolean] :only_available # If `OnlyAvailable` is `true`, Route 53 returns only domain names that # are available. If `OnlyAvailable` is `false`, Route 53 returns domain # names without checking whether they're available to be registered. To # determine whether the domain is available, you can call # `checkDomainAvailability` for each suggestion. # # @return [Types::GetDomainSuggestionsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetDomainSuggestionsResponse#suggestions_list #suggestions_list} => Array<Types::DomainSuggestion> # # @example Request syntax with placeholder values # # resp = client.get_domain_suggestions({ # domain_name: "DomainName", # required # suggestion_count: 1, # required # only_available: false, # required # }) # # @example Response structure # # resp.suggestions_list #=> Array # resp.suggestions_list[0].domain_name #=> String # resp.suggestions_list[0].availability #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/GetDomainSuggestions AWS API Documentation # # @overload get_domain_suggestions(params = {}) # @param [Hash] params ({}) def get_domain_suggestions(params = {}, options = {}) req = build_request(:get_domain_suggestions, params) req.send_request(options) end # This operation returns the current status of an operation that is not # completed. # # @option params [required, String] :operation_id # The identifier for the operation for which you want to get the status. # Route 53 returned the identifier in the response to the original # request. # # @return [Types::GetOperationDetailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GetOperationDetailResponse#operation_id #operation_id} => String # * {Types::GetOperationDetailResponse#status #status} => String # * {Types::GetOperationDetailResponse#message #message} => String # * {Types::GetOperationDetailResponse#domain_name #domain_name} => String # * {Types::GetOperationDetailResponse#type #type} => String # * {Types::GetOperationDetailResponse#submitted_date #submitted_date} => Time # * {Types::GetOperationDetailResponse#last_updated_date #last_updated_date} => Time # * {Types::GetOperationDetailResponse#status_flag #status_flag} => String # # @example Request syntax with placeholder values # # resp = client.get_operation_detail({ # operation_id: "OperationId", # required # }) # # @example Response structure # # resp.operation_id #=> String # resp.status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED" # resp.message #=> String # resp.domain_name #=> String # resp.type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK", "ENABLE_AUTORENEW", "DISABLE_AUTORENEW", "ADD_DNSSEC", "REMOVE_DNSSEC", "EXPIRE_DOMAIN", "TRANSFER_OUT_DOMAIN", "CHANGE_DOMAIN_OWNER", "RENEW_DOMAIN", "PUSH_DOMAIN", "INTERNAL_TRANSFER_OUT_DOMAIN", "INTERNAL_TRANSFER_IN_DOMAIN", "RELEASE_TO_GANDI", "TRANSFER_ON_RENEW" # resp.submitted_date #=> Time # resp.last_updated_date #=> Time # resp.status_flag #=> String, one of "PENDING_ACCEPTANCE", "PENDING_CUSTOMER_ACTION", "PENDING_AUTHORIZATION", "PENDING_PAYMENT_VERIFICATION", "PENDING_SUPPORT_CASE" # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/GetOperationDetail AWS API Documentation # # @overload get_operation_detail(params = {}) # @param [Hash] params ({}) def get_operation_detail(params = {}, options = {}) req = build_request(:get_operation_detail, params) req.send_request(options) end # This operation returns all the domain names registered with Amazon # Route 53 for the current Amazon Web Services account if no filtering # conditions are used. # # @option params [Array] :filter_conditions # A complex type that contains information about the filters applied # during the `ListDomains` request. The filter conditions can include # domain name and domain expiration. # # @option params [Types::SortCondition] :sort_condition # A complex type that contains information about the requested ordering # of domains in the returned list. # # @option params [String] :marker # For an initial request for a list of domains, omit this element. If # the number of domains that are associated with the current Amazon Web # Services account is greater than the value that you specified for # `MaxItems`, you can use `Marker` to return additional domains. Get the # value of `NextPageMarker` from the previous response, and submit # another request that includes the value of `NextPageMarker` in the # `Marker` element. # # Constraints: The marker must match the value specified in the previous # request. # # @option params [Integer] :max_items # Number of domains to be returned. # # Default: 20 # # @return [Types::ListDomainsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListDomainsResponse#domains #domains} => Array<Types::DomainSummary> # * {Types::ListDomainsResponse#next_page_marker #next_page_marker} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_domains({ # filter_conditions: [ # { # name: "DomainName", # required, accepts DomainName, Expiry # operator: "LE", # required, accepts LE, GE, BEGINS_WITH # values: ["Value"], # required # }, # ], # sort_condition: { # name: "DomainName", # required, accepts DomainName, Expiry # sort_order: "ASC", # required, accepts ASC, DESC # }, # marker: "PageMarker", # max_items: 1, # }) # # @example Response structure # # resp.domains #=> Array # resp.domains[0].domain_name #=> String # resp.domains[0].auto_renew #=> Boolean # resp.domains[0].transfer_lock #=> Boolean # resp.domains[0].expiry #=> Time # resp.next_page_marker #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ListDomains AWS API Documentation # # @overload list_domains(params = {}) # @param [Hash] params ({}) def list_domains(params = {}, options = {}) req = build_request(:list_domains, params) req.send_request(options) end # Returns information about all of the operations that return an # operation ID and that have ever been performed on domains that were # registered by the current account. # # This command runs only in the us-east-1 Region. # # @option params [Time,DateTime,Date,Integer,String] :submitted_since # An optional parameter that lets you get information about all the # operations that you submitted after a specified date and time. Specify # the date and time in Unix time format and Coordinated Universal time # (UTC). # # @option params [String] :marker # For an initial request for a list of operations, omit this element. If # the number of operations that are not yet complete is greater than the # value that you specified for `MaxItems`, you can use `Marker` to # return additional operations. Get the value of `NextPageMarker` from # the previous response, and submit another request that includes the # value of `NextPageMarker` in the `Marker` element. # # @option params [Integer] :max_items # Number of domains to be returned. # # Default: 20 # # @option params [Array] :status # The status of the operations. # # @option params [Array] :type # An arrays of the domains operation types. # # @option params [String] :sort_by # The sort type for returned values. # # @option params [String] :sort_order # The sort order for returned values, either ascending or descending. # # @return [Types::ListOperationsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListOperationsResponse#operations #operations} => Array<Types::OperationSummary> # * {Types::ListOperationsResponse#next_page_marker #next_page_marker} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_operations({ # submitted_since: Time.now, # marker: "PageMarker", # max_items: 1, # status: ["SUBMITTED"], # accepts SUBMITTED, IN_PROGRESS, ERROR, SUCCESSFUL, FAILED # type: ["REGISTER_DOMAIN"], # accepts REGISTER_DOMAIN, DELETE_DOMAIN, TRANSFER_IN_DOMAIN, UPDATE_DOMAIN_CONTACT, UPDATE_NAMESERVER, CHANGE_PRIVACY_PROTECTION, DOMAIN_LOCK, ENABLE_AUTORENEW, DISABLE_AUTORENEW, ADD_DNSSEC, REMOVE_DNSSEC, EXPIRE_DOMAIN, TRANSFER_OUT_DOMAIN, CHANGE_DOMAIN_OWNER, RENEW_DOMAIN, PUSH_DOMAIN, INTERNAL_TRANSFER_OUT_DOMAIN, INTERNAL_TRANSFER_IN_DOMAIN, RELEASE_TO_GANDI, TRANSFER_ON_RENEW # sort_by: "SubmittedDate", # accepts SubmittedDate # sort_order: "ASC", # accepts ASC, DESC # }) # # @example Response structure # # resp.operations #=> Array # resp.operations[0].operation_id #=> String # resp.operations[0].status #=> String, one of "SUBMITTED", "IN_PROGRESS", "ERROR", "SUCCESSFUL", "FAILED" # resp.operations[0].type #=> String, one of "REGISTER_DOMAIN", "DELETE_DOMAIN", "TRANSFER_IN_DOMAIN", "UPDATE_DOMAIN_CONTACT", "UPDATE_NAMESERVER", "CHANGE_PRIVACY_PROTECTION", "DOMAIN_LOCK", "ENABLE_AUTORENEW", "DISABLE_AUTORENEW", "ADD_DNSSEC", "REMOVE_DNSSEC", "EXPIRE_DOMAIN", "TRANSFER_OUT_DOMAIN", "CHANGE_DOMAIN_OWNER", "RENEW_DOMAIN", "PUSH_DOMAIN", "INTERNAL_TRANSFER_OUT_DOMAIN", "INTERNAL_TRANSFER_IN_DOMAIN", "RELEASE_TO_GANDI", "TRANSFER_ON_RENEW" # resp.operations[0].submitted_date #=> Time # resp.operations[0].domain_name #=> String # resp.operations[0].message #=> String # resp.operations[0].status_flag #=> String, one of "PENDING_ACCEPTANCE", "PENDING_CUSTOMER_ACTION", "PENDING_AUTHORIZATION", "PENDING_PAYMENT_VERIFICATION", "PENDING_SUPPORT_CASE" # resp.operations[0].last_updated_date #=> Time # resp.next_page_marker #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ListOperations AWS API Documentation # # @overload list_operations(params = {}) # @param [Hash] params ({}) def list_operations(params = {}, options = {}) req = build_request(:list_operations, params) req.send_request(options) end # Lists the following prices for either all the TLDs supported by # Route 53, or the specified TLD: # # * Registration # # * Transfer # # * Owner change # # * Domain renewal # # * Domain restoration # # @option params [String] :tld # The TLD for which you want to receive the pricing information. For # example. `.net`. # # If a `Tld` value is not provided, a list of prices for all TLDs # supported by Route 53 is returned. # # @option params [String] :marker # For an initial request for a list of prices, omit this element. If the # number of prices that are not yet complete is greater than the value # that you specified for `MaxItems`, you can use `Marker` to return # additional prices. Get the value of `NextPageMarker` from the previous # response, and submit another request that includes the value of # `NextPageMarker` in the `Marker` element. # # Used only for all TLDs. If you specify a TLD, don't specify a # `Marker`. # # @option params [Integer] :max_items # Number of `Prices` to be returned. # # Used only for all TLDs. If you specify a TLD, don't specify a # `MaxItems`. # # @return [Types::ListPricesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListPricesResponse#prices #prices} => Array<Types::DomainPrice> # * {Types::ListPricesResponse#next_page_marker #next_page_marker} => String # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.list_prices({ # tld: "TldName", # marker: "PageMarker", # max_items: 1, # }) # # @example Response structure # # resp.prices #=> Array # resp.prices[0].name #=> String # resp.prices[0].registration_price.price #=> Float # resp.prices[0].registration_price.currency #=> String # resp.prices[0].transfer_price.price #=> Float # resp.prices[0].transfer_price.currency #=> String # resp.prices[0].renewal_price.price #=> Float # resp.prices[0].renewal_price.currency #=> String # resp.prices[0].change_ownership_price.price #=> Float # resp.prices[0].change_ownership_price.currency #=> String # resp.prices[0].restoration_price.price #=> Float # resp.prices[0].restoration_price.currency #=> String # resp.next_page_marker #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ListPrices AWS API Documentation # # @overload list_prices(params = {}) # @param [Hash] params ({}) def list_prices(params = {}, options = {}) req = build_request(:list_prices, params) req.send_request(options) end # This operation returns all of the tags that are associated with the # specified domain. # # All tag operations are eventually consistent; subsequent operations # might not immediately represent all issued operations. # # @option params [required, String] :domain_name # The domain for which you want to get a list of tags. # # @return [Types::ListTagsForDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ListTagsForDomainResponse#tag_list #tag_list} => Array<Types::Tag> # # @example Request syntax with placeholder values # # resp = client.list_tags_for_domain({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.tag_list #=> Array # resp.tag_list[0].key #=> String # resp.tag_list[0].value #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ListTagsForDomain AWS API Documentation # # @overload list_tags_for_domain(params = {}) # @param [Hash] params ({}) def list_tags_for_domain(params = {}, options = {}) req = build_request(:list_tags_for_domain, params) req.send_request(options) end # Moves a domain from Amazon Web Services to another registrar. # # Supported actions: # # * Changes the IPS tags of a .uk domain, and pushes it to transit. # Transit means that the domain is ready to be transferred to another # registrar. # # ^ # # @option params [required, String] :domain_name # Name of the domain. # # @option params [required, String] :target # New IPS tag for the domain. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.push_domain({ # domain_name: "DomainName", # required # target: "Label", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/PushDomain AWS API Documentation # # @overload push_domain(params = {}) # @param [Hash] params ({}) def push_domain(params = {}, options = {}) req = build_request(:push_domain, params) req.send_request(options) end # This operation registers a domain. For some top-level domains (TLDs), # this operation requires extra parameters. # # When you register a domain, Amazon Route 53 does the following: # # * Creates a Route 53 hosted zone that has the same name as the domain. # Route 53 assigns four name servers to your hosted zone and # automatically updates your domain registration with the names of # these name servers. # # * Enables auto renew, so your domain registration will renew # automatically each year. We'll notify you in advance of the renewal # date so you can choose whether to renew the registration. # # * Optionally enables privacy protection, so WHOIS queries return # contact for the registrar or the phrase "REDACTED FOR PRIVACY", or # "On behalf of <domain name> owner." If you don't enable # privacy protection, WHOIS queries return the information that you # entered for the administrative, registrant, and technical contacts. # # While some domains may allow different privacy settings per contact, # we recommend specifying the same privacy setting for all contacts. # # # # * If registration is successful, returns an operation ID that you can # use to track the progress and completion of the action. If the # request is not completed successfully, the domain registrant is # notified by email. # # * Charges your Amazon Web Services account an amount based on the # top-level domain. For more information, see [Amazon Route 53 # Pricing][1]. # # # # [1]: http://aws.amazon.com/route53/pricing/ # # @option params [required, String] :domain_name # The domain name that you want to register. The top-level domain (TLD), # such as .com, must be a TLD that Route 53 supports. For a list of # supported TLDs, see [Domains that You Can Register with Amazon Route # 53][1] in the *Amazon Route 53 Developer Guide*. # # The domain name can contain only the following characters: # # * Letters a through z. Domain names are not case sensitive. # # * Numbers 0 through 9. # # * Hyphen (-). You can't specify a hyphen at the beginning or end of a # label. # # * Period (.) to separate the labels in the name, such as the `.` in # `example.com`. # # Internationalized domain names are not supported for some top-level # domains. To determine whether the TLD that you want to use supports # internationalized domain names, see [Domains that You Can Register # with Amazon Route 53][1]. For more information, see [Formatting # Internationalized Domain Names][2]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # [2]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/DomainNameFormat.html#domain-name-format-idns # # @option params [String] :idn_lang_code # Reserved for future use. # # @option params [required, Integer] :duration_in_years # The number of years that you want to register the domain for. Domains # are registered for a minimum of one year. The maximum period depends # on the top-level domain. For the range of valid values for your # domain, see [Domains that You Can Register with Amazon Route 53][1] in # the *Amazon Route 53 Developer Guide*. # # Default: 1 # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [Boolean] :auto_renew # Indicates whether the domain will be automatically renewed (`true`) or # not (`false`). Auto renewal only takes effect after the account is # charged. # # Default: `true` # # @option params [required, Types::ContactDetail] :admin_contact # Provides detailed contact information. For information about the # values that you specify for each element, see [ContactDetail][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html # # @option params [required, Types::ContactDetail] :registrant_contact # Provides detailed contact information. For information about the # values that you specify for each element, see [ContactDetail][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html # # @option params [required, Types::ContactDetail] :tech_contact # Provides detailed contact information. For information about the # values that you specify for each element, see [ContactDetail][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html # # @option params [Boolean] :privacy_protect_admin_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the admin contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # Default: `true` # # @option params [Boolean] :privacy_protect_registrant_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the registrant contact (the domain # owner). # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # Default: `true` # # @option params [Boolean] :privacy_protect_tech_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the technical contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # Default: `true` # # @option params [Types::ContactDetail] :billing_contact # Provides detailed contact information. For information about the # values that you specify for each element, see [ContactDetail][1]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ContactDetail.html # # @option params [Boolean] :privacy_protect_billing_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the billing contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @return [Types::RegisterDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RegisterDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.register_domain({ # domain_name: "DomainName", # required # idn_lang_code: "LangCode", # duration_in_years: 1, # required # auto_renew: false, # admin_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # registrant_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # tech_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # privacy_protect_admin_contact: false, # privacy_protect_registrant_contact: false, # privacy_protect_tech_contact: false, # billing_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # privacy_protect_billing_contact: false, # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/RegisterDomain AWS API Documentation # # @overload register_domain(params = {}) # @param [Hash] params ({}) def register_domain(params = {}, options = {}) req = build_request(:register_domain, params) req.send_request(options) end # Rejects the transfer of a domain from another Amazon Web Services # account to the current Amazon Web Services account. You initiate a # transfer betweenAmazon Web Services accounts using # [TransferDomainToAnotherAwsAccount][1]. # # Use either [ListOperations][2] or [GetOperationDetail][3] to determine # whether the operation succeeded. [GetOperationDetail][3] provides # additional information, for example, `Domain Transfer from Aws Account # 111122223333 has been cancelled`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html # [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html # # @option params [required, String] :domain_name # The name of the domain that was specified when another Amazon Web # Services account submitted a [TransferDomainToAnotherAwsAccount][1] # request. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # # @return [Types::RejectDomainTransferFromAnotherAwsAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RejectDomainTransferFromAnotherAwsAccountResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.reject_domain_transfer_from_another_aws_account({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/RejectDomainTransferFromAnotherAwsAccount AWS API Documentation # # @overload reject_domain_transfer_from_another_aws_account(params = {}) # @param [Hash] params ({}) def reject_domain_transfer_from_another_aws_account(params = {}, options = {}) req = build_request(:reject_domain_transfer_from_another_aws_account, params) req.send_request(options) end # This operation renews a domain for the specified number of years. The # cost of renewing your domain is billed to your Amazon Web Services # account. # # We recommend that you renew your domain several weeks before the # expiration date. Some TLD registries delete domains before the # expiration date if you haven't renewed far enough in advance. For # more information about renewing domain registration, see [Renewing # Registration for a Domain][1] in the *Amazon Route 53 Developer # Guide*. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-renew.html # # @option params [required, String] :domain_name # The name of the domain that you want to renew. # # @option params [Integer] :duration_in_years # The number of years that you want to renew the domain for. The maximum # number of years depends on the top-level domain. For the range of # valid values for your domain, see [Domains that You Can Register with # Amazon Route 53][1] in the *Amazon Route 53 Developer Guide*. # # Default: 1 # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [required, Integer] :current_expiry_year # The year when the registration for the domain is set to expire. This # value must match the current expiration date for the domain. # # @return [Types::RenewDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RenewDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.renew_domain({ # domain_name: "DomainName", # required # duration_in_years: 1, # current_expiry_year: 1, # required # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/RenewDomain AWS API Documentation # # @overload renew_domain(params = {}) # @param [Hash] params ({}) def renew_domain(params = {}, options = {}) req = build_request(:renew_domain, params) req.send_request(options) end # For operations that require confirmation that the email address for # the registrant contact is valid, such as registering a new domain, # this operation resends the confirmation email to the current email # address for the registrant contact. # # @option params [String] :domain_name # The name of the domain for which you want Route 53 to resend a # confirmation email to the registrant contact. # # @return [Types::ResendContactReachabilityEmailResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ResendContactReachabilityEmailResponse#domain_name #domain_name} => String # * {Types::ResendContactReachabilityEmailResponse#email_address #email_address} => String # * {Types::ResendContactReachabilityEmailResponse#is_already_verified #is_already_verified} => Boolean # # @example Request syntax with placeholder values # # resp = client.resend_contact_reachability_email({ # domain_name: "DomainName", # }) # # @example Response structure # # resp.domain_name #=> String # resp.email_address #=> String # resp.is_already_verified #=> Boolean # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ResendContactReachabilityEmail AWS API Documentation # # @overload resend_contact_reachability_email(params = {}) # @param [Hash] params ({}) def resend_contact_reachability_email(params = {}, options = {}) req = build_request(:resend_contact_reachability_email, params) req.send_request(options) end # Resend the form of authorization email for this operation. # # @option params [required, String] :operation_id # Operation ID. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.resend_operation_authorization({ # operation_id: "OperationId", # required # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ResendOperationAuthorization AWS API Documentation # # @overload resend_operation_authorization(params = {}) # @param [Hash] params ({}) def resend_operation_authorization(params = {}, options = {}) req = build_request(:resend_operation_authorization, params) req.send_request(options) end # This operation returns the authorization code for the domain. To # transfer a domain to another registrar, you provide this value to the # new registrar. # # @option params [required, String] :domain_name # The name of the domain that you want to get an authorization code for. # # @return [Types::RetrieveDomainAuthCodeResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RetrieveDomainAuthCodeResponse#auth_code #auth_code} => String # # @example Request syntax with placeholder values # # resp = client.retrieve_domain_auth_code({ # domain_name: "DomainName", # required # }) # # @example Response structure # # resp.auth_code #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/RetrieveDomainAuthCode AWS API Documentation # # @overload retrieve_domain_auth_code(params = {}) # @param [Hash] params ({}) def retrieve_domain_auth_code(params = {}, options = {}) req = build_request(:retrieve_domain_auth_code, params) req.send_request(options) end # Transfers a domain from another registrar to Amazon Route 53. # # For more information about transferring domains, see the following # topics: # # * For transfer requirements, a detailed procedure, and information # about viewing the status of a domain that you're transferring to # Route 53, see [Transferring Registration for a Domain to Amazon # Route 53][1] in the *Amazon Route 53 Developer Guide*. # # * For information about how to transfer a domain from one Amazon Web # Services account to another, see # [TransferDomainToAnotherAwsAccount][2]. # # * For information about how to transfer a domain to another domain # registrar, see [Transferring a Domain from Amazon Route 53 to # Another Registrar][3] in the *Amazon Route 53 Developer Guide*. # # During the transfer of any country code top-level domains (ccTLDs) to # Route 53, except for .cc and .tv, updates to the owner contact are # ignored and the owner contact data from the registry is used. You can # update the owner contact after the transfer is complete. For more # information, see [UpdateDomainContact][4]. # # If the registrar for your domain is also the DNS service provider for # the domain, we highly recommend that you transfer your DNS service to # Route 53 or to another DNS service provider before you transfer your # registration. Some registrars provide free DNS service when you # purchase a domain registration. When you transfer the registration, # the previous registrar will not renew your domain registration and # could end your DNS service at any time. # # 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. # # If the transfer is successful, this method returns an operation ID # that you can use to track the progress and completion of the action. # If the transfer doesn't complete successfully, the domain registrant # will be notified by email. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-to-route-53.html # [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_TransferDomainToAnotherAwsAccount.html # [3]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-transfer-from-route-53.html # [4]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_UpdateDomainContact.html # # @option params [required, String] :domain_name # The name of the domain that you want to transfer to Route 53. The # top-level domain (TLD), such as .com, must be a TLD that Route 53 # supports. For a list of supported TLDs, see [Domains that You Can # Register with Amazon Route 53][1] in the *Amazon Route 53 Developer # Guide*. # # The domain name can contain only the following characters: # # * Letters a through z. Domain names are not case sensitive. # # * Numbers 0 through 9. # # * Hyphen (-). You can't specify a hyphen at the beginning or end of a # label. # # * Period (.) to separate the labels in the name, such as the `.` in # `example.com`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/registrar-tld-list.html # # @option params [String] :idn_lang_code # Reserved for future use. # # @option params [required, Integer] :duration_in_years # The number of years that you want to register the domain for. Domains # are registered for a minimum of one year. The maximum period depends # on the top-level domain. # # Default: 1 # # @option params [Array] :nameservers # Contains details for the host and glue IP addresses. # # @option params [String] :auth_code # The authorization code for the domain. You get this value from the # current registrar. # # @option params [Boolean] :auto_renew # Indicates whether the domain will be automatically renewed (true) or # not (false). Auto renewal only takes effect after the account is # charged. # # Default: true # # @option params [required, Types::ContactDetail] :admin_contact # Provides detailed contact information. # # @option params [required, Types::ContactDetail] :registrant_contact # Provides detailed contact information. # # @option params [required, Types::ContactDetail] :tech_contact # Provides detailed contact information. # # @option params [Boolean] :privacy_protect_admin_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information for the registrar, the phrase "REDACTED FOR PRIVACY", or # "On behalf of <domain name> owner.". # # While some domains may allow different privacy settings per contact, # we recommend specifying the same privacy setting for all contacts. # # # # Default: `true` # # @option params [Boolean] :privacy_protect_registrant_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the registrant contact (domain # owner). # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # Default: `true` # # @option params [Boolean] :privacy_protect_tech_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the technical contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # Default: `true` # # @option params [Types::ContactDetail] :billing_contact # Provides detailed contact information. # # @option params [Boolean] :privacy_protect_billing_contact # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the billing contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @return [Types::TransferDomainResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::TransferDomainResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.transfer_domain({ # domain_name: "DomainName", # required # idn_lang_code: "LangCode", # duration_in_years: 1, # required # nameservers: [ # { # name: "HostName", # required # glue_ips: ["GlueIp"], # }, # ], # auth_code: "DomainAuthCode", # auto_renew: false, # admin_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # registrant_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # tech_contact: { # required # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # privacy_protect_admin_contact: false, # privacy_protect_registrant_contact: false, # privacy_protect_tech_contact: false, # billing_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # privacy_protect_billing_contact: false, # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/TransferDomain AWS API Documentation # # @overload transfer_domain(params = {}) # @param [Hash] params ({}) def transfer_domain(params = {}, options = {}) req = build_request(:transfer_domain, params) req.send_request(options) end # Transfers a domain from the current Amazon Web Services account to # another Amazon Web Services account. Note the following: # # * The Amazon Web Services account that you're transferring the domain # to must accept the transfer. If the other account doesn't accept # the transfer within 3 days, we cancel the transfer. See # [AcceptDomainTransferFromAnotherAwsAccount][1]. # # * You can cancel the transfer before the other account accepts it. See # [CancelDomainTransferToAnotherAwsAccount][2]. # # * The other account can reject the transfer. See # [RejectDomainTransferFromAnotherAwsAccount][3]. # # When you transfer a domain from one Amazon Web Services account to # another, Route 53 doesn't transfer the hosted zone that is associated # with the domain. DNS resolution isn't affected if the domain and the # hosted zone are owned by separate accounts, so transferring the hosted # zone is optional. For information about transferring the hosted zone # to another Amazon Web Services account, see [Migrating a Hosted Zone # to a Different Amazon Web Services Account][4] in the *Amazon Route 53 # Developer Guide*. # # Use either [ListOperations][5] or [GetOperationDetail][6] to determine # whether the operation succeeded. [GetOperationDetail][6] provides # additional information, for example, `Domain Transfer from Aws Account # 111122223333 has been cancelled`. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_AcceptDomainTransferFromAnotherAwsAccount.html # [2]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_CancelDomainTransferToAnotherAwsAccount.html # [3]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_RejectDomainTransferFromAnotherAwsAccount.html # [4]: https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-migrating.html # [5]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_ListOperations.html # [6]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html # # @option params [required, String] :domain_name # The name of the domain that you want to transfer from the current # Amazon Web Services account to another account. # # @option params [required, String] :account_id # The account ID of the Amazon Web Services account that you want to # transfer the domain to, for example, `111122223333`. # # @return [Types::TransferDomainToAnotherAwsAccountResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::TransferDomainToAnotherAwsAccountResponse#operation_id #operation_id} => String # * {Types::TransferDomainToAnotherAwsAccountResponse#password #password} => String # # @example Request syntax with placeholder values # # resp = client.transfer_domain_to_another_aws_account({ # domain_name: "DomainName", # required # account_id: "AccountId", # required # }) # # @example Response structure # # resp.operation_id #=> String # resp.password #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/TransferDomainToAnotherAwsAccount AWS API Documentation # # @overload transfer_domain_to_another_aws_account(params = {}) # @param [Hash] params ({}) def transfer_domain_to_another_aws_account(params = {}, options = {}) req = build_request(:transfer_domain_to_another_aws_account, params) req.send_request(options) end # This operation updates the contact information for a particular # domain. You must specify information for at least one contact: # registrant, administrator, or technical. # # If the update is successful, this method returns an operation ID that # you can use to track the progress and completion of the operation. If # the request is not completed successfully, the domain registrant will # be notified by email. # # @option params [required, String] :domain_name # The name of the domain that you want to update contact information # for. # # @option params [Types::ContactDetail] :admin_contact # Provides detailed contact information. # # @option params [Types::ContactDetail] :registrant_contact # Provides detailed contact information. # # @option params [Types::ContactDetail] :tech_contact # Provides detailed contact information. # # @option params [Types::Consent] :consent # Customer's consent for the owner change request. Required if the # domain is not free (consent price is more than $0.00). # # @option params [Types::ContactDetail] :billing_contact # Provides detailed contact information. # # @return [Types::UpdateDomainContactResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDomainContactResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.update_domain_contact({ # domain_name: "DomainName", # required # admin_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # registrant_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # tech_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # consent: { # max_price: 1.0, # required # currency: "Currency", # required # }, # billing_contact: { # first_name: "ContactName", # last_name: "ContactName", # contact_type: "PERSON", # accepts PERSON, COMPANY, ASSOCIATION, PUBLIC_BODY, RESELLER # organization_name: "ContactName", # address_line_1: "AddressLine", # address_line_2: "AddressLine", # city: "City", # state: "State", # country_code: "AC", # accepts AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CR, CU, CV, CW, CX, CY, CZ, DE, DJ, DK, DM, DO, DZ, EC, EE, EG, EH, ER, ES, ET, FI, FJ, FK, FM, FO, FR, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, 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, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SV, SX, SY, SZ, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, YE, YT, ZA, ZM, ZW # zip_code: "ZipCode", # phone_number: "ContactNumber", # email: "Email", # fax: "ContactNumber", # extra_params: [ # { # 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, CA_LEGAL_REPRESENTATIVE, CA_LEGAL_REPRESENTATIVE_CAPACITY, ES_IDENTIFICATION, ES_IDENTIFICATION_TYPE, ES_LEGAL_FORM, FI_BUSINESS_NUMBER, FI_ID_NUMBER, FI_NATIONALITY, FI_ORGANIZATION_TYPE, IT_NATIONALITY, IT_PIN, IT_REGISTRANT_ENTITY_TYPE, RU_PASSPORT_DATA, SE_ID_NUMBER, SG_ID_NUMBER, VAT_NUMBER, UK_CONTACT_TYPE, UK_COMPANY_NUMBER, EU_COUNTRY_OF_CITIZENSHIP, AU_PRIORITY_TOKEN # value: "ExtraParamValue", # required # }, # ], # }, # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/UpdateDomainContact AWS API Documentation # # @overload update_domain_contact(params = {}) # @param [Hash] params ({}) def update_domain_contact(params = {}, options = {}) req = build_request(:update_domain_contact, params) req.send_request(options) end # This operation updates the specified domain contact's privacy # setting. When privacy protection is enabled, your contact information # is replaced with contact information for the registrar or with the # phrase "REDACTED FOR PRIVACY", or "On behalf of <domain name> # owner." # # While some domains may allow different privacy settings per contact, # we recommend specifying the same privacy setting for all contacts. # # # # This operation affects only the contact information for the specified # contact type (administrative, registrant, or technical). If the # request succeeds, Amazon Route 53 returns an operation ID that you can # use with [GetOperationDetail][1] to track the progress and completion # of the action. If the request doesn't complete successfully, the # domain registrant will be notified by email. # # By disabling the privacy service via API, you consent to the # publication of the contact information provided for this domain via # the public WHOIS database. You certify that you are the registrant of # this domain name and have the authority to make this decision. You may # withdraw your consent at any time by enabling privacy protection using # either `UpdateDomainContactPrivacy` or the Route 53 console. Enabling # privacy protection removes the contact information provided for this # domain from the WHOIS database. For more information on our privacy # practices, see [https://aws.amazon.com/privacy/][2]. # # # # [1]: https://docs.aws.amazon.com/Route53/latest/APIReference/API_domains_GetOperationDetail.html # [2]: https://aws.amazon.com/privacy/ # # @option params [required, String] :domain_name # The name of the domain that you want to update the privacy setting # for. # # @option params [Boolean] :admin_privacy # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the admin contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @option params [Boolean] :registrant_privacy # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the registrant contact (domain # owner). # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @option params [Boolean] :tech_privacy # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the technical contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @option params [Boolean] :billing_privacy # Whether you want to conceal contact information from WHOIS queries. If # you specify `true`, WHOIS ("who is") queries return contact # information either for Amazon Registrar or for our registrar # associate, Gandi. If you specify `false`, WHOIS queries return the # information that you entered for the billing contact. # # You must specify the same privacy setting for the administrative, # billing, registrant, and technical contacts. # # # # @return [Types::UpdateDomainContactPrivacyResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDomainContactPrivacyResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.update_domain_contact_privacy({ # domain_name: "DomainName", # required # admin_privacy: false, # registrant_privacy: false, # tech_privacy: false, # billing_privacy: false, # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/UpdateDomainContactPrivacy AWS API Documentation # # @overload update_domain_contact_privacy(params = {}) # @param [Hash] params ({}) def update_domain_contact_privacy(params = {}, options = {}) req = build_request(:update_domain_contact_privacy, params) req.send_request(options) end # This operation replaces the current set of name servers for the domain # with the specified set of name servers. If you use Amazon Route 53 as # your DNS service, specify the four name servers in the delegation set # for the hosted zone for the domain. # # If successful, this operation returns an operation ID that you can use # to track the progress and completion of the action. If the request is # not completed successfully, the domain registrant will be notified by # email. # # @option params [required, String] :domain_name # The name of the domain that you want to change name servers for. # # @option params [String] :fi_auth_key # The authorization key for .fi domains # # @option params [required, Array] :nameservers # A list of new name servers for the domain. # # @return [Types::UpdateDomainNameserversResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::UpdateDomainNameserversResponse#operation_id #operation_id} => String # # @example Request syntax with placeholder values # # resp = client.update_domain_nameservers({ # domain_name: "DomainName", # required # fi_auth_key: "FIAuthKey", # nameservers: [ # required # { # name: "HostName", # required # glue_ips: ["GlueIp"], # }, # ], # }) # # @example Response structure # # resp.operation_id #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/UpdateDomainNameservers AWS API Documentation # # @overload update_domain_nameservers(params = {}) # @param [Hash] params ({}) def update_domain_nameservers(params = {}, options = {}) req = build_request(:update_domain_nameservers, params) req.send_request(options) end # This operation adds or updates tags for a specified domain. # # All tag operations are eventually consistent; subsequent operations # might not immediately represent all issued operations. # # @option params [required, String] :domain_name # The domain for which you want to add or update tags. # # @option params [Array] :tags_to_update # A list of the tag keys and values that you want to add or update. If # you specify a key that already exists, the corresponding value will be # replaced. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # # @example Request syntax with placeholder values # # resp = client.update_tags_for_domain({ # domain_name: "DomainName", # required # tags_to_update: [ # { # key: "TagKey", # value: "TagValue", # }, # ], # }) # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/UpdateTagsForDomain AWS API Documentation # # @overload update_tags_for_domain(params = {}) # @param [Hash] params ({}) def update_tags_for_domain(params = {}, options = {}) req = build_request(:update_tags_for_domain, params) req.send_request(options) end # Returns all the domain-related billing records for the current Amazon # Web Services account for a specified period # # @option params [Time,DateTime,Date,Integer,String] :start # The beginning date and time for the time period for which you want a # list of billing records. Specify the date and time in Unix time format # and Coordinated Universal time (UTC). # # @option params [Time,DateTime,Date,Integer,String] :end # The end date and time for the time period for which you want a list of # billing records. Specify the date and time in Unix time format and # Coordinated Universal time (UTC). # # @option params [String] :marker # For an initial request for a list of billing records, omit this # element. If the number of billing records that are associated with the # current Amazon Web Services account during the specified period is # greater than the value that you specified for `MaxItems`, you can use # `Marker` to return additional billing records. Get the value of # `NextPageMarker` from the previous response, and submit another # request that includes the value of `NextPageMarker` in the `Marker` # element. # # Constraints: The marker must match the value of `NextPageMarker` that # was returned in the previous response. # # @option params [Integer] :max_items # The number of billing records to be returned. # # Default: 20 # # @return [Types::ViewBillingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ViewBillingResponse#next_page_marker #next_page_marker} => String # * {Types::ViewBillingResponse#billing_records #billing_records} => Array<Types::BillingRecord> # # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # # @example Request syntax with placeholder values # # resp = client.view_billing({ # start: Time.now, # end: Time.now, # marker: "PageMarker", # max_items: 1, # }) # # @example Response structure # # resp.next_page_marker #=> String # resp.billing_records #=> Array # resp.billing_records[0].domain_name #=> String # 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", "ENABLE_AUTORENEW", "DISABLE_AUTORENEW", "ADD_DNSSEC", "REMOVE_DNSSEC", "EXPIRE_DOMAIN", "TRANSFER_OUT_DOMAIN", "CHANGE_DOMAIN_OWNER", "RENEW_DOMAIN", "PUSH_DOMAIN", "INTERNAL_TRANSFER_OUT_DOMAIN", "INTERNAL_TRANSFER_IN_DOMAIN", "RELEASE_TO_GANDI", "TRANSFER_ON_RENEW" # resp.billing_records[0].invoice_id #=> String # resp.billing_records[0].bill_date #=> Time # resp.billing_records[0].price #=> Float # # @see http://docs.aws.amazon.com/goto/WebAPI/route53domains-2014-05-15/ViewBilling AWS API Documentation # # @overload view_billing(params = {}) # @param [Hash] params ({}) def view_billing(params = {}, options = {}) req = build_request(:view_billing, params) req.send_request(options) end # @!endgroup # @param params ({}) # @api private def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::Route53Domains') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-route53domains' context[:gem_version] = '1.68.0' Seahorse::Client::Request.new(handlers, context) end # @api private # @deprecated def waiter_names [] end class << self # @api private attr_reader :identifier # @api private def errors_module Errors end end end end