mediastoredata

package
v1.48.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

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

Examples

Constants

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

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

	// UploadAvailabilityStreaming is a UploadAvailability enum value
	UploadAvailabilityStreaming = "STREAMING"
)
View Source 
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"
)
View Source 
const (
	ServiceName = "data.mediastore" // Name of service.
	EndpointsID = ServiceName       // ID to lookup a service endpoint with.
	ServiceID   = "MediaStore Data" // ServiceID is a unique identifier of a specific service.
)

Service information constants

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

Variables

This section is empty.

Functions

func ItemType_Values 

func ItemType_Values() []string

ItemType_Values returns all elements of the ItemType enum

func StorageClass_Values 

func StorageClass_Values() []string

StorageClass_Values returns all elements of the StorageClass enum

func UploadAvailability_Values 

func UploadAvailability_Values() []string

UploadAvailability_Values returns all elements of the UploadAvailability enum

Types

type ContainerNotFoundException 

type ContainerNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The specified container was not found for the specified account.

func (*ContainerNotFoundException) Code 

func (s *ContainerNotFoundException) Code() string

Code returns the exception type name.

func (*ContainerNotFoundException) Error 

func (s *ContainerNotFoundException) Error() string

func (ContainerNotFoundException) GoString 

func (s ContainerNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ContainerNotFoundException) Message 

func (s *ContainerNotFoundException) Message() string

Message returns the exception's message.

func (*ContainerNotFoundException) OrigErr 

func (s *ContainerNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ContainerNotFoundException) RequestID 

func (s *ContainerNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ContainerNotFoundException) StatusCode 

func (s *ContainerNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ContainerNotFoundException) String 

func (s ContainerNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteObjectInput 

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 

func (s DeleteObjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteObjectInput) SetPath 

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

SetPath sets the Path field's value.

func (DeleteObjectInput) String 

func (s DeleteObjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteObjectInput) Validate 

func (s *DeleteObjectInput) Validate() error

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

type DeleteObjectOutput 

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

func (DeleteObjectOutput) GoString 

func (s DeleteObjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteObjectOutput) String 

func (s DeleteObjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeObjectInput 

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 

func (s DescribeObjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeObjectInput) SetPath 

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

SetPath sets the Path field's value.

func (DescribeObjectInput) String 

func (s DescribeObjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeObjectInput) Validate 

func (s *DescribeObjectInput) Validate() error

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

type DescribeObjectOutput 

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 

func (s DescribeObjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeObjectOutput) SetCacheControl 

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

SetCacheControl sets the CacheControl field's value.

func (*DescribeObjectOutput) SetContentLength 

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

SetContentLength sets the ContentLength field's value.

func (*DescribeObjectOutput) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*DescribeObjectOutput) SetETag 

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

SetETag sets the ETag field's value.

func (*DescribeObjectOutput) SetLastModified 

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

SetLastModified sets the LastModified field's value.

func (DescribeObjectOutput) String 

func (s DescribeObjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetObjectInput 

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 

func (s GetObjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetObjectInput) SetPath 

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

SetPath sets the Path field's value.

func (*GetObjectInput) SetRange 

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

SetRange sets the Range field's value.

func (GetObjectInput) String 

func (s GetObjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetObjectInput) Validate 

func (s *GetObjectInput) Validate() error

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

type GetObjectOutput 

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 

func (s GetObjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetObjectOutput) SetBody 

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

SetBody sets the Body field's value.

func (*GetObjectOutput) SetCacheControl 

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

SetCacheControl sets the CacheControl field's value.

func (*GetObjectOutput) SetContentLength 

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

SetContentLength sets the ContentLength field's value.

func (*GetObjectOutput) SetContentRange 

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

SetContentRange sets the ContentRange field's value.

func (*GetObjectOutput) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*GetObjectOutput) SetETag 

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

SetETag sets the ETag field's value.

func (*GetObjectOutput) SetLastModified 

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

SetLastModified sets the LastModified field's value.

func (*GetObjectOutput) SetStatusCode 

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

SetStatusCode sets the StatusCode field's value.

func (GetObjectOutput) String 

func (s GetObjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError 

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The service is temporarily unavailable.

func (*InternalServerError) Code 

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error 

func (s *InternalServerError) Error() string

func (InternalServerError) GoString 

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message 

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr 

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID 

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode 

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String 

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Item 

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 

func (s Item) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Item) SetContentLength 

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

SetContentLength sets the ContentLength field's value.

func (*Item) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*Item) SetETag 

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

SetETag sets the ETag field's value.

func (*Item) SetLastModified 

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

SetLastModified sets the LastModified field's value.

func (*Item) SetName 

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

SetName sets the Name field's value.

func (*Item) SetType 

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

SetType sets the Type field's value.

func (Item) String 

func (s Item) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListItemsInput 

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 

func (s ListItemsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListItemsInput) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListItemsInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (*ListItemsInput) SetPath 

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

SetPath sets the Path field's value.

func (ListItemsInput) String 

func (s ListItemsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListItemsInput) Validate 

func (s *ListItemsInput) Validate() error

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

type ListItemsOutput 

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 

func (s ListItemsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListItemsOutput) SetItems 

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

SetItems sets the Items field's value.

func (*ListItemsOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListItemsOutput) String 

