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

Class: Aws::MediaStoreData::Types::PutObjectRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb

Overview

Note:

When making an API call, you may pass PutObjectRequest data as a hash:

{
  body: "data", # required
  path: "PathNaming", # required
  content_type: "ContentType",
  cache_control: "StringPrimitive",
  storage_class: "TEMPORAL", # accepts TEMPORAL
}

Instance Attribute Summary collapse

Instance Attribute Details

#bodyIO

The bytes to be stored.

Returns:

  • (IO)


374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb', line 374

class PutObjectRequest < Struct.new(
  :body,
  :path,
  :content_type,
  :cache_control,
  :storage_class)
  include Aws::Structure
end

#cache_controlString

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.

Returns:

  • (String)


374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb', line 374

class PutObjectRequest < Struct.new(
  :body,
  :path,
  :content_type,
  :cache_control,
  :storage_class)
  include Aws::Structure
end

#content_typeString

The content type of the object.

Returns:

  • (String)


374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb', line 374

class PutObjectRequest < Struct.new(
  :body,
  :path,
  :content_type,
  :cache_control,
  :storage_class)
  include Aws::Structure
end

#pathString

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.

Returns:

  • (String)


374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb', line 374

class PutObjectRequest < Struct.new(
  :body,
  :path,
  :content_type,
  :cache_control,
  :storage_class)
  include Aws::Structure
end

#storage_classString

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:

  • (String)


374
375
376
377
378
379
380
381
# File 'gems/aws-sdk-mediastoredata/lib/aws-sdk-mediastoredata/types.rb', line 374

class PutObjectRequest < Struct.new(
  :body,
  :path,
  :content_type,
  :cache_control,
  :storage_class)
  include Aws::Structure
end