You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::MediaStoreData::Client

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

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::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

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

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

    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 IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentails to enable retries and extended timeouts.
  • :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 search 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.

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

  • :endpoint (String)

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test endpoints. This should be avalid 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. Defaults to false.

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

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

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

  • :retry_base_delay (Float) — default: 0.3

    The base delay in seconds used by the default backoff function.

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

    @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 and auth errors from expired credentials.

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

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

  • :validate_params (Boolean) — default: true

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



196
197
198
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 196

def initialize(*args)
  super
end

Instance Method Details

#delete_object(params = {}) ⇒ Struct

Deletes an object at the specified path.

Examples:

Request syntax with placeholder values


resp = client.delete_object({
  path: "PathNaming", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :path (required, String)

    The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

Returns:

  • (Struct)

    Returns an empty response.

See Also:



221
222
223
224
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 221

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

#describe_object(params = {}) ⇒ Types::DescribeObjectResponse

Gets the headers for an object at the specified path.

Examples:

Request syntax with placeholder values


resp = client.describe_object({
  path: "PathNaming", # required
})

Response structure


resp.etag #=> String
resp.content_type #=> String
resp.content_length #=> Integer
resp.cache_control #=> String
resp.last_modified #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :path (required, String)

    The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

Returns:

See Also:



259
260
261
262
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 259

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

#get_object(params = {}) ⇒ Types::GetObjectResponse

Downloads the object at the specified path.

Examples:

Request syntax with placeholder values


resp = client.get_object({
  path: "PathNaming", # required
  range: "RangePattern",
})

Response structure


resp.body #=> IO
resp.cache_control #=> String
resp.content_range #=> String
resp.content_length #=> Integer
resp.content_type #=> String
resp.etag #=> String
resp.last_modified #=> Time
resp.status_code #=> Integer

Parameters:

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

    ({})

Options Hash (params):

  • :path (required, String)

    The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

    For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

    Do not include the container name in this path.

    If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

    There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

    For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

    The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

  • :range (String)

    The range bytes of an object to retrieve. For more information about the Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Returns:

See Also:



340
341
342
343
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 340

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

#list_items(params = {}) ⇒ Types::ListItemsResponse

Provides a list of metadata entries about folders and objects in the specified folder.

Examples:

Request syntax with placeholder values


resp = client.list_items({
  path: "ListPathNaming",
  max_results: 1,
  next_token: "PaginationToken",
})

Response structure


resp.items #=> Array
resp.items[0].name #=> String
resp.items[0].type #=> String, one of "OBJECT", "FOLDER"
resp.items[0].etag #=> String
resp.items[0].last_modified #=> Time
resp.items[0].content_type #=> String
resp.items[0].content_length #=> Integer
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :path (String)

    The path in the container from which to retrieve items. Format: <folder name>/<folder name>/<file name>

  • :max_results (Integer)

    The maximum number of results to return per API request. For example, you submit a ListItems request with MaxResults set at 500. Although 2,000 items match your request, the service returns no more than the first 500 items. (The service also returns a NextToken value that you can use to fetch the next batch of results.) The service might return fewer results than the MaxResults value.

    If MaxResults is not included in the request, the service defaults to pagination with a maximum of 1,000 results per page.

  • :next_token (String)

    The token that identifies which batch of results that you want to see. For example, you submit a ListItems request with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value. To see the next batch of results, you can submit the ListItems request a second time and specify the NextToken value.

    Tokens expire after 15 minutes.

Returns:

See Also:



401
402
403
404
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 401

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

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

Uploads an object to the specified path. Object sizes are limited to 25 MB.

Examples:

Request syntax with placeholder values


resp = client.put_object({
  body: "data", # required
  path: "PathNaming", # required
  content_type: "ContentType",
  cache_control: "StringPrimitive",
  storage_class: "TEMPORAL", # accepts TEMPORAL
})

Response structure


resp.content_sha256 #=> String
resp.etag #=> String
resp.storage_class #=> String, one of "TEMPORAL"

Parameters:

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

    ({})

Options Hash (params):

  • :body (required, String, IO)

    The bytes to be stored.

  • :path (required, String)

    The path (including the file name) where the object is stored in the container. Format: <folder name>/<folder name>/<file name>

    For example, to upload the file mlaw.avi to the folder path premium\canada in the container movies, enter the path premium/canada/mlaw.avi.

    Do not include the container name in this path.

    If the path includes any folders that don't exist yet, the service creates them. For example, suppose you have an existing premium/usa subfolder. If you specify premium/canada, the service creates a canada subfolder in the premium folder. You then have two subfolders, usa and canada, in the premium folder.

    There is no correlation between the path to the source and the path (folders) in the container in AWS Elemental MediaStore.

    For more information about folders and how they exist in a container, see the AWS Elemental MediaStore User Guide.

    The file name is the name that is assigned to the file that you upload. The file can have the same name inside and outside of AWS Elemental MediaStore, or it can have the same name. The file name can include or omit an extension.

  • :content_type (String)

    The content type of the object.

  • :cache_control (String)

    An optional CacheControl header that allows the caller to control the object's cache behavior. Headers can be passed in as specified in the HTTP at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

    Headers with a custom user-defined value are also accepted.

  • :storage_class (String)

    Indicates the storage class of a Put request. Defaults to high-performance temporal storage class, and objects are persisted into durable storage shortly after being received.

Returns:

See Also:



490
491
492
493
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/client.rb', line 490

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