func (s ListItemsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MediaStoreData 

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.

Example (DescribeEndpoint) 
package main

import (
	"fmt"
	"log"

	"github.com/aws/aws-sdk-go/aws"
	"github.com/aws/aws-sdk-go/aws/session"
	"github.com/aws/aws-sdk-go/service/mediastore"
	"github.com/aws/aws-sdk-go/service/mediastoredata"
)

func main() {
	sess, err := session.NewSession(aws.NewConfig())
	if err != nil {
		log.Fatal("Failed to create aws session", err)
	}

	// we need to use a MediaStore client to get a media store container endpoint address
	ctrlSvc := mediastore.New(sess)
	descResp, err := ctrlSvc.DescribeContainer(&mediastore.DescribeContainerInput{
		// specify a container name
		ContainerName: aws.String("some-container"),
	})
	if err != nil {
		log.Fatal("failed to get media store container endpoint", err)
	}

	// create a MediaStoreData client and use the retrieved container endpoint
	dataSvc := mediastoredata.New(sess, &aws.Config{
		Endpoint: descResp.Container.Endpoint,
	})
	output, err := dataSvc.ListItems(&mediastoredata.ListItemsInput{})
	if err != nil {
		log.Fatal("failed to make mediastoredata API call", err)
	}

	// prints the string representation of ListItemsOutput
	fmt.Println(output.GoString())
}

Output:

func New 

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: 

mySession := session.Must(session.NewSession())

// 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 

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 Types:

  • ContainerNotFoundException The specified container was not found for the specified account.

  • ObjectNotFoundException Could not perform an operation on an object that does not exist.

  • InternalServerError The service is temporarily unavailable.

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

func (*MediaStoreData) DeleteObjectRequest 

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 

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 

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 Types:

  • ContainerNotFoundException The specified container was not found for the specified account.

  • ObjectNotFoundException Could not perform an operation on an object that does not exist.

  • InternalServerError The service is temporarily unavailable.

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

func (*MediaStoreData) DescribeObjectRequest 

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 

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 

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 Types:

  • ContainerNotFoundException The specified container was not found for the specified account.

  • ObjectNotFoundException Could not perform an operation on an object that does not exist.

  • RequestedRangeNotSatisfiableException The requested content range is not valid.

  • InternalServerError The service is temporarily unavailable.

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

func (*MediaStoreData) GetObjectRequest 

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 

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 

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 Types:

  • ContainerNotFoundException The specified container was not found for the specified account.

  • InternalServerError The service is temporarily unavailable.

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

func (*MediaStoreData) ListItemsPages 

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 

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 

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 

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 

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 Types:

  • ContainerNotFoundException The specified container was not found for the specified account.

  • InternalServerError The service is temporarily unavailable.

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

func (*MediaStoreData) PutObjectRequest 

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 

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 ObjectNotFoundException 

type ObjectNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

Could not perform an operation on an object that does not exist.

func (*ObjectNotFoundException) Code 

func (s *ObjectNotFoundException) Code() string

Code returns the exception type name.

func (*ObjectNotFoundException) Error 

func (s *ObjectNotFoundException) Error() string

func (ObjectNotFoundException) GoString 

func (s ObjectNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ObjectNotFoundException) Message 

func (s *ObjectNotFoundException) Message() string

Message returns the exception's message.

func (*ObjectNotFoundException) OrigErr 

func (s *ObjectNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ObjectNotFoundException) RequestID 

func (s *ObjectNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ObjectNotFoundException) StatusCode 

func (s *ObjectNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ObjectNotFoundException) String 

func (s ObjectNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutObjectInput 

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 

func (s PutObjectInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutObjectInput) SetBody 

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

SetBody sets the Body field's value.

func (*PutObjectInput) SetCacheControl 

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

SetCacheControl sets the CacheControl field's value.

func (*PutObjectInput) SetContentType 

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

SetContentType sets the ContentType field's value.

func (*PutObjectInput) SetPath 

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

SetPath sets the Path field's value.

func (*PutObjectInput) SetStorageClass 

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

SetStorageClass sets the StorageClass field's value.

func (*PutObjectInput) SetUploadAvailability 

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

SetUploadAvailability sets the UploadAvailability field's value.

func (PutObjectInput) String 

func (s PutObjectInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutObjectInput) Validate 

func (s *PutObjectInput) Validate() error

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

type PutObjectOutput 

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 

func (s PutObjectOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutObjectOutput) SetContentSHA256 

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

SetContentSHA256 sets the ContentSHA256 field's value.

func (*PutObjectOutput) SetETag 

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

SetETag sets the ETag field's value.

func (*PutObjectOutput) SetStorageClass 

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

SetStorageClass sets the StorageClass field's value.

func (PutObjectOutput) String 

func (s PutObjectOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RequestedRangeNotSatisfiableException 

type RequestedRangeNotSatisfiableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" min:"1" type:"string"`
	// contains filtered or unexported fields
}

The requested content range is not valid.

func (*RequestedRangeNotSatisfiableException) Code 

func (s *RequestedRangeNotSatisfiableException) Code() string

Code returns the exception type name.

func (*RequestedRangeNotSatisfiableException) Error 

func (s *RequestedRangeNotSatisfiableException) Error() string

func (RequestedRangeNotSatisfiableException) GoString 

func (s RequestedRangeNotSatisfiableException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RequestedRangeNotSatisfiableException) Message 

func (s *RequestedRangeNotSatisfiableException) Message() string

Message returns the exception's message.

func (*RequestedRangeNotSatisfiableException) OrigErr 

func (s *RequestedRangeNotSatisfiableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*RequestedRangeNotSatisfiableException) RequestID 

func (s *RequestedRangeNotSatisfiableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*RequestedRangeNotSatisfiableException) StatusCode 

func (s *RequestedRangeNotSatisfiableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (RequestedRangeNotSatisfiableException) String 

func (s RequestedRangeNotSatisfiableException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

Directories

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.