aws-sdk-go: github.com/aws/aws-sdk-go/service/mediastoredata Index | Files | Directories

package mediastoredata

import "github.com/aws/aws-sdk-go/service/mediastoredata"

Package mediastoredata provides the client and types for making API requests to AWS Elemental MediaStore Data Plane.

An AWS Elemental MediaStore asset is an object, similar to an object in the Amazon S3 service. Objects are the fundamental entities that are stored in AWS Elemental MediaStore.

See https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01 for more information on this service.

See mediastoredata package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/mediastoredata/

Using the Client

To contact AWS Elemental MediaStore Data Plane with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Elemental MediaStore Data Plane client MediaStoreData for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mediastoredata/#New

Index

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // ItemTypeObject is a ItemType enum value
    ItemTypeObject = "OBJECT"

    // ItemTypeFolder is a ItemType enum value
    ItemTypeFolder = "FOLDER"
)
const (
    // UploadAvailabilityStandard is a UploadAvailability enum value
    UploadAvailabilityStandard = "STANDARD"

    // UploadAvailabilityStreaming is a UploadAvailability enum value
    UploadAvailabilityStreaming = "STREAMING"
)
const (

    // ErrCodeContainerNotFoundException for service response error code
    // "ContainerNotFoundException".
    //
    // The specified container was not found for the specified account.
    ErrCodeContainerNotFoundException = "ContainerNotFoundException"

    // ErrCodeInternalServerError for service response error code
    // "InternalServerError".
    //
    // The service is temporarily unavailable.
    ErrCodeInternalServerError = "InternalServerError"

    // ErrCodeObjectNotFoundException for service response error code
    // "ObjectNotFoundException".
    //
    // Could not perform an operation on an object that does not exist.
    ErrCodeObjectNotFoundException = "ObjectNotFoundException"

    // ErrCodeRequestedRangeNotSatisfiableException for service response error code
    // "RequestedRangeNotSatisfiableException".
    //
    // The requested content range is not valid.
    ErrCodeRequestedRangeNotSatisfiableException = "RequestedRangeNotSatisfiableException"
)
const (
    ServiceName = "data.mediastore" // Name of service.
    EndpointsID = ServiceName       // ID to lookup a service endpoint with.
    ServiceID   = "MediaStore Data" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // StorageClassTemporal is a StorageClass enum value
    StorageClassTemporal = "TEMPORAL"
)

type DeleteObjectInput Uses

type DeleteObjectInput struct {

    // The path (including the file name) where the object is stored in the container.
    // Format: <folder name>/<folder name>/<file name>
    //
    // Path is a required field
    Path *string `location:"uri" locationName:"Path" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteObjectInput) GoString Uses

func (s DeleteObjectInput) GoString() string

GoString returns the string representation

func (*DeleteObjectInput) SetPath Uses

func (s *DeleteObjectInput) SetPath(v string) *DeleteObjectInput

SetPath sets the Path field's value.

func (DeleteObjectInput) String Uses

func (s DeleteObjectInput) String() string

String returns the string representation

func (*DeleteObjectInput) Validate Uses

func (s *DeleteObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteObjectOutput Uses

type DeleteObjectOutput struct {
    // contains filtered or unexported fields
}

func (DeleteObjectOutput) GoString Uses

func (s DeleteObjectOutput) GoString() string

GoString returns the string representation

func (DeleteObjectOutput) String Uses

func (s DeleteObjectOutput) String() string

String returns the string representation

type DescribeObjectInput Uses

type DescribeObjectInput struct {

    // The path (including the file name) where the object is stored in the container.
    // Format: <folder name>/<folder name>/<file name>
    //
    // Path is a required field
    Path *string `location:"uri" locationName:"Path" min:"1" type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DescribeObjectInput) GoString Uses

func (s DescribeObjectInput) GoString() string

GoString returns the string representation

func (*DescribeObjectInput) SetPath Uses

func (s *DescribeObjectInput) SetPath(v string) *DescribeObjectInput

SetPath sets the Path field's value.

func (DescribeObjectInput) String Uses

func (s DescribeObjectInput) String() string

String returns the string representation

func (*DescribeObjectInput) Validate Uses

