Class: Aws::BackupStorage::Client

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

Overview

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

client = Aws::BackupStorage::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):

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

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

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

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

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

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

  • :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 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/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

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

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

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



370
371
372
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 370

def initialize(*args)
  super
end

Instance Method Details

#delete_object(params = {}) ⇒ Struct

Delete Object from the incremental base Backup.

Examples:

Request syntax with placeholder values


resp = client.delete_object({
  backup_job_id: "string", # required
  object_name: "string", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :backup_job_id (required, String) —

    Backup job Id for the in-progress backup.

  • :object_name (required, String) —

    The name of the Object.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



397
398
399
400
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 397

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

#get_chunk(params = {}) ⇒ Types::GetChunkOutput

Gets the specified object's chunk.

Examples:

Request syntax with placeholder values


resp = client.get_chunk({
  storage_job_id: "string", # required
  chunk_token: "string", # required
})

Response structure


resp.data #=> IO
resp.length #=> Integer
resp.checksum #=> String
resp.checksum_algorithm #=> String, one of "SHA256"

Parameters:

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

    ({})

Options Hash (params):

  • :storage_job_id (required, String) —

    Storage job id

  • :chunk_token (required, String) —

    Chunk token

Returns:

See Also:



435
436
437
438
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 435

def get_chunk(params = {}, options = {}, &block)
  req = build_request(:get_chunk, params)
  req.send_request(options, &block)
end

#get_object_metadata(params = {}) ⇒ Types::GetObjectMetadataOutput

Get metadata associated with an Object.

Examples:

Request syntax with placeholder values


resp = client.get_object_metadata({
  storage_job_id: "string", # required
  object_token: "string", # required
})

Response structure


resp.metadata_string #=> String
resp.metadata_blob #=> IO
resp.metadata_blob_length #=> Integer
resp.metadata_blob_checksum #=> String
resp.metadata_blob_checksum_algorithm #=> String, one of "SHA256"

Parameters:

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

    ({})

Options Hash (params):

  • :storage_job_id (required, String) —

    Backup job id for the in-progress backup.

  • :object_token (required, String) —

    Object token.

Returns:

See Also:



475
476
477
478
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 475

def get_object_metadata(params = {}, options = {}, &block)
  req = build_request(:get_object_metadata, params)
  req.send_request(options, &block)
end

#list_chunks(params = {}) ⇒ Types::ListChunksOutput

List chunks in a given Object

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_chunks({
  storage_job_id: "string", # required
  object_token: "string", # required
  max_results: 1,
  next_token: "string",
})

Response structure


resp.chunk_list #=> Array
resp.chunk_list[0].index #=> Integer
resp.chunk_list[0].length #=> Integer
resp.chunk_list[0].checksum #=> String
resp.chunk_list[0].checksum_algorithm #=> String, one of "SHA256"
resp.chunk_list[0].chunk_token #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :storage_job_id (required, String) —

    Storage job id

  • :object_token (required, String) —

    Object token

  • :max_results (Integer) —

    Maximum number of chunks

  • :next_token (String) —

    Pagination token

Returns:

See Also:



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

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

#list_objects(params = {}) ⇒ Types::ListObjectsOutput

List all Objects in a given Backup.

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_objects({
  storage_job_id: "string", # required
  starting_object_name: "string",
  starting_object_prefix: "string",
  max_results: 1,
  next_token: "string",
  created_before: Time.now,
  created_after: Time.now,
})

Response structure


resp.object_list #=> Array
resp.object_list[0].name #=> String
resp.object_list[0].chunks_count #=> Integer
resp.object_list[0].metadata_string #=> String
resp.object_list[0].object_checksum #=> String
resp.object_list[0].object_checksum_algorithm #=> String, one of "SUMMARY"
resp.object_list[0].object_token #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :storage_job_id (required, String) —

    Storage job id

  • :starting_object_name (String) —

    Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL

  • :starting_object_prefix (String) —

    Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL

  • :max_results (Integer) —

    Maximum objects count

  • :next_token (String) —

    Pagination token

  • :created_before (Time, DateTime, Date, Integer, String) — default: Optional —

    Created before filter

  • :created_after (Time, DateTime, Date, Integer, String) — default: Optional —

    Created after filter

Returns:

See Also:



588
589
590
591
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 588

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

#notify_object_complete(params = {}) ⇒ Types::NotifyObjectCompleteOutput

Complete upload

Examples:

Request syntax with placeholder values


resp = client.notify_object_complete({
  backup_job_id: "string", # required
  upload_id: "string", # required
  object_checksum: "string", # required
  object_checksum_algorithm: "SUMMARY", # required, accepts SUMMARY
  metadata_string: "MetadataString",
  metadata_blob: "data",
  metadata_blob_length: 1,
  metadata_blob_checksum: "string",
  metadata_blob_checksum_algorithm: "SHA256", # accepts SHA256
})

Response structure


resp.object_checksum #=> String
resp.object_checksum_algorithm #=> String, one of "SUMMARY"

Parameters:

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

    ({})

Options Hash (params):

  • :backup_job_id (required, String) —

    Backup job Id for the in-progress backup

  • :upload_id (required, String) —

    Upload Id for the in-progress upload

  • :object_checksum (required, String) —

    Object checksum

  • :object_checksum_algorithm (required, String) —

    Checksum algorithm

  • :metadata_string (String) —

    Optional metadata associated with an Object. Maximum string length is 256 bytes.

  • :metadata_blob (String, IO) —

    Optional metadata associated with an Object. Maximum length is 4MB.

  • :metadata_blob_length (Integer) —

    The size of MetadataBlob.

  • :metadata_blob_checksum (String) —

    Checksum of MetadataBlob.

  • :metadata_blob_checksum_algorithm (String) —

    Checksum algorithm.

Returns:

See Also:



651
652
653
654
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 651

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

#put_chunk(params = {}) ⇒ Types::PutChunkOutput

Upload chunk.

Examples:

Request syntax with placeholder values


resp = client.put_chunk({
  backup_job_id: "string", # required
  upload_id: "string", # required
  chunk_index: 1, # required
  data: "data", # required
  length: 1, # required
  checksum: "string", # required
  checksum_algorithm: "SHA256", # required, accepts SHA256
})

Response structure


resp.chunk_checksum #=> String
resp.chunk_checksum_algorithm #=> String, one of "SHA256"

Parameters:

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

    ({})

Options Hash (params):

  • :backup_job_id (required, String) —

    Backup job Id for the in-progress backup.

  • :upload_id (required, String) —

    Upload Id for the in-progress upload.

  • :chunk_index (required, Integer) —

    Describes this chunk's position relative to the other chunks

  • :data (required, String, IO) —

    Data to be uploaded

  • :length (required, Integer) —

    Data length

  • :checksum (required, String) —

    Data checksum

  • :checksum_algorithm (required, String) —

    Checksum algorithm

Returns:

See Also:



705
706
707
708
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 705

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

#put_object(params = {}) ⇒ Types::PutObjectOutput

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Examples:

Request syntax with placeholder values


resp = client.put_object({
  backup_job_id: "string", # required
  object_name: "string", # required
  metadata_string: "string",
  inline_chunk: "data",
  inline_chunk_length: 1,
  inline_chunk_checksum: "string",
  inline_chunk_checksum_algorithm: "string",
  object_checksum: "string",
  object_checksum_algorithm: "SUMMARY", # accepts SUMMARY
  throw_on_duplicate: false,
})

Response structure


resp.inline_chunk_checksum #=> String
resp.inline_chunk_checksum_algorithm #=> String, one of "SHA256"
resp.object_checksum #=> String
resp.object_checksum_algorithm #=> String, one of "SUMMARY"

Parameters:

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

    ({})

Options Hash (params):

  • :backup_job_id (required, String) —

    Backup job Id for the in-progress backup.

  • :object_name (required, String) —

    The name of the Object to be uploaded.

  • :metadata_string (String) —

    Store user defined metadata like backup checksum, disk ids, restore metadata etc.

  • :inline_chunk (String, IO) —

    Inline chunk data to be uploaded.

  • :inline_chunk_length (Integer) —

    Length of the inline chunk data.

  • :inline_chunk_checksum (String) —

    Inline chunk checksum

  • :inline_chunk_checksum_algorithm (String) —

    Inline chunk checksum algorithm

  • :object_checksum (String) —

    object checksum

  • :object_checksum_algorithm (String) —

    object checksum algorithm

  • :throw_on_duplicate (Boolean) —

    Throw an exception if Object name is already exist.

Returns:

See Also:



777
778
779
780
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 777

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

#start_object(params = {}) ⇒ Types::StartObjectOutput

Start upload containing one or many chunks.

Examples:

Request syntax with placeholder values


resp = client.start_object({
  backup_job_id: "string", # required
  object_name: "string", # required
  throw_on_duplicate: false,
})

Response structure


resp.upload_id #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :backup_job_id (required, String) —

    Backup job Id for the in-progress backup

  • :object_name (required, String) —

    Name for the object.

  • :throw_on_duplicate (Boolean) —

    Throw an exception if Object name is already exist.

Returns:

See Also:



813
814
815
816
 
# File 'gems/aws-sdk-backupstorage/lib/aws-sdk-backupstorage/client.rb', line 813

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