Class: Aws::BackupGateway::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb

Overview

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

client = Aws::BackupGateway::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

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[: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.

  • :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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :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['AWS_AUTH_SCHEME_PREFERENCE'] 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. Takes effect only when disable_clock_skew_correction is not set.

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

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

  • :disable_clock_skew_correction (Boolean) —

    Used only in standard and adaptive retry modes. When true, the SDK does not apply a clock skew correction, does not update its stored skew from responses, and does not retry clock skew errors. Clock skew correction is enabled by default.

  • :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 https://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 the 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 - A retry mode that includes all the functionality of standard mode along with automatic client side throttling.

  • :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:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: 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.

  • :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::BackupGateway::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::BackupGateway::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 'http://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.



485
486
487
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 485

def initialize(*args)
  super
end

Instance Method Details

#associate_gateway_to_server(params = {}) ⇒ Types::AssociateGatewayToServerOutput

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

Examples:

Request syntax with placeholder values


resp = client.associate_gateway_to_server({
  gateway_arn: "GatewayArn", # required
  server_arn: "ServerArn", # required
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • :server_arn (required, String) —

    The Amazon Resource Name (ARN) of the server that hosts your virtual machines.

Returns:

See Also:



523
524
525
526
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 523

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

#create_gateway(params = {}) ⇒ Types::CreateGatewayOutput

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

Examples:

Request syntax with placeholder values


resp = client.create_gateway({
  activation_key: "ActivationKey", # required
  gateway_display_name: "Name", # required
  gateway_type: "BACKUP_VM", # required, accepts BACKUP_VM
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :activation_key (required, String) —

    The activation key of the created gateway.

  • :gateway_display_name (required, String) —

    The display name of the created gateway.

  • :gateway_type (required, String) —

    The type of created gateway.

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

    A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

Returns:

See Also:



571
572
573
574
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 571

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

#delete_gateway(params = {}) ⇒ Types::DeleteGatewayOutput

Deletes a backup gateway.

Examples:

Request syntax with placeholder values


resp = client.delete_gateway({
  gateway_arn: "GatewayArn", # required
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway to delete.

Returns:

See Also:



599
600
601
602
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 599

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

#delete_hypervisor(params = {}) ⇒ Types::DeleteHypervisorOutput

Deletes a hypervisor.

Examples:

Request syntax with placeholder values


resp = client.delete_hypervisor({
  hypervisor_arn: "ServerArn", # required
})

Response structure


resp.hypervisor_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor to delete.

Returns:

See Also:



627
628
629
630
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 627

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

#disassociate_gateway_from_server(params = {}) ⇒ Types::DisassociateGatewayFromServerOutput

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

Examples:

Request syntax with placeholder values


resp = client.disassociate_gateway_from_server({
  gateway_arn: "GatewayArn", # required
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway to disassociate.

Returns:

See Also:



657
658
659
660
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 657

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

#get_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::GetBandwidthRateLimitScheduleOutput

Retrieves the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. Use this to get a gateway's bandwidth rate limit schedule.

Examples:

Request syntax with placeholder values


resp = client.get_bandwidth_rate_limit_schedule({
  gateway_arn: "GatewayArn", # required
})

Response structure


resp.gateway_arn #=> String
resp.bandwidth_rate_limit_intervals #=> Array
resp.bandwidth_rate_limit_intervals[0].average_upload_rate_limit_in_bits_per_sec #=> Integer
resp.bandwidth_rate_limit_intervals[0].start_hour_of_day #=> Integer
resp.bandwidth_rate_limit_intervals[0].end_hour_of_day #=> Integer
resp.bandwidth_rate_limit_intervals[0].start_minute_of_hour #=> Integer
resp.bandwidth_rate_limit_intervals[0].end_minute_of_hour #=> Integer
resp.bandwidth_rate_limit_intervals[0].days_of_week #=> Array
resp.bandwidth_rate_limit_intervals[0].days_of_week[0] #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

Returns:

See Also:



703
704
705
706
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 703

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

#get_gateway(params = {}) ⇒ Types::GetGatewayOutput

By providing the ARN (Amazon Resource Name), this API returns the gateway.

Examples:

Request syntax with placeholder values


resp = client.get_gateway({
  gateway_arn: "GatewayArn", # required
})

Response structure


resp.gateway.gateway_arn #=> String
resp.gateway.gateway_display_name #=> String
resp.gateway.gateway_type #=> String, one of "BACKUP_VM"
resp.gateway.hypervisor_id #=> String
resp.gateway.last_seen_time #=> Time
resp.gateway.maintenance_start_time.day_of_month #=> Integer
resp.gateway.maintenance_start_time.day_of_week #=> Integer
resp.gateway.maintenance_start_time.hour_of_day #=> Integer
resp.gateway.maintenance_start_time.minute_of_hour #=> Integer
resp.gateway.next_update_availability_time #=> Time
resp.gateway.vpc_endpoint #=> String
resp.gateway.deprecation_date #=> Time
resp.gateway.software_version #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway.

Returns:

See Also:



744
745
746
747
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 744

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

#get_hypervisor(params = {}) ⇒ Types::GetHypervisorOutput

This action requests information about the specified hypervisor to which the gateway will connect. A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.

Examples:

Request syntax with placeholder values


resp = client.get_hypervisor({
  hypervisor_arn: "ServerArn", # required
})

Response structure


resp.hypervisor.host #=> String
resp.hypervisor.hypervisor_arn #=> String
resp.hypervisor.kms_key_arn #=> String
resp.hypervisor.name #=> String
resp.hypervisor.log_group_arn #=> String
resp.hypervisor.state #=> String, one of "PENDING", "ONLINE", "OFFLINE", "ERROR"
resp.hypervisor.last_successful_metadata_sync_time #=> Time
resp.hypervisor.latest_metadata_sync_status_message #=> String
resp.hypervisor.latest_metadata_sync_status #=> String, one of "CREATED", "RUNNING", "FAILED", "PARTIALLY_FAILED", "SUCCEEDED"

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor.

Returns:

See Also:



783
784
785
786
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 783

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

#get_hypervisor_property_mappings(params = {}) ⇒ Types::GetHypervisorPropertyMappingsOutput

This action retrieves the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.

Examples:

Request syntax with placeholder values


resp = client.get_hypervisor_property_mappings({
  hypervisor_arn: "ServerArn", # required
})

Response structure


resp.hypervisor_arn #=> String
resp.vmware_to_aws_tag_mappings #=> Array
resp.vmware_to_aws_tag_mappings[0].vmware_category #=> String
resp.vmware_to_aws_tag_mappings[0].vmware_tag_name #=> String
resp.vmware_to_aws_tag_mappings[0].aws_tag_key #=> String
resp.vmware_to_aws_tag_mappings[0].aws_tag_value #=> String
resp.iam_role_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor.

Returns:

See Also:



822
823
824
825
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 822

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

#get_virtual_machine(params = {}) ⇒ Types::GetVirtualMachineOutput

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

Examples:

Request syntax with placeholder values


resp = client.get_virtual_machine({
  resource_arn: "ResourceArn", # required
})

Response structure


resp.virtual_machine.host_name #=> String
resp.virtual_machine.hypervisor_id #=> String
resp.virtual_machine.name #=> String
resp.virtual_machine.path #=> String
resp.virtual_machine.resource_arn #=> String
resp.virtual_machine.last_backup_date #=> Time
resp.virtual_machine.vmware_tags #=> Array
resp.virtual_machine.vmware_tags[0].vmware_category #=> String
resp.virtual_machine.vmware_tags[0].vmware_tag_name #=> String
resp.virtual_machine.vmware_tags[0].vmware_tag_description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the virtual machine.

Returns:

See Also:



860
861
862
863
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 860

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

#import_hypervisor_configuration(params = {}) ⇒ Types::ImportHypervisorConfigurationOutput

Connect to a hypervisor by importing its configuration.

Examples:

Request syntax with placeholder values


resp = client.import_hypervisor_configuration({
  name: "Name", # required
  host: "Host", # required
  username: "Username",
  password: "Password",
  kms_key_arn: "KmsKeyArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.hypervisor_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the hypervisor.

  • :host (required, String) —

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • :username (String) —

    The username for the hypervisor.

  • :password (String) —

    The password for the hypervisor.

  • :kms_key_arn (String) —

    The Key Management Service for the hypervisor.

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

    The tags of the hypervisor configuration to import.

Returns:

See Also:



914
915
916
917
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 914

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

#list_gateways(params = {}) ⇒ Types::ListGatewaysOutput

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

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_gateways({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.gateways #=> Array
resp.gateways[0].gateway_arn #=> String
resp.gateways[0].gateway_display_name #=> String
resp.gateways[0].gateway_type #=> String, one of "BACKUP_VM"
resp.gateways[0].hypervisor_id #=> String
resp.gateways[0].last_seen_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of gateways to list.

  • :next_token (String) —

    The next item following a partial list of returned resources. For example, if a request is made to return MaxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

See Also:



960
961
962
963
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 960

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

#list_hypervisors(params = {}) ⇒ Types::ListHypervisorsOutput

Lists your hypervisors.

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_hypervisors({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.hypervisors #=> Array
resp.hypervisors[0].host #=> String
resp.hypervisors[0].hypervisor_arn #=> String
resp.hypervisors[0].kms_key_arn #=> String
resp.hypervisors[0].name #=> String
resp.hypervisors[0].state #=> String, one of "PENDING", "ONLINE", "OFFLINE", "ERROR"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    The maximum number of hypervisors to list.

  • :next_token (String) —

    The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

See Also:



1004
1005
1006
1007
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1004

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

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

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

Examples:

Request syntax with placeholder values


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

Response structure


resp.resource_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource's tags to list.

Returns:

See Also:



1037
1038
1039
1040
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1037

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

#list_virtual_machines(params = {}) ⇒ Types::ListVirtualMachinesOutput

Lists your virtual machines.

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_virtual_machines({
  hypervisor_arn: "ServerArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.virtual_machines #=> Array
resp.virtual_machines[0].host_name #=> String
resp.virtual_machines[0].hypervisor_id #=> String
resp.virtual_machines[0].name #=> String
resp.virtual_machines[0].path #=> String
resp.virtual_machines[0].resource_arn #=> String
resp.virtual_machines[0].last_backup_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (String) —

    The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

  • :max_results (Integer) —

    The maximum number of virtual machines to list.

  • :next_token (String) —

    The next item following a partial list of returned resources. For example, if a request is made to return maxResults number of resources, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

Returns:

See Also:



1087
1088
1089
1090
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1087

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

#put_bandwidth_rate_limit_schedule(params = {}) ⇒ Types::PutBandwidthRateLimitScheduleOutput

This action sets the bandwidth rate limit schedule for a specified gateway. By default, gateways do not have a bandwidth rate limit schedule, which means no bandwidth rate limiting is in effect. Use this to initiate a gateway's bandwidth rate limit schedule.

Examples:

Request syntax with placeholder values


resp = client.put_bandwidth_rate_limit_schedule({
  gateway_arn: "GatewayArn", # required
  bandwidth_rate_limit_intervals: [ # required
    {
      average_upload_rate_limit_in_bits_per_sec: 1,
      start_hour_of_day: 1, # required
      end_hour_of_day: 1, # required
      start_minute_of_hour: 1, # required
      end_minute_of_hour: 1, # required
      days_of_week: [1], # required
    },
  ],
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.

  • :bandwidth_rate_limit_intervals (required, Array<Types::BandwidthRateLimitInterval>) —

    An array containing bandwidth rate limit schedule intervals for a gateway. When no bandwidth rate limit intervals have been scheduled, the array is empty.

Returns:

See Also:



1139
1140
1141
1142
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1139

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

#put_hypervisor_property_mappings(params = {}) ⇒ Types::PutHypervisorPropertyMappingsOutput

This action sets the property mappings for the specified hypervisor. A hypervisor property mapping displays the relationship of entity properties available from the hypervisor to the properties available in Amazon Web Services.

Examples:

Request syntax with placeholder values


resp = client.put_hypervisor_property_mappings({
  hypervisor_arn: "ServerArn", # required
  vmware_to_aws_tag_mappings: [ # required
    {
      vmware_category: "VmwareCategory", # required
      vmware_tag_name: "VmwareTagName", # required
      aws_tag_key: "TagKey", # required
      aws_tag_value: "TagValue", # required
    },
  ],
  iam_role_arn: "IamRoleArn", # required
})

Response structure


resp.hypervisor_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor.

  • :vmware_to_aws_tag_mappings (required, Array<Types::VmwareToAwsTagMapping>) —

    This action requests the mappings of VMware tags to the Amazon Web Services tags.

  • :iam_role_arn (required, String) —

    The Amazon Resource Name (ARN) of the IAM role.

Returns:

See Also:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1186

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

#put_maintenance_start_time(params = {}) ⇒ Types::PutMaintenanceStartTimeOutput

Set the maintenance start time for a gateway.

Examples:

Request syntax with placeholder values


resp = client.put_maintenance_start_time({
  gateway_arn: "GatewayArn", # required
  hour_of_day: 1, # required
  minute_of_hour: 1, # required
  day_of_week: 1,
  day_of_month: 1,
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) for the gateway, used to specify its maintenance start time.

  • :hour_of_day (required, Integer) —

    The hour of the day to start maintenance on a gateway.

  • :minute_of_hour (required, Integer) —

    The minute of the hour to start maintenance on a gateway.

  • :day_of_week (Integer) —

    The day of the week to start maintenance on a gateway.

  • :day_of_month (Integer) —

    The day of the month start maintenance on a gateway.

    Valid values range from Sunday to Saturday.

Returns:

See Also:



1233
1234
1235
1236
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1233

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

#start_virtual_machines_metadata_sync(params = {}) ⇒ Types::StartVirtualMachinesMetadataSyncOutput

This action sends a request to sync metadata across the specified virtual machines.

Examples:

Request syntax with placeholder values


resp = client.start_virtual_machines_metadata_sync({
  hypervisor_arn: "ServerArn", # required
})

Response structure


resp.hypervisor_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor.

Returns:

See Also:



1262
1263
1264
1265
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1262

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

#tag_resource(params = {}) ⇒ Types::TagResourceOutput

Tag the resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "ResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to tag.

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

    A list of tags to assign to the resource.

Returns:

See Also:



1299
1300
1301
1302
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1299

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

#test_hypervisor_configuration(params = {}) ⇒ Struct

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

Examples:

Request syntax with placeholder values


resp = client.test_hypervisor_configuration({
  gateway_arn: "GatewayArn", # required
  host: "Host", # required
  username: "Username",
  password: "Password",
})

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway to the hypervisor to test.

  • :host (required, String) —

    The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • :username (String) —

    The username for the hypervisor.

  • :password (String) —

    The password for the hypervisor.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1336
1337
1338
1339
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1336

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

#untag_resource(params = {}) ⇒ Types::UntagResourceOutput

Removes tags from the resource.

Examples:

Request syntax with placeholder values


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

Response structure


resp.resource_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource from which to remove tags.

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

    The list of tag keys specifying which tags to remove.

Returns:

See Also:



1369
1370
1371
1372
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1369

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

#update_gateway_information(params = {}) ⇒ Types::UpdateGatewayInformationOutput

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

Examples:

Request syntax with placeholder values


resp = client.update_gateway_information({
  gateway_arn: "GatewayArn", # required
  gateway_display_name: "Name",
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway to update.

  • :gateway_display_name (String) —

    The updated display name of the gateway.

Returns:

See Also:



1402
1403
1404
1405
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1402

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

#update_gateway_software_now(params = {}) ⇒ Types::UpdateGatewaySoftwareNowOutput

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

Examples:

Request syntax with placeholder values


resp = client.update_gateway_software_now({
  gateway_arn: "GatewayArn", # required
})

Response structure


resp.gateway_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :gateway_arn (required, String) —

    The Amazon Resource Name (ARN) of the gateway to be updated.

Returns:

See Also:



1437
1438
1439
1440
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1437

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

#update_hypervisor(params = {}) ⇒ Types::UpdateHypervisorOutput

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

Examples:

Request syntax with placeholder values


resp = client.update_hypervisor({
  hypervisor_arn: "ServerArn", # required
  host: "Host",
  username: "Username",
  password: "Password",
  name: "Name",
  log_group_arn: "LogGroupArn",
})

Response structure


resp.hypervisor_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :hypervisor_arn (required, String) —

    The Amazon Resource Name (ARN) of the hypervisor to update.

  • :host (String) —

    The updated host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).

  • :username (String) —

    The updated username for the hypervisor.

  • :password (String) —

    The updated password for the hypervisor.

  • :name (String) —

    The updated name for the hypervisor

  • :log_group_arn (String) —

    The Amazon Resource Name (ARN) of the group of gateways within the requested log.

Returns:

See Also:



1489
1490
1491
1492
 
# File 'gems/aws-sdk-backupgateway/lib/aws-sdk-backupgateway/client.rb', line 1489

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