func (s *DescribeObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeObjectOutput Uses

type DescribeObjectOutput struct {

    // 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
    // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
    //
    // Headers with a custom user-defined value are also accepted.
    CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

    // The length of the object in bytes.
    ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

    // The content type of the object.
    ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

    // The ETag that represents a unique instance of the object.
    ETag *string `location:"header" locationName:"ETag" min:"1" type:"string"`

    // The date and time that the object was last modified.
    LastModified *time.Time `location:"header" locationName:"Last-Modified" type:"timestamp"`
    // contains filtered or unexported fields
}

func (DescribeObjectOutput) GoString Uses

func (s DescribeObjectOutput) GoString() string

GoString returns the string representation

func (*DescribeObjectOutput) SetCacheControl Uses

func (s *DescribeObjectOutput) SetCacheControl(v string) *DescribeObjectOutput

SetCacheControl sets the CacheControl field's value.

func (*DescribeObjectOutput) SetContentLength Uses

func (s *DescribeObjectOutput) SetContentLength(v int64) *DescribeObjectOutput

SetContentLength sets the ContentLength field's value.

func (*DescribeObjectOutput) SetContentType Uses

func (s *DescribeObjectOutput) SetContentType(v string) *DescribeObjectOutput

SetContentType sets the ContentType field's value.

func (*DescribeObjectOutput) SetETag Uses

func (s *DescribeObjectOutput) SetETag(v string) *DescribeObjectOutput

SetETag sets the ETag field's value.

func (*DescribeObjectOutput) SetLastModified Uses

func (s *DescribeObjectOutput) SetLastModified(v time.Time) *DescribeObjectOutput

SetLastModified sets the LastModified field's value.

func (DescribeObjectOutput) String Uses

func (s DescribeObjectOutput) String() string

String returns the string representation

type GetObjectInput Uses

type GetObjectInput struct {

    // 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 (http://docs.aws.amazon.com/mediastore/latest/ug/).
    //
    // 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.
    //
    // Path is a required field
    Path *string `location:"uri" locationName:"Path" min:"1" type:"string" required:"true"`

    // 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
    // (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.
    Range *string `location:"header" locationName:"Range" type:"string"`
    // contains filtered or unexported fields
}

func (GetObjectInput) GoString Uses

func (s GetObjectInput) GoString() string

GoString returns the string representation

func (*GetObjectInput) SetPath Uses

func (s *GetObjectInput) SetPath(v string) *GetObjectInput

SetPath sets the Path field's value.

func (*GetObjectInput) SetRange Uses

func (s *GetObjectInput) SetRange(v string) *GetObjectInput

SetRange sets the Range field's value.

func (GetObjectInput) String Uses

func (s GetObjectInput) String() string

String returns the string representation

func (*GetObjectInput) Validate Uses

func (s *GetObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectOutput Uses

type GetObjectOutput struct {

    // The bytes of the object.
    Body io.ReadCloser `type:"blob"`

    // 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 (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
    //
    // Headers with a custom user-defined value are also accepted.
    CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

    // The length of the object in bytes.
    ContentLength *int64 `location:"header" locationName:"Content-Length" type:"long"`

    // The range of bytes to retrieve.
    ContentRange *string `location:"header" locationName:"Content-Range" type:"string"`

    // The content type of the object.
    ContentType *string `location:"header" locationName:"Content-Type" type:"string"`

    // The ETag that represents a unique instance of the object.
    ETag *string `location:"header" locationName:"ETag" min:"1" type:"string"`

    // The date and time that the object was last modified.
    LastModified *time.Time `location:"header" locationName:"Last-Modified" type:"timestamp"`

    // 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.
    //
    // StatusCode is a required field
    StatusCode *int64 `location:"statusCode" type:"integer" required:"true"`
    // contains filtered or unexported fields
}

func (GetObjectOutput) GoString Uses

func (s GetObjectOutput) GoString() string

GoString returns the string representation

func (*GetObjectOutput) SetBody Uses

func (s *GetObjectOutput) SetBody(v io.ReadCloser) *GetObjectOutput

SetBody sets the Body field's value.

func (*GetObjectOutput) SetCacheControl Uses

func (s *GetObjectOutput) SetCacheControl(v string) *GetObjectOutput

SetCacheControl sets the CacheControl field's value.

func (*GetObjectOutput) SetContentLength Uses

func (s *GetObjectOutput) SetContentLength(v int64) *GetObjectOutput

SetContentLength sets the ContentLength field's value.

func (*GetObjectOutput) SetContentRange Uses

func (s *GetObjectOutput) SetContentRange(v string) *GetObjectOutput

SetContentRange sets the ContentRange field's value.

func (*GetObjectOutput) SetContentType Uses

func (s *GetObjectOutput) SetContentType(v string) *GetObjectOutput

SetContentType sets the ContentType field's value.

func (*GetObjectOutput) SetETag Uses

func (s *GetObjectOutput) SetETag(v string) *GetObjectOutput

SetETag sets the ETag field's value.

func (*GetObjectOutput) SetLastModified Uses

func (s *GetObjectOutput) SetLastModified(v time.Time) *GetObjectOutput

SetLastModified sets the LastModified field's value.

func (*GetObjectOutput) SetStatusCode Uses

func (s *GetObjectOutput) SetStatusCode(v int64) *GetObjectOutput

SetStatusCode sets the StatusCode field's value.

func (GetObjectOutput) String Uses

func (s GetObjectOutput) String() string

String returns the string representation

type Item Uses

type Item struct {

    // The length of the item in bytes.
    ContentLength *int64 `type:"long"`

    // The content type of the item.
    ContentType *string `type:"string"`

    // The ETag that represents a unique instance of the item.
    ETag *string `min:"1" type:"string"`

    // The date and time that the item was last modified.
    LastModified *time.Time `type:"timestamp"`

    // The name of the item.
    Name *string `type:"string"`

    // The item type (folder or object).
    Type *string `type:"string" enum:"ItemType"`
    // contains filtered or unexported fields
}

A metadata entry for a folder or object.

func (Item) GoString Uses

func (s Item) GoString() string

GoString returns the string representation

func (*Item) SetContentLength Uses

func (s *Item) SetContentLength(v int64) *Item

SetContentLength sets the ContentLength field's value.

func (*Item) SetContentType Uses

func (s *Item) SetContentType(v string) *Item

SetContentType sets the ContentType field's value.

func (*Item) SetETag Uses

func (s *Item) SetETag(v string) *Item

SetETag sets the ETag field's value.

func (*Item) SetLastModified Uses

func (s *Item) SetLastModified(v time.Time) *Item

SetLastModified sets the LastModified field's value.

func (*Item) SetName Uses

func (s *Item) SetName(v string) *Item

SetName sets the Name field's value.

func (*Item) SetType Uses

func (s *Item) SetType(v string) *Item

SetType sets the Type field's value.

func (Item) String Uses

func (s Item) String() string

String returns the string representation

type ListItemsInput Uses

type ListItemsInput struct {

    // 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.
    MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

    // 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.
    NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

    // The path in the container from which to retrieve items. Format: <folder name>/<folder
    // name>/<file name>
    Path *string `location:"querystring" locationName:"Path" type:"string"`
    // contains filtered or unexported fields
}

func (ListItemsInput) GoString Uses

func (s ListItemsInput) GoString() string

GoString returns the string representation

func (*ListItemsInput) SetMaxResults Uses

func (s *ListItemsInput) SetMaxResults(v int64) *ListItemsInput

SetMaxResults sets the MaxResults field's value.

func (*ListItemsInput) SetNextToken Uses

func (s *ListItemsInput) SetNextToken(v string) *ListItemsInput

SetNextToken sets the NextToken field's value.

func (*ListItemsInput) SetPath Uses

func (s *ListItemsInput) SetPath(v string) *ListItemsInput

SetPath sets the Path field's value.

func (ListItemsInput) String Uses

func (s ListItemsInput) String() string

String returns the string representation

func (*ListItemsInput) Validate Uses

func (s *ListItemsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListItemsOutput Uses

type ListItemsOutput struct {

    // The metadata entries for the folders and objects at the requested path.
    Items []*Item `type:"list"`

    // 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.
    NextToken *string `type:"string"`
    // contains filtered or unexported fields
}

func (ListItemsOutput) GoString Uses

func (s ListItemsOutput) GoString() string

GoString returns the string representation

func (*ListItemsOutput) SetItems Uses

func (s *ListItemsOutput) SetItems(v []*Item) *ListItemsOutput

SetItems sets the Items field's value.

func (*ListItemsOutput) SetNextToken Uses

func (s *ListItemsOutput) SetNextToken(v string) *ListItemsOutput

SetNextToken sets the NextToken field's value.

func (ListItemsOutput) String Uses

func (s ListItemsOutput) String() string

String returns the string representation

type MediaStoreData Uses

type MediaStoreData struct {
    *client.Client
}

MediaStoreData provides the API operation methods for making requests to AWS Elemental MediaStore Data Plane. See this package's package overview docs for details on the service.

MediaStoreData methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *MediaStoreData

New creates a new instance of the MediaStoreData client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a MediaStoreData client from just a session.
svc := mediastoredata.New(mySession)

// Create a MediaStoreData client with additional configuration
svc := mediastoredata.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*MediaStoreData) DeleteObject Uses

func (c *MediaStoreData) DeleteObject(input *DeleteObjectInput) (*DeleteObjectOutput, error)

DeleteObject API operation for AWS Elemental MediaStore Data Plane.

Deletes an object at the specified path.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elemental MediaStore Data Plane's API operation DeleteObject for usage and error information.

Returned Error Codes:

* ErrCodeContainerNotFoundException "ContainerNotFoundException"
The specified container was not found for the specified account.

* ErrCodeObjectNotFoundException "ObjectNotFoundException"
Could not perform an operation on an object that does not exist.

* ErrCodeInternalServerError "InternalServerError"
The service is temporarily unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/DeleteObject

func (*MediaStoreData) DeleteObjectRequest Uses

func (c *MediaStoreData) DeleteObjectRequest(input *DeleteObjectInput) (req *request.Request, output *DeleteObjectOutput)

DeleteObjectRequest generates a "aws/request.Request" representing the client's request for the DeleteObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteObject for more information on using the DeleteObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteObjectRequest method.
req, resp := client.DeleteObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/DeleteObject

func (*MediaStoreData) DeleteObjectWithContext Uses

func (c *MediaStoreData) DeleteObjectWithContext(ctx aws.Context, input *DeleteObjectInput, opts ...request.Option) (*DeleteObjectOutput, error)

DeleteObjectWithContext is the same as DeleteObject with the addition of the ability to pass a context and additional request options.

See DeleteObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaStoreData) DescribeObject Uses

func (c *MediaStoreData) DescribeObject(input *DescribeObjectInput) (*DescribeObjectOutput, error)

DescribeObject API operation for AWS Elemental MediaStore Data Plane.

Gets the headers for an object at the specified path.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elemental MediaStore Data Plane's API operation DescribeObject for usage and error information.

Returned Error Codes:

* ErrCodeContainerNotFoundException "ContainerNotFoundException"
The specified container was not found for the specified account.

* ErrCodeObjectNotFoundException "ObjectNotFoundException"
Could not perform an operation on an object that does not exist.

* ErrCodeInternalServerError "InternalServerError"
The service is temporarily unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/DescribeObject

func (*MediaStoreData) DescribeObjectRequest Uses

func (c *MediaStoreData) DescribeObjectRequest(input *DescribeObjectInput) (req *request.Request, output *DescribeObjectOutput)

DescribeObjectRequest generates a "aws/request.Request" representing the client's request for the DescribeObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeObject for more information on using the DescribeObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeObjectRequest method.
req, resp := client.DescribeObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/DescribeObject

func (*MediaStoreData) DescribeObjectWithContext Uses

func (c *MediaStoreData) DescribeObjectWithContext(ctx aws.Context, input *DescribeObjectInput, opts ...request.Option) (*DescribeObjectOutput, error)

DescribeObjectWithContext is the same as DescribeObject with the addition of the ability to pass a context and additional request options.

See DescribeObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaStoreData) GetObject Uses

func (c *MediaStoreData) GetObject(input *GetObjectInput) (*GetObjectOutput, error)

GetObject API operation for AWS Elemental MediaStore Data Plane.

Downloads the object at the specified path. If the object’s upload availability is set to streaming, AWS Elemental MediaStore downloads the object even if it’s still uploading the object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elemental MediaStore Data Plane's API operation GetObject for usage and error information.

Returned Error Codes:

* ErrCodeContainerNotFoundException "ContainerNotFoundException"
The specified container was not found for the specified account.

* ErrCodeObjectNotFoundException "ObjectNotFoundException"
Could not perform an operation on an object that does not exist.

* ErrCodeRequestedRangeNotSatisfiableException "RequestedRangeNotSatisfiableException"
The requested content range is not valid.

* ErrCodeInternalServerError "InternalServerError"
The service is temporarily unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/GetObject

func (*MediaStoreData) GetObjectRequest Uses

func (c *MediaStoreData) GetObjectRequest(input *GetObjectInput) (req *request.Request, output *GetObjectOutput)

GetObjectRequest generates a "aws/request.Request" representing the client's request for the GetObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetObject for more information on using the GetObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetObjectRequest method.
req, resp := client.GetObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/GetObject

func (*MediaStoreData) GetObjectWithContext Uses

func (c *MediaStoreData) GetObjectWithContext(ctx aws.Context, input *GetObjectInput, opts ...request.Option) (*GetObjectOutput, error)

GetObjectWithContext is the same as GetObject with the addition of the ability to pass a context and additional request options.

See GetObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaStoreData) ListItems Uses

func (c *MediaStoreData) ListItems(input *ListItemsInput) (*ListItemsOutput, error)

ListItems API operation for AWS Elemental MediaStore Data Plane.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elemental MediaStore Data Plane's API operation ListItems for usage and error information.

Returned Error Codes:

* ErrCodeContainerNotFoundException "ContainerNotFoundException"
The specified container was not found for the specified account.

* ErrCodeInternalServerError "InternalServerError"
The service is temporarily unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/ListItems

func (*MediaStoreData) ListItemsPages Uses

func (c *MediaStoreData) ListItemsPages(input *ListItemsInput, fn func(*ListItemsOutput, bool) bool) error

ListItemsPages iterates over the pages of a ListItems operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListItems method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListItems operation.
pageNum := 0
err := client.ListItemsPages(params,
    func(page *mediastoredata.ListItemsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*MediaStoreData) ListItemsPagesWithContext Uses

func (c *MediaStoreData) ListItemsPagesWithContext(ctx aws.Context, input *ListItemsInput, fn func(*ListItemsOutput, bool) bool, opts ...request.Option) error

ListItemsPagesWithContext same as ListItemsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaStoreData) ListItemsRequest Uses

func (c *MediaStoreData) ListItemsRequest(input *ListItemsInput) (req *request.Request, output *ListItemsOutput)

ListItemsRequest generates a "aws/request.Request" representing the client's request for the ListItems operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListItems for more information on using the ListItems API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListItemsRequest method.
req, resp := client.ListItemsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/ListItems

func (*MediaStoreData) ListItemsWithContext Uses

func (c *MediaStoreData) ListItemsWithContext(ctx aws.Context, input *ListItemsInput, opts ...request.Option) (*ListItemsOutput, error)

ListItemsWithContext is the same as ListItems with the addition of the ability to pass a context and additional request options.

See ListItems for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*MediaStoreData) PutObject Uses

func (c *MediaStoreData) PutObject(input *PutObjectInput) (*PutObjectOutput, error)

PutObject API operation for AWS Elemental MediaStore Data Plane.

Uploads an object to the specified path. Object sizes are limited to 25 MB for standard upload availability and 10 MB for streaming upload availability.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Elemental MediaStore Data Plane's API operation PutObject for usage and error information.

Returned Error Codes:

* ErrCodeContainerNotFoundException "ContainerNotFoundException"
The specified container was not found for the specified account.

* ErrCodeInternalServerError "InternalServerError"
The service is temporarily unavailable.

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/PutObject

func (*MediaStoreData) PutObjectRequest Uses

func (c *MediaStoreData) PutObjectRequest(input *PutObjectInput) (req *request.Request, output *PutObjectOutput)

PutObjectRequest generates a "aws/request.Request" representing the client's request for the PutObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutObject for more information on using the PutObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutObjectRequest method.
req, resp := client.PutObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/mediastore-data-2017-09-01/PutObject

func (*MediaStoreData) PutObjectWithContext Uses

func (c *MediaStoreData) PutObjectWithContext(ctx aws.Context, input *PutObjectInput, opts ...request.Option) (*PutObjectOutput, error)

PutObjectWithContext is the same as PutObject with the addition of the ability to pass a context and additional request options.

See PutObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PutObjectInput Uses

type PutObjectInput struct {

    // The bytes to be stored.
    //
    // To use an non-seekable io.Reader for this request wrap the io.Reader with
    // "aws.ReadSeekCloser". The SDK will not retry request errors for non-seekable
    // readers. This will allow the SDK to send the reader's payload as chunked
    // transfer encoding.
    //
    // Body is a required field
    Body io.ReadSeeker `type:"blob" required:"true"`

    // 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
    // (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9).
    //
    // Headers with a custom user-defined value are also accepted.
    CacheControl *string `location:"header" locationName:"Cache-Control" type:"string"`

    // The content type of the object.
    ContentType *string `location:"header" locationName:"Content-Type" type:"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 (http://docs.aws.amazon.com/mediastore/latest/ug/).
    //
    // 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.
    //
    // Path is a required field
    Path *string `location:"uri" locationName:"Path" min:"1" type:"string" required:"true"`

    // 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.
    StorageClass *string `location:"header" locationName:"x-amz-storage-class" min:"1" type:"string" enum:"StorageClass"`

    // 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.
    UploadAvailability *string `location:"header" locationName:"x-amz-upload-availability" min:"1" type:"string" enum:"UploadAvailability"`
    // contains filtered or unexported fields
}

func (PutObjectInput) GoString Uses

func (s PutObjectInput) GoString() string

GoString returns the string representation

func (*PutObjectInput) SetBody Uses

func (s *PutObjectInput) SetBody(v io.ReadSeeker) *PutObjectInput

SetBody sets the Body field's value.

func (*PutObjectInput) SetCacheControl Uses

func (s *PutObjectInput) SetCacheControl(v string) *PutObjectInput

SetCacheControl sets the CacheControl field's value.

func (*PutObjectInput) SetContentType Uses

func (s *PutObjectInput) SetContentType(v string) *PutObjectInput

SetContentType sets the ContentType field's value.

func (*PutObjectInput) SetPath Uses

func (s *PutObjectInput) SetPath(v string) *PutObjectInput

SetPath sets the Path field's value.

func (*PutObjectInput) SetStorageClass Uses

func (s *PutObjectInput) SetStorageClass(v string) *PutObjectInput

SetStorageClass sets the StorageClass field's value.

func (*PutObjectInput) SetUploadAvailability Uses

func (s *PutObjectInput) SetUploadAvailability(v string) *PutObjectInput

SetUploadAvailability sets the UploadAvailability field's value.

func (PutObjectInput) String Uses

func (s PutObjectInput) String() string

String returns the string representation

func (*PutObjectInput) Validate Uses

func (s *PutObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutObjectOutput Uses

type PutObjectOutput struct {

    // The SHA256 digest of the object that is persisted.
    ContentSHA256 *string `min:"64" type:"string"`

    // Unique identifier of the object in the container.
    ETag *string `min:"1" type:"string"`

    // The storage class where the object was persisted. The class should be “Temporal”.
    StorageClass *string `min:"1" type:"string" enum:"StorageClass"`
    // contains filtered or unexported fields
}

func (PutObjectOutput) GoString Uses

func (s PutObjectOutput) GoString() string

GoString returns the string representation

func (*PutObjectOutput) SetContentSHA256 Uses

func (s *PutObjectOutput) SetContentSHA256(v string) *PutObjectOutput

SetContentSHA256 sets the ContentSHA256 field's value.

func (*PutObjectOutput) SetETag Uses

func (s *PutObjectOutput) SetETag(v string) *PutObjectOutput

SetETag sets the ETag field's value.

func (*PutObjectOutput) SetStorageClass Uses

func (s *PutObjectOutput) SetStorageClass(v string) *PutObjectOutput

SetStorageClass sets the StorageClass field's value.

func (PutObjectOutput) String Uses

func (s PutObjectOutput) String() string

String returns the string representation

Directories

PathSynopsis
mediastoredataifacePackage mediastoredataiface provides an interface to enable mocking the AWS Elemental MediaStore Data Plane service client for testing your code.

Package mediastoredata imports 10 packages (graph) and is imported by 19 packages. Updated 2019-06-03. Refresh now. Tools for package owners.