Documentation

Overview

    Package mediastoredata provides the API client, operations, and parameter types for 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.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-09-01"
    View Source
    const ServiceID = "MediaStore Data"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

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

            Client provides the API client to make operations call for AWS Elemental MediaStore Data Plane.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) DeleteObject

                func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error)

                  Deletes an object at the specified path.

                  func (*Client) DescribeObject

                  func (c *Client) DescribeObject(ctx context.Context, params *DescribeObjectInput, optFns ...func(*Options)) (*DescribeObjectOutput, error)

                    Gets the headers for an object at the specified path.

                    func (*Client) GetObject

                    func (c *Client) GetObject(ctx context.Context, params *GetObjectInput, optFns ...func(*Options)) (*GetObjectOutput, error)

                      Downloads the object at the specified path.

                      func (*Client) ListItems

                      func (c *Client) ListItems(ctx context.Context, params *ListItemsInput, optFns ...func(*Options)) (*ListItemsOutput, error)

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

                        func (*Client) PutObject

                        func (c *Client) PutObject(ctx context.Context, params *PutObjectInput, optFns ...func(*Options)) (*PutObjectOutput, error)

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

                          type DeleteObjectInput

                          type DeleteObjectInput struct {
                          
                          	// The path (including the file name) where the object is stored in the container.
                          	// Format: //
                          	//
                          	// This member is required.
                          	Path *string
                          }

                          type DeleteObjectOutput

                          type DeleteObjectOutput struct {
                          	// Metadata pertaining to the operation's result.
                          	ResultMetadata middleware.Metadata
                          }

                          type DescribeObjectInput

                          type DescribeObjectInput struct {
                          
                          	// The path (including the file name) where the object is stored in the container.
                          	// Format: //
                          	//
                          	// This member is required.
                          	Path *string
                          }

                          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
                          
                          	// The length of the object in bytes.
                          	ContentLength *int64
                          
                          	// The content type of the object.
                          	ContentType *string
                          
                          	// The ETag that represents a unique instance of the object.
                          	ETag *string
                          
                          	// The date and time that the object was last modified.
                          	LastModified *time.Time
                          
                          	// Metadata pertaining to the operation's result.
                          	ResultMetadata middleware.Metadata
                          }

                          type EndpointResolver

                          type EndpointResolver interface {
                          	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                          }

                            EndpointResolver interface for resolving service endpoints.

                            func EndpointResolverFromURL

                            func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                              EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                              type EndpointResolverFunc

                              type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                func (EndpointResolverFunc) ResolveEndpoint

                                func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                type EndpointResolverOptions

                                type EndpointResolverOptions = internalendpoints.Options

                                  EndpointResolverOptions is the service endpoint resolver options

                                  type GetObjectInput

                                  type GetObjectInput struct {
                                  
                                  	// The path (including the file name) where the object is stored in the container.
                                  	// Format: // For example, to upload the file mlaw.avi to the folder path
                                  	// premium\canada in the container movies, enter the path premium/canada/mlaw.avi.
                                  	// Do not include the container name in this path. If the path includes any folders
                                  	// that don't exist yet, the service creates them. For example, suppose you have an
                                  	// existing premium/usa subfolder. If you specify premium/canada, the service
                                  	// creates a canada subfolder in the premium folder. You then have two subfolders,
                                  	// usa and canada, in the premium folder. There is no correlation between the path
                                  	// to the source and the path (folders) in the container in AWS Elemental
                                  	// MediaStore. For more information about folders and how they exist in a
                                  	// container, see the AWS Elemental MediaStore User Guide
                                  	// (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.
                                  	//
                                  	// This member is required.
                                  	Path *string
                                  
                                  	// The range bytes of an object to retrieve. For more information about the Range
                                  	// header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35
                                  	// (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35).
                                  	Range *string
                                  }

                                  type GetObjectOutput

                                  type GetObjectOutput struct {
                                  
                                  	// 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.
                                  	//
                                  	// This member is required.
                                  	StatusCode int32
                                  
                                  	// The bytes of the object.
                                  	Body io.ReadCloser
                                  
                                  	// 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
                                  
                                  	// The length of the object in bytes.
                                  	ContentLength *int64
                                  
                                  	// The range of bytes to retrieve.
                                  	ContentRange *string
                                  
                                  	// The content type of the object.
                                  	ContentType *string
                                  
                                  	// The ETag that represents a unique instance of the object.
                                  	ETag *string
                                  
                                  	// The date and time that the object was last modified.
                                  	LastModified *time.Time
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type HTTPClient

                                  type HTTPClient interface {
                                  	Do(*http.Request) (*http.Response, error)
                                  }

                                  type HTTPSignerV4

                                  type HTTPSignerV4 interface {
                                  	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                  }

                                  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 *int32
                                  
                                  	// 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
                                  
                                  	// The path in the container from which to retrieve items. Format: //
                                  	Path *string
                                  }

                                  type ListItemsOutput

                                  type ListItemsOutput struct {
                                  
                                  	// The metadata entries for the folders and objects at the requested path.
                                  	Items []types.Item
                                  
                                  	// 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
                                  
                                  	// Metadata pertaining to the operation's result.
                                  	ResultMetadata middleware.Metadata
                                  }

                                  type Options

                                  type Options struct {
                                  	// Set of options to modify how an operation is invoked. These apply to all
                                  	// operations invoked for this client. Use functional options on operation call to
                                  	// modify this list for per operation behavior.
                                  	APIOptions []func(*middleware.Stack) error
                                  
                                  	// Configures the events that will be sent to the configured logger.
                                  	ClientLogMode aws.ClientLogMode
                                  
                                  	// The credentials object to use when signing requests.
                                  	Credentials aws.CredentialsProvider
                                  
                                  	// The endpoint options to be used when attempting to resolve an endpoint.
                                  	EndpointOptions EndpointResolverOptions
                                  
                                  	// The service endpoint resolver.
                                  	EndpointResolver EndpointResolver
                                  
                                  	// Signature Version 4 (SigV4) Signer
                                  	HTTPSignerV4 HTTPSignerV4
                                  
                                  	// The logger writer interface to write logging messages to.
                                  	Logger logging.Logger
                                  
                                  	// The region to send requests to. (Required)
                                  	Region string
                                  
                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                  	// failures. When nil the API client will use a default retryer.
                                  	Retryer aws.Retryer
                                  
                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                  	// implementation if nil.
                                  	HTTPClient HTTPClient
                                  }

                                  func (Options) Copy

                                  func (o Options) Copy() Options

                                    Copy creates a clone where the APIOptions list is deep copied.

                                    type PutObjectInput

                                    type PutObjectInput struct {
                                    
                                    	// The bytes to be stored.
                                    	//
                                    	// This member is required.
                                    	Body io.Reader
                                    
                                    	// The path (including the file name) where the object is stored in the container.
                                    	// Format: // For example, to upload the file mlaw.avi to the folder path
                                    	// premium\canada in the container movies, enter the path premium/canada/mlaw.avi.
                                    	// Do not include the container name in this path. If the path includes any folders
                                    	// that don't exist yet, the service creates them. For example, suppose you have an
                                    	// existing premium/usa subfolder. If you specify premium/canada, the service
                                    	// creates a canada subfolder in the premium folder. You then have two subfolders,
                                    	// usa and canada, in the premium folder. There is no correlation between the path
                                    	// to the source and the path (folders) in the container in AWS Elemental
                                    	// MediaStore. For more information about folders and how they exist in a
                                    	// container, see the AWS Elemental MediaStore User Guide
                                    	// (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.
                                    	//
                                    	// This member is required.
                                    	Path *string
                                    
                                    	// An optional CacheControl header that allows the caller to control the object's
                                    	// cache behavior. Headers can be passed in as specified in the HTTP at
                                    	// https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9
                                    	// (https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9). Headers with
                                    	// a custom user-defined value are also accepted.
                                    	CacheControl *string
                                    
                                    	// The content type of the object.
                                    	ContentType *string
                                    
                                    	// Indicates the storage class of a Put request. Defaults to high-performance
                                    	// temporal storage class, and objects are persisted into durable storage shortly
                                    	// after being received.
                                    	StorageClass types.StorageClass
                                    }

                                    type PutObjectOutput

                                    type PutObjectOutput struct {
                                    
                                    	// The SHA256 digest of the object that is persisted.
                                    	ContentSHA256 *string
                                    
                                    	// Unique identifier of the object in the container.
                                    	ETag *string
                                    
                                    	// The storage class where the object was persisted. The class should be
                                    	// “Temporal”.
                                    	StorageClass types.StorageClass
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                    type ResolveEndpoint

                                    type ResolveEndpoint struct {
                                    	Resolver EndpointResolver
                                    	Options  EndpointResolverOptions
                                    }

                                    func (*ResolveEndpoint) HandleSerialize

                                    func (*ResolveEndpoint) ID

                                    func (*ResolveEndpoint) ID() string

                                    Directories

                                    Path Synopsis
                                    internal