Class: Aws::BackupSearch::Client

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

Overview

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

client = Aws::BackupSearch::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.

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

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



471
472
473
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 471

def initialize(*args)
  super
end

Instance Method Details

#get_search_job(params = {}) ⇒ Types::GetSearchJobOutput

This operation retrieves metadata of a search job, including its progress.

Examples:

Request syntax with placeholder values


resp = client.get_search_job({
  search_job_identifier: "GenericId", # required
})

Response structure


resp.name #=> String
resp.search_scope_summary.total_recovery_points_to_scan_count #=> Integer
resp.search_scope_summary.total_items_to_scan_count #=> Integer
resp.current_search_progress.recovery_points_scanned_count #=> Integer
resp.current_search_progress.items_scanned_count #=> Integer
resp.current_search_progress.items_matched_count #=> Integer
resp.status_message #=> String
resp.encryption_key_arn #=> String
resp.completion_time #=> Time
resp.status #=> String, one of "RUNNING", "COMPLETED", "STOPPING", "STOPPED", "FAILED"
resp.search_scope.backup_resource_types #=> Array
resp.search_scope.backup_resource_types[0] #=> String, one of "S3", "EBS"
resp.search_scope.backup_resource_creation_time.created_after #=> Time
resp.search_scope.backup_resource_creation_time.created_before #=> Time
resp.search_scope.source_resource_arns #=> Array
resp.search_scope.source_resource_arns[0] #=> String
resp.search_scope.backup_resource_arns #=> Array
resp.search_scope.backup_resource_arns[0] #=> String
resp.search_scope.backup_resource_tags #=> Hash
resp.search_scope.backup_resource_tags["String"] #=> String
resp.item_filters.s3_item_filters #=> Array
resp.item_filters.s3_item_filters[0].object_keys #=> Array
resp.item_filters.s3_item_filters[0].object_keys[0].value #=> String
resp.item_filters.s3_item_filters[0].object_keys[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "CONTAINS", "DOES_NOT_CONTAIN", "BEGINS_WITH", "ENDS_WITH", "DOES_NOT_BEGIN_WITH", "DOES_NOT_END_WITH"
resp.item_filters.s3_item_filters[0].sizes #=> Array
resp.item_filters.s3_item_filters[0].sizes[0].value #=> Integer
resp.item_filters.s3_item_filters[0].sizes[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "LESS_THAN_EQUAL_TO", "GREATER_THAN_EQUAL_TO"
resp.item_filters.s3_item_filters[0].creation_times #=> Array
resp.item_filters.s3_item_filters[0].creation_times[0].value #=> Time
resp.item_filters.s3_item_filters[0].creation_times[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "LESS_THAN_EQUAL_TO", "GREATER_THAN_EQUAL_TO"
resp.item_filters.s3_item_filters[0].version_ids #=> Array
resp.item_filters.s3_item_filters[0].version_ids[0].value #=> String
resp.item_filters.s3_item_filters[0].version_ids[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "CONTAINS", "DOES_NOT_CONTAIN", "BEGINS_WITH", "ENDS_WITH", "DOES_NOT_BEGIN_WITH", "DOES_NOT_END_WITH"
resp.item_filters.s3_item_filters[0].etags #=> Array
resp.item_filters.s3_item_filters[0].etags[0].value #=> String
resp.item_filters.s3_item_filters[0].etags[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "CONTAINS", "DOES_NOT_CONTAIN", "BEGINS_WITH", "ENDS_WITH", "DOES_NOT_BEGIN_WITH", "DOES_NOT_END_WITH"
resp.item_filters.ebs_item_filters #=> Array
resp.item_filters.ebs_item_filters[0].file_paths #=> Array
resp.item_filters.ebs_item_filters[0].file_paths[0].value #=> String
resp.item_filters.ebs_item_filters[0].file_paths[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "CONTAINS", "DOES_NOT_CONTAIN", "BEGINS_WITH", "ENDS_WITH", "DOES_NOT_BEGIN_WITH", "DOES_NOT_END_WITH"
resp.item_filters.ebs_item_filters[0].sizes #=> Array
resp.item_filters.ebs_item_filters[0].sizes[0].value #=> Integer
resp.item_filters.ebs_item_filters[0].sizes[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "LESS_THAN_EQUAL_TO", "GREATER_THAN_EQUAL_TO"
resp.item_filters.ebs_item_filters[0].creation_times #=> Array
resp.item_filters.ebs_item_filters[0].creation_times[0].value #=> Time
resp.item_filters.ebs_item_filters[0].creation_times[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "LESS_THAN_EQUAL_TO", "GREATER_THAN_EQUAL_TO"
resp.item_filters.ebs_item_filters[0].last_modification_times #=> Array
resp.item_filters.ebs_item_filters[0].last_modification_times[0].value #=> Time
resp.item_filters.ebs_item_filters[0].last_modification_times[0].operator #=> String, one of "EQUALS_TO", "NOT_EQUALS_TO", "LESS_THAN_EQUAL_TO", "GREATER_THAN_EQUAL_TO"
resp.creation_time #=> Time
resp.search_job_identifier #=> String
resp.search_job_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_job_identifier (required, String) —

    Required unique string that specifies the search job.

Returns:

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 563

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

#get_search_result_export_job(params = {}) ⇒ Types::GetSearchResultExportJobOutput

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

Examples:

Request syntax with placeholder values


resp = client.get_search_result_export_job({
  export_job_identifier: "GenericId", # required
})

Response structure


resp.export_job_identifier #=> String
resp.export_job_arn #=> String
resp.status #=> String, one of "RUNNING", "FAILED", "COMPLETED"
resp.creation_time #=> Time
resp.completion_time #=> Time
resp.status_message #=> String
resp.export_specification.s3_export_specification.destination_bucket #=> String
resp.export_specification.s3_export_specification.destination_prefix #=> String
resp.search_job_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :export_job_identifier (required, String) —

    This is the unique string that identifies a specific export job.

    Required for this operation.

Returns:

See Also:



614
615
616
617
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 614

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

#list_search_job_backups(params = {}) ⇒ Types::ListSearchJobBackupsOutput

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

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_search_job_backups({
  search_job_identifier: "GenericId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.results #=> Array
resp.results[0].status #=> String, one of "RUNNING", "COMPLETED", "STOPPING", "STOPPED", "FAILED"
resp.results[0].status_message #=> String
resp.results[0].resource_type #=> String, one of "S3", "EBS"
resp.results[0].backup_resource_arn #=> String
resp.results[0].source_resource_arn #=> String
resp.results[0].index_creation_time #=> Time
resp.results[0].backup_creation_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_job_identifier (required, String) —

    The unique string that specifies the search job.

  • :next_token (String) —

    The next item following a partial list of returned backups included in a search job.

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

  • :max_results (Integer) —

    The maximum number of resource list items to be returned.

Returns:

See Also:



677
678
679
680
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 677

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

#list_search_job_results(params = {}) ⇒ Types::ListSearchJobResultsOutput

This operation returns a list of a specified search job.

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_search_job_results({
  search_job_identifier: "GenericId", # required
  next_token: "String",
  max_results: 1,
})

Response structure


resp.results #=> Array
resp.results[0].s3_result_item.backup_resource_arn #=> String
resp.results[0].s3_result_item.source_resource_arn #=> String
resp.results[0].s3_result_item.backup_vault_name #=> String
resp.results[0].s3_result_item.object_key #=> String
resp.results[0].s3_result_item.object_size #=> Integer
resp.results[0].s3_result_item.creation_time #=> Time
resp.results[0].s3_result_item.etag #=> String
resp.results[0].s3_result_item.version_id #=> String
resp.results[0].ebs_result_item.backup_resource_arn #=> String
resp.results[0].ebs_result_item.source_resource_arn #=> String
resp.results[0].ebs_result_item.backup_vault_name #=> String
resp.results[0].ebs_result_item.file_system_identifier #=> String
resp.results[0].ebs_result_item.file_path #=> String
resp.results[0].ebs_result_item.file_size #=> Integer
resp.results[0].ebs_result_item.creation_time #=> Time
resp.results[0].ebs_result_item.last_modified_time #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_job_identifier (required, String) —

    The unique string that specifies the search job.

  • :next_token (String) —

    The next item following a partial list of returned search job results.

    For example, if a request is made to return MaxResults number of search job results, NextToken allows you to return more items in your list starting at the location pointed to by the next token.

  • :max_results (Integer) —

    The maximum number of resource list items to be returned.

Returns:

See Also:



737
738
739
740
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 737

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

#list_search_jobs(params = {}) ⇒ Types::ListSearchJobsOutput

This operation returns a list of search jobs belonging to an 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_search_jobs({
  by_status: "RUNNING", # accepts RUNNING, COMPLETED, STOPPING, STOPPED, FAILED
  next_token: "String",
  max_results: 1,
})

Response structure


resp.search_jobs #=> Array
resp.search_jobs[0].search_job_identifier #=> String
resp.search_jobs[0].search_job_arn #=> String
resp.search_jobs[0].name #=> String
resp.search_jobs[0].status #=> String, one of "RUNNING", "COMPLETED", "STOPPING", "STOPPED", "FAILED"
resp.search_jobs[0].creation_time #=> Time
resp.search_jobs[0].completion_time #=> Time
resp.search_jobs[0].search_scope_summary.total_recovery_points_to_scan_count #=> Integer
resp.search_jobs[0].search_scope_summary.total_items_to_scan_count #=> Integer
resp.search_jobs[0].status_message #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :by_status (String) —

    Include this parameter to filter list by search job status.

  • :next_token (String) —

    The next item following a partial list of returned search jobs.

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

  • :max_results (Integer) —

    The maximum number of resource list items to be returned.

Returns:

See Also:



790
791
792
793
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 790

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

#list_search_result_export_jobs(params = {}) ⇒ Types::ListSearchResultExportJobsOutput

This operation exports search results of a search job to a specified destination S3 bucket.

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_search_result_export_jobs({
  status: "RUNNING", # accepts RUNNING, FAILED, COMPLETED
  search_job_identifier: "GenericId",
  next_token: "String",
  max_results: 1,
})

Response structure


resp.export_jobs #=> Array
resp.export_jobs[0].export_job_identifier #=> String
resp.export_jobs[0].export_job_arn #=> String
resp.export_jobs[0].status #=> String, one of "RUNNING", "FAILED", "COMPLETED"
resp.export_jobs[0].creation_time #=> Time
resp.export_jobs[0].completion_time #=> Time
resp.export_jobs[0].status_message #=> String
resp.export_jobs[0].search_job_arn #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :status (String) —

    The search jobs to be included in the export job can be filtered by including this parameter.

  • :search_job_identifier (String) —

    The unique string that specifies the search job.

  • :next_token (String) —

    The next item following a partial list of returned backups included in a search job.

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

  • :max_results (Integer) —

    The maximum number of resource list items to be returned.

Returns:

See Also:



848
849
850
851
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 848

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

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

This operation returns the tags for a resource type.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that uniquely identifies the resource.>

Returns:

See Also:



878
879
880
881
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 878

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

#start_search_job(params = {}) ⇒ Types::StartSearchJobOutput

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

Examples:

Request syntax with placeholder values


resp = client.start_search_job({
  tags: {
    "String" => "String",
  },
  name: "StartSearchJobInputNameString",
  encryption_key_arn: "EncryptionKeyArn",
  client_token: "String",
  search_scope: { # required
    backup_resource_types: ["S3"], # required, accepts S3, EBS
    backup_resource_creation_time: {
      created_after: Time.now,
      created_before: Time.now,
    },
    source_resource_arns: ["String"],
    backup_resource_arns: ["RecoveryPoint"],
    backup_resource_tags: {
      "String" => "String",
    },
  },
  item_filters: {
    s3_item_filters: [
      {
        object_keys: [
          {
            value: "String", # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, CONTAINS, DOES_NOT_CONTAIN, BEGINS_WITH, ENDS_WITH, DOES_NOT_BEGIN_WITH, DOES_NOT_END_WITH
          },
        ],
        sizes: [
          {
            value: 1, # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, LESS_THAN_EQUAL_TO, GREATER_THAN_EQUAL_TO
          },
        ],
        creation_times: [
          {
            value: Time.now, # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, LESS_THAN_EQUAL_TO, GREATER_THAN_EQUAL_TO
          },
        ],
        version_ids: [
          {
            value: "String", # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, CONTAINS, DOES_NOT_CONTAIN, BEGINS_WITH, ENDS_WITH, DOES_NOT_BEGIN_WITH, DOES_NOT_END_WITH
          },
        ],
        etags: [
          {
            value: "String", # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, CONTAINS, DOES_NOT_CONTAIN, BEGINS_WITH, ENDS_WITH, DOES_NOT_BEGIN_WITH, DOES_NOT_END_WITH
          },
        ],
      },
    ],
    ebs_item_filters: [
      {
        file_paths: [
          {
            value: "String", # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, CONTAINS, DOES_NOT_CONTAIN, BEGINS_WITH, ENDS_WITH, DOES_NOT_BEGIN_WITH, DOES_NOT_END_WITH
          },
        ],
        sizes: [
          {
            value: 1, # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, LESS_THAN_EQUAL_TO, GREATER_THAN_EQUAL_TO
          },
        ],
        creation_times: [
          {
            value: Time.now, # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, LESS_THAN_EQUAL_TO, GREATER_THAN_EQUAL_TO
          },
        ],
        last_modification_times: [
          {
            value: Time.now, # required
            operator: "EQUALS_TO", # accepts EQUALS_TO, NOT_EQUALS_TO, LESS_THAN_EQUAL_TO, GREATER_THAN_EQUAL_TO
          },
        ],
      },
    ],
  },
})

Response structure


resp.search_job_arn #=> String
resp.creation_time #=> Time
resp.search_job_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    List of tags returned by the operation.

  • :name (String) —

    Include alphanumeric characters to create a name for this search job.

  • :encryption_key_arn (String) —

    The encryption key for the specified search job.

  • :client_token (String) —

    Include this parameter to allow multiple identical calls for idempotency.

    A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

  • :search_scope (required, Types::SearchScope) —

    This object can contain BackupResourceTypes, BackupResourceArns, BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter the recovery points returned by the search job.

  • :item_filters (Types::ItemFilters) —

    Item Filters represent all input item properties specified when the search was created.

    Contains either EBSItemFilters or S3ItemFilters

Returns:

See Also:



1020
1021
1022
1023
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1020

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

#start_search_result_export_job(params = {}) ⇒ Types::StartSearchResultExportJobOutput

This operations starts a job to export the results of search job to a designated S3 bucket.

Examples:

Request syntax with placeholder values


resp = client.start_search_result_export_job({
  search_job_identifier: "GenericId", # required
  export_specification: { # required
    s3_export_specification: {
      destination_bucket: "String", # required
      destination_prefix: "String",
    },
  },
  client_token: "String",
  tags: {
    "String" => "String",
  },
  role_arn: "IamRoleArn",
})

Response structure


resp.export_job_arn #=> String
resp.export_job_identifier #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :search_job_identifier (required, String) —

    The unique string that specifies the search job.

  • :export_specification (required, Types::ExportSpecification) —

    This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

  • :client_token (String) —

    Include this parameter to allow multiple identical calls for idempotency.

    A client token is valid for 8 hours after the first request that uses it is completed. After this time, any request with the same token is treated as a new request.

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

    Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

  • :role_arn (String) —

    This parameter specifies the role ARN used to start the search results export jobs.

Returns:

See Also:



1084
1085
1086
1087
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1084

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

#stop_search_job(params = {}) ⇒ Struct

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

Examples:

Request syntax with placeholder values


resp = client.stop_search_job({
  search_job_identifier: "GenericId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :search_job_identifier (required, String) —

    The unique string that specifies the search job.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1108
1109
1110
1111
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1108

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

#tag_resource(params = {}) ⇒ Struct

This operation puts tags on the resource you indicate.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that uniquely identifies the resource.

    This is the resource that will have the indicated tags.

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

    Required tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1141
1142
1143
1144
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1141

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

#untag_resource(params = {}) ⇒ Struct

This operation removes tags from the specified resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) that uniquely identifies the resource where you want to remove tags.

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

    This required parameter contains the tag keys you want to remove from the source.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1169
1170
1171
1172
 
# File 'gems/aws-sdk-backupsearch/lib/aws-sdk-backupsearch/client.rb', line 1169

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