Class: Aws::Route53Profiles::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
lib/aws-sdk-route53profiles/client.rb

Overview

An API client for Route53Profiles. To construct a client, you need to configure a ‘:region` and `:credentials`.

client = Aws::Route53Profiles::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 Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements ‘Aws::CredentialProvider`, or 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`

    • The ‘:access_key_id`, `:secret_access_key`, `:session_token`, and `:account_id` options.

    • ‘ENV`, `ENV`, `ENV`, and `ENV`.

    • ‘~/.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` to `true`.

  • :region (required, String) —

    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:

  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: 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.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: ‘sigv4`, `sigv4a`, `httpBearerAuth`, and `noAuth`. When set using `ENV` or in shared config as `auth_scheme_preference`, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "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.

  • :client_side_monitoring_port (Integer) — default: 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.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    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'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 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.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at ‘HOME/.aws/credentials`. When not specified, ’default’ is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

  • :request_min_compression_size_bytes (Integer) — default: 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.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :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 www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 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.

  • :retry_max_delay (Integer) — default: 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.

  • :retry_mode (String) — default: "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.

  • :sdk_ua_app_id (String) —

    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.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    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:

  • :stub_responses (Boolean) — default: 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.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: 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.

  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements ‘Aws::TokenProvider`, or 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.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    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`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::Route53Profiles::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Route53Profiles::EndpointParameters`.

  • :http_continue_timeout (Float) — default: 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.

  • :http_idle_timeout (Float) — default: 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.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :on_chunk_received (Proc) —

    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`).

  • :on_chunk_sent (Proc) —

    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.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

  • :ssl_ca_bundle (String) —

    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.

  • :ssl_ca_directory (String) —

    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.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 473

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1244
1245
1246
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1244

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1247
1248
1249
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1247

def errors_module
  Errors
end

Instance Method Details

#associate_profile(params = {}) ⇒ Types::AssociateProfileResponse

Associates a Route 53 Profiles profile with a VPC. A VPC can have only one Profile associated with it, but a Profile can be associated with 1000 of VPCs (and you can request a higher quota). For more information, see [docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities][1].

[1]: docs.aws.amazon.com/Route53/latest/DeveloperGuide/DNSLimitations.html#limits-api-entities

Examples:

Request syntax with placeholder values


resp = client.associate_profile({
  name: "Name", # required
  profile_id: "ResourceId", # required
  resource_id: "ResourceId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.profile_association.creation_time #=> Time
resp.profile_association.id #=> String
resp.profile_association.modification_time #=> Time
resp.profile_association.name #=> String
resp.profile_association.owner_id #=> String
resp.profile_association.profile_id #=> String
resp.profile_association.resource_id #=> String
resp.profile_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    A name for the association.

  • :profile_id (required, String) —

    ID of the Profile.

  • :resource_id (required, String) —

    The ID of the VPC.

  • :tags (Array<Types::Tag>) —

    A list of the tag keys and values that you want to identify the Profile association.

Returns:

See Also:



536
537
538
539
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 536

def associate_profile(params = {}, options = {})
  req = build_request(:associate_profile, params)
  req.send_request(options)
end

#associate_resource_to_profile(params = {}) ⇒ Types::AssociateResourceToProfileResponse

Associates a DNS reource configuration to a Route 53 Profile.

Examples:

Request syntax with placeholder values


resp = client.associate_resource_to_profile({
  name: "Name", # required
  profile_id: "ResourceId", # required
  resource_arn: "Arn", # required
  resource_properties: "ResourceProperties",
})

Response structure


resp.profile_resource_association.creation_time #=> Time
resp.profile_resource_association.id #=> String
resp.profile_resource_association.modification_time #=> Time
resp.profile_resource_association.name #=> String
resp.profile_resource_association.owner_id #=> String
resp.profile_resource_association.profile_id #=> String
resp.profile_resource_association.resource_arn #=> String
resp.profile_resource_association.resource_properties #=> String
resp.profile_resource_association.resource_type #=> String
resp.profile_resource_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_resource_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (required, String) —

    Name for the resource association.

  • :profile_id (required, String) —

    ID of the Profile.

  • :resource_arn (required, String) —

    Amazon resource number, ARN, of the DNS resource.

  • :resource_properties (String) —

    If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

    The allowed values for priority are between 100 and 9900.

Returns:

See Also:



590
591
592
593
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 590

def associate_resource_to_profile(params = {}, options = {})
  req = build_request(:associate_resource_to_profile, params)
  req.send_request(options)
end

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • params ({}) (defaults to: {}) 


1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1217

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::Route53Profiles')
  )
  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-route53profiles'
  context[:gem_version] = '1.27.0'
  Seahorse::Client::Request.new(handlers, context)
end

#create_profile(params = {}) ⇒ Types::CreateProfileResponse

Creates an empty Route 53 Profile.

Examples:

Request syntax with placeholder values


resp = client.create_profile({
  client_token: "CreatorRequestId", # required
  name: "Name", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.profile.arn #=> String
resp.profile.client_token #=> String
resp.profile.creation_time #=> Time
resp.profile.id #=> String
resp.profile.modification_time #=> Time
resp.profile.name #=> String
resp.profile.owner_id #=> String
resp.profile.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.profile.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :client_token (required, String) —

    ‘ClientToken` is an idempotency token that ensures a call to `CreateProfile` completes only once. You choose the value to pass. For example, an issue might prevent you from getting a response from `CreateProfile`. In this case, safely retry your call to `CreateProfile` by using the same `CreateProfile` parameter value.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

  • :name (required, String) —

    A name for the Profile.

  • :tags (Array<Types::Tag>) —

    A list of the tag keys and values that you want to associate with the Route 53 Profile.

Returns:

See Also:



648
649
650
651
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 648

def create_profile(params = {}, options = {})
  req = build_request(:create_profile, params)
  req.send_request(options)
end

#delete_profile(params = {}) ⇒ Types::DeleteProfileResponse

Deletes the specified Route 53 Profile. Before you can delete a profile, you must first disassociate it from all VPCs.

Examples:

Request syntax with placeholder values


resp = client.delete_profile({
  profile_id: "ResourceId", # required
})

Response structure


resp.profile.arn #=> String
resp.profile.client_token #=> String
resp.profile.creation_time #=> Time
resp.profile.id #=> String
resp.profile.modification_time #=> Time
resp.profile.name #=> String
resp.profile.owner_id #=> String
resp.profile.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.profile.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The ID of the Profile that you want to delete.

Returns:

See Also:



686
687
688
689
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 686

def delete_profile(params = {}, options = {})
  req = build_request(:delete_profile, params)
  req.send_request(options)
end

#disassociate_profile(params = {}) ⇒ Types::DisassociateProfileResponse

Dissociates a specified Route 53 Profile from the specified VPC.

Examples:

Request syntax with placeholder values


resp = client.disassociate_profile({
  profile_id: "ResourceId", # required
  resource_id: "ResourceId", # required
})

Response structure


resp.profile_association.creation_time #=> Time
resp.profile_association.id #=> String
resp.profile_association.modification_time #=> Time
resp.profile_association.name #=> String
resp.profile_association.owner_id #=> String
resp.profile_association.profile_id #=> String
resp.profile_association.resource_id #=> String
resp.profile_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    ID of the Profile.

  • :resource_id (required, String) —

    The ID of the VPC.

Returns:

See Also:



726
727
728
729
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 726

def disassociate_profile(params = {}, options = {})
  req = build_request(:disassociate_profile, params)
  req.send_request(options)
end

#disassociate_resource_from_profile(params = {}) ⇒ Types::DisassociateResourceFromProfileResponse

Dissoaciated a specified resource, from the Route 53 Profile.

Examples:

Request syntax with placeholder values


resp = client.disassociate_resource_from_profile({
  profile_id: "ResourceId", # required
  resource_arn: "Arn", # required
})

Response structure


resp.profile_resource_association.creation_time #=> Time
resp.profile_resource_association.id #=> String
resp.profile_resource_association.modification_time #=> Time
resp.profile_resource_association.name #=> String
resp.profile_resource_association.owner_id #=> String
resp.profile_resource_association.profile_id #=> String
resp.profile_resource_association.resource_arn #=> String
resp.profile_resource_association.resource_properties #=> String
resp.profile_resource_association.resource_type #=> String
resp.profile_resource_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_resource_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    The ID of the Profile.

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource.

Returns:

See Also:



768
769
770
771
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 768

def disassociate_resource_from_profile(params = {}, options = {})
  req = build_request(:disassociate_resource_from_profile, params)
  req.send_request(options)
end

#get_profile(params = {}) ⇒ Types::GetProfileResponse

Returns information about a specified Route 53 Profile, such as whether whether the Profile is shared, and the current status of the Profile.

Examples:

Request syntax with placeholder values


resp = client.get_profile({
  profile_id: "ResourceId", # required
})

Response structure


resp.profile.arn #=> String
resp.profile.client_token #=> String
resp.profile.creation_time #=> Time
resp.profile.id #=> String
resp.profile.modification_time #=> Time
resp.profile.name #=> String
resp.profile.owner_id #=> String
resp.profile.share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"
resp.profile.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_id (required, String) —

    ID of the Profile.

Returns:

See Also:



807
808
809
810
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 807

def get_profile(params = {}, options = {})
  req = build_request(:get_profile, params)
  req.send_request(options)
end

#get_profile_association(params = {}) ⇒ Types::GetProfileAssociationResponse

Retrieves a Route 53 Profile association for a VPC. A VPC can have only one Profile association, but a Profile can be associated with up to 5000 VPCs.

Examples:

Request syntax with placeholder values


resp = client.get_profile_association({
  profile_association_id: "ResourceId", # required
})

Response structure


resp.profile_association.creation_time #=> Time
resp.profile_association.id #=> String
resp.profile_association.modification_time #=> Time
resp.profile_association.name #=> String
resp.profile_association.owner_id #=> String
resp.profile_association.profile_id #=> String
resp.profile_association.resource_id #=> String
resp.profile_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_association_id (required, String) —

    The identifier of the association you want to get information about.

Returns:

See Also:



845
846
847
848
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 845

def get_profile_association(params = {}, options = {})
  req = build_request(:get_profile_association, params)
  req.send_request(options)
end

#get_profile_resource_association(params = {}) ⇒ Types::GetProfileResourceAssociationResponse

Returns information about a specified Route 53 Profile resource association.

Examples:

Request syntax with placeholder values


resp = client.get_profile_resource_association({
  profile_resource_association_id: "ResourceId", # required
})

Response structure


resp.profile_resource_association.creation_time #=> Time
resp.profile_resource_association.id #=> String
resp.profile_resource_association.modification_time #=> Time
resp.profile_resource_association.name #=> String
resp.profile_resource_association.owner_id #=> String
resp.profile_resource_association.profile_id #=> String
resp.profile_resource_association.resource_arn #=> String
resp.profile_resource_association.resource_properties #=> String
resp.profile_resource_association.resource_type #=> String
resp.profile_resource_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_resource_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :profile_resource_association_id (required, String) —

    The ID of the profile resource association that you want to get information about.

Returns:

See Also:



885
886
887
888
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 885

def get_profile_resource_association(params = {}, options = {})
  req = build_request(:get_profile_resource_association, params)
  req.send_request(options)
end

#list_profile_associations(params = {}) ⇒ Types::ListProfileAssociationsResponse

Lists all the VPCs that the specified Route 53 Profile is associated with.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_profile_associations({
  max_results: 1,
  next_token: "NextToken",
  profile_id: "ResourceId",
  resource_id: "ResourceId",
})

Response structure


resp.next_token #=> String
resp.profile_associations #=> Array
resp.profile_associations[0].creation_time #=> Time
resp.profile_associations[0].id #=> String
resp.profile_associations[0].modification_time #=> Time
resp.profile_associations[0].name #=> String
resp.profile_associations[0].owner_id #=> String
resp.profile_associations[0].profile_id #=> String
resp.profile_associations[0].resource_id #=> String
resp.profile_associations[0].status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_associations[0].status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a ‘NextToken` value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for ‘MaxResults`, up to 100 objects are returned.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by ‘MaxResults` is returned. If more objects are available for retrieval, a `NextToken` value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

  • :profile_id (String) —

    ID of the Profile.

  • :resource_id (String) —

    ID of the VPC.

Returns:

See Also:



951
952
953
954
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 951

def list_profile_associations(params = {}, options = {})
  req = build_request(:list_profile_associations, params)
  req.send_request(options)
end

#list_profile_resource_associations(params = {}) ⇒ Types::ListProfileResourceAssociationsResponse

Lists all the resource associations for the specified Route 53 Profile.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_profile_resource_associations({
  max_results: 1,
  next_token: "NextToken",
  profile_id: "ResourceId", # required
  resource_type: "String",
})

Response structure


resp.next_token #=> String
resp.profile_resource_associations #=> Array
resp.profile_resource_associations[0].creation_time #=> Time
resp.profile_resource_associations[0].id #=> String
resp.profile_resource_associations[0].modification_time #=> Time
resp.profile_resource_associations[0].name #=> String
resp.profile_resource_associations[0].owner_id #=> String
resp.profile_resource_associations[0].profile_id #=> String
resp.profile_resource_associations[0].resource_arn #=> String
resp.profile_resource_associations[0].resource_properties #=> String
resp.profile_resource_associations[0].resource_type #=> String
resp.profile_resource_associations[0].status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_resource_associations[0].status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a ‘NextToken` value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for ‘MaxResults`, up to 100 objects are returned.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by ‘MaxResults` is returned. If more objects are available for retrieval, a `NextToken` value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

  • :profile_id (required, String) —

    The ID of the Profile.

  • :resource_type (String) —

    ID of a resource if you want information on only one type.

Returns:

See Also:



1019
1020
1021
1022
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1019

def list_profile_resource_associations(params = {}, options = {})
  req = build_request(:list_profile_resource_associations, params)
  req.send_request(options)
end

#list_profiles(params = {}) ⇒ Types::ListProfilesResponse

Lists all the Route 53 Profiles associated with your Amazon Web Services account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_profiles({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.profile_summaries #=> Array
resp.profile_summaries[0].arn #=> String
resp.profile_summaries[0].id #=> String
resp.profile_summaries[0].name #=> String
resp.profile_summaries[0].share_status #=> String, one of "NOT_SHARED", "SHARED_WITH_ME", "SHARED_BY_ME"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of objects that you want to return for this request. If more objects are available, in the response, a ‘NextToken` value, which you can use in a subsequent call to get the next batch of objects, is provided.

    If you don’t specify a value for ‘MaxResults`, up to 100 objects are returned.

  • :next_token (String) —

    For the first call to this list request, omit this value.

    When you request a list of objects, at most the number of objects specified by ‘MaxResults` is returned. If more objects are available for retrieval, a `NextToken` value is returned in the response. To retrieve the next batch of objects, use the token that was returned for the prior request in your next request.

Returns:

See Also:



1072
1073
1074
1075
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1072

def list_profiles(params = {}, options = {})
  req = build_request(:list_profiles, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Lists the tags that you associated with the specified resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) for the resource that you want to list the tags for.

Returns:

See Also:



1102
1103
1104
1105
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1102

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Adds one or more tags to a specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) for the resource that you want to add tags to.

  • :tags (required, Hash<String,String>) —

    The tags that you want to add to the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1131
1132
1133
1134
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1131

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes one or more tags from a specified resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) for the resource that you want to remove tags from.

  • :tag_keys (required, Array<String>) —

    The tags that you want to remove to the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1158
1159
1160
1161
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1158

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_profile_resource_association(params = {}) ⇒ Types::UpdateProfileResourceAssociationResponse

Updates the specified Route 53 Profile resourse association.

Examples:

Request syntax with placeholder values


resp = client.update_profile_resource_association({
  name: "Name",
  profile_resource_association_id: "ResourceId", # required
  resource_properties: "ResourceProperties",
})

Response structure


resp.profile_resource_association.creation_time #=> Time
resp.profile_resource_association.id #=> String
resp.profile_resource_association.modification_time #=> Time
resp.profile_resource_association.name #=> String
resp.profile_resource_association.owner_id #=> String
resp.profile_resource_association.profile_id #=> String
resp.profile_resource_association.resource_arn #=> String
resp.profile_resource_association.resource_properties #=> String
resp.profile_resource_association.resource_type #=> String
resp.profile_resource_association.status #=> String, one of "COMPLETE", "DELETING", "UPDATING", "CREATING", "DELETED", "FAILED"
resp.profile_resource_association.status_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :name (String) —

    Name of the resource association.

  • :profile_resource_association_id (required, String) —

    ID of the resource association.

  • :resource_properties (String) —

    If you are adding a DNS Firewall rule group, include also a priority. The priority indicates the processing order for the rule groups, starting with the priority assinged the lowest value.

    The allowed values for priority are between 100 and 9900.

Returns:

See Also:



1208
1209
1210
1211
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1208

def update_profile_resource_association(params = {}, options = {})
  req = build_request(:update_profile_resource_association, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1237
1238
1239
 
# File 'lib/aws-sdk-route53profiles/client.rb', line 1237

def waiter_names
  []
end