Struct Client

pub struct Client { /* private fields */ }

Client for AWS Elemental MediaStore Data Plane

Client for invoking operations on AWS Elemental MediaStore Data Plane. Each operation on AWS Elemental MediaStore Data Plane is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_mediastoredata::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_mediastoredata::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the DeleteObject operation has a Client::delete_object, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.delete_object()
    .path("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn delete_object(&self) -> DeleteObjectFluentBuilder

Constructs a fluent builder for the DeleteObject operation.

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>):
    required: true
    

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

    
    
• On success, responds with DeleteObjectOutput
• On failure, responds with SdkError<DeleteObjectError>

impl Client

pub fn describe_object(&self) -> DescribeObjectFluentBuilder

Constructs a fluent builder for the DescribeObject operation.

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>):
    required: true
    

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

    
    
• On success, responds with DescribeObjectOutput with field(s):
  • e_tag(Option<String>):

    The ETag that represents a unique instance of the object.

  • content_type(Option<String>):

    The content type of the object.

  • content_length(Option<i64>):

    The length of the object in bytes.

  • cache_control(Option<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.

  • last_modified(Option<DateTime>):

    The date and time that the object was last modified.

• On failure, responds with SdkError<DescribeObjectError>

impl Client

pub fn get_object(&self) -> GetObjectFluentBuilder

Constructs a fluent builder for the GetObject operation.

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>):
    required: true
    

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

    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(impl Into<String>) / set_range(Option<String>):
    required: false
    

    The range bytes of an object to retrieve. For more information about the Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35. AWS Elemental MediaStore ignores this header for partially uploaded objects that have streaming upload availability.

    
    
• On success, responds with GetObjectOutput with field(s):
  • body(ByteStream):

    The bytes of the object.

  • cache_control(Option<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 spec at https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

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

  • content_range(Option<String>):

    The range of bytes to retrieve.

  • content_length(Option<i64>):

    The length of the object in bytes.

  • content_type(Option<String>):

    The content type of the object.

  • e_tag(Option<String>):

    The ETag that represents a unique instance of the object.

  • last_modified(Option<DateTime>):

    The date and time that the object was last modified.

  • status_code(i32):

    The HTML status code of the request. Status codes ranging from 200 to 299 indicate success. All other status codes indicate the type of error that occurred.

• On failure, responds with SdkError<GetObjectError>

impl Client

pub fn list_items(&self) -> ListItemsFluentBuilder

Constructs a fluent builder for the ListItems operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • path(impl Into<String>) / set_path(Option<String>):
    required: false
    

    The path in the container from which to retrieve items. Format: / /

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    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(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    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.

    
    
• On success, responds with ListItemsOutput with field(s):
  • items(Option<Vec::<Item>>):

    The metadata entries for the folders and objects at the requested path.

  • next_token(Option<String>):

    The token that can be used in a request to view the next set of results. For example, you submit a ListItems request that matches 2,000 items with MaxResults set at 500. The service returns the first batch of results (up to 500) and a NextToken value that can be used to fetch the next batch of results.

• On failure, responds with SdkError<ListItemsError>

impl Client

pub fn put_object(&self) -> PutObjectFluentBuilder

Constructs a fluent builder for the PutObject operation.

• The fluent builder is configurable:
  • body(ByteStream) / set_body(ByteStream):
    required: true
    

    The bytes to be stored.

    
    
  • path(impl Into<String>) / set_path(Option<String>):
    required: true
    

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

    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(impl Into<String>) / set_content_type(Option<String>):
    required: false
    

    The content type of the object.

    
    
  • cache_control(impl Into<String>) / set_cache_control(Option<String>):
    required: false
    

    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(StorageClass) / set_storage_class(Option<StorageClass>):
    required: false
    

    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.

    
    
  • upload_availability(UploadAvailability) / set_upload_availability(Option<UploadAvailability>):
    required: false
    

    Indicates the availability of an object while it is still uploading. If the value is set to streaming, the object is available for downloading after some initial buffering but before the object is uploaded completely. If the value is set to standard, the object is available for downloading only when it is uploaded completely. The default value for this header is standard.

    To use this header, you must also set the HTTP Transfer-Encoding header to chunked.

    
    
• On success, responds with PutObjectOutput with field(s):
  • content_sha256(Option<String>):

    The SHA256 digest of the object that is persisted.

  • e_tag(Option<String>):

    Unique identifier of the object in the container.

  • storage_class(Option<StorageClass>):

    The storage class where the object was persisted. The class should be “Temporal”.

• On failure, responds with SdkError<PutObjectError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.