mediastore

package
v0.4.0 Latest Latest
Warning

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

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Overview

Package mediastore provides the client and types for making API requests to AWS Elemental MediaStore.

An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.

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

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

Using the Client

To AWS Elemental MediaStore 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 client MediaStore for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/mediastore/#New

Index

Constants

View Source 
const (

	// ErrCodeContainerInUseException for service response error code
	// "ContainerInUseException".
	//
	// Resource already exists or is being updated.
	ErrCodeContainerInUseException = "ContainerInUseException"

	// ErrCodeContainerNotFoundException for service response error code
	// "ContainerNotFoundException".
	//
	// Could not perform an operation on a container that does not exist.
	ErrCodeContainerNotFoundException = "ContainerNotFoundException"

	// ErrCodeCorsPolicyNotFoundException for service response error code
	// "CorsPolicyNotFoundException".
	//
	// Could not perform an operation on a policy that does not exist.
	ErrCodeCorsPolicyNotFoundException = "CorsPolicyNotFoundException"

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

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A service limit has been exceeded.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodePolicyNotFoundException for service response error code
	// "PolicyNotFoundException".
	//
	// Could not perform an operation on a policy that does not exist.
	ErrCodePolicyNotFoundException = "PolicyNotFoundException"
)
View Source 
const (
	ServiceName = "mediastore" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Container 

type Container struct {

	// The Amazon Resource Name (ARN) of the container. The ARN has the following
	// format:
	//
	// arn:aws:<region>:<account that owns this container>:container/<name of container>
	//
	// For example: arn:aws:mediastore:us-west-2:111122223333:container/movies
	ARN *string `min:"1" type:"string"`

	// Unix timestamp.
	CreationTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The DNS endpoint of the container. Use the endpoint to identify the specific
	// container when sending requests to the data plane. The service assigns this
	// value when the container is created. Once the value has been assigned, it
	// does not change.
	Endpoint *string `min:"1" type:"string"`

	// The name of the container.
	Name *string `min:"1" type:"string"`

	// The status of container creation or deletion. The status is one of the following:
	// CREATING, ACTIVE, or DELETING. While the service is creating the container,
	// the status is CREATING. When the endpoint is available, the status changes
	// to ACTIVE.
	Status ContainerStatus `min:"1" type:"string" enum:"true"`
	// contains filtered or unexported fields
}

This section describes operations that you can perform on an AWS Elemental MediaStore container. Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/Container

func (Container) GoString 

func (s Container) GoString() string

GoString returns the string representation

func (Container) String 

func (s Container) String() string

String returns the string representation

type ContainerStatus 

type ContainerStatus string
const (
	ContainerStatusActive   ContainerStatus = "ACTIVE"
	ContainerStatusCreating ContainerStatus = "CREATING"
	ContainerStatusDeleting ContainerStatus = "DELETING"
)

Enum values for ContainerStatus

func (ContainerStatus) MarshalValue added in v0.3.0 

func (enum ContainerStatus) MarshalValue() (string, error)

func (ContainerStatus) MarshalValueBuf added in v0.3.0 

func (enum ContainerStatus) MarshalValueBuf(b []byte) ([]byte, error)

type CorsRule added in v0.3.0 

type CorsRule struct {

	// Specifies which headers are allowed in a preflight OPTIONS request through
	// the Access-Control-Request-Headers header. Each header name that is specified
	// in Access-Control-Request-Headers must have a corresponding entry in the
	// rule. Only the headers that were requested are sent back.
	//
	// This element can contain only one wildcard character (*).
	AllowedHeaders []string `type:"list"`

	// Identifies an HTTP method that the origin that is specified in the rule is
	// allowed to execute.
	//
	// Each CORS rule must contain at least one AllowedMethod and one AllowedOrigin
	// element.
	AllowedMethods []MethodName `type:"list"`

	// One or more response headers that you want users to be able to access from
	// their applications (for example, from a JavaScript XMLHttpRequest object).
	//
	// Each CORS rule must have at least one AllowedOrigin element. The string value
	// can include only one wildcard character (*), for example, http://*.example.com.
	// Additionally, you can specify only one wildcard character to allow cross-origin
	// access for all origins.
	AllowedOrigins []string `type:"list"`

	// One or more headers in the response that you want users to be able to access
	// from their applications (for example, from a JavaScript XMLHttpRequest object).
	//
	// This element is optional for each rule.
	ExposeHeaders []string `type:"list"`

	// The time in seconds that your browser caches the preflight response for the
	// specified resource.
	//
	// A CORS rule can have only one MaxAgeSeconds element.
	MaxAgeSeconds *int64 `type:"integer"`
	// contains filtered or unexported fields
}

A rule for a CORS policy. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/CorsRule

func (CorsRule) GoString added in v0.3.0 

func (s CorsRule) GoString() string

GoString returns the string representation

func (CorsRule) String added in v0.3.0 

func (s CorsRule) String() string

String returns the string representation

type CreateContainerInput 

type CreateContainerInput struct {

	// The name for the container. The name must be from 1 to 255 characters. Container
	// names must be unique to your AWS account within a specific region. As an
	// example, you could create a container named movies in every region, as long
	// as you don’t have an existing container with that name.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/CreateContainerInput

func (CreateContainerInput) GoString 

func (s CreateContainerInput) GoString() string

GoString returns the string representation

func (CreateContainerInput) String 

func (s CreateContainerInput) String() string

String returns the string representation

func (*CreateContainerInput) Validate 

func (s *CreateContainerInput) Validate() error

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

type CreateContainerOutput 

type CreateContainerOutput struct {

	// ContainerARN: The Amazon Resource Name (ARN) of the newly created container.
	// The ARN has the following format: arn:aws:<region>:<account that owns this
	// container>:container/<name of container>. For example: arn:aws:mediastore:us-west-2:111122223333:container/movies
	//
	// ContainerName: The container name as specified in the request.
	//
	// CreationTime: Unix time stamp.
	//
	// Status: The status of container creation or deletion. The status is one of
	// the following: CREATING, ACTIVE, or DELETING. While the service is creating
	// the container, the status is CREATING. When an endpoint is available, the
	// status changes to ACTIVE.
	//
	// The return value does not include the container's endpoint. To make downstream
	// requests, you must obtain this value by using DescribeContainer or ListContainers.
	//
	// Container is a required field
	Container *Container `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/CreateContainerOutput

func (CreateContainerOutput) GoString 

func (s CreateContainerOutput) GoString() string

GoString returns the string representation

func (CreateContainerOutput) SDKResponseMetadata 

func (s CreateContainerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateContainerOutput) String 

func (s CreateContainerOutput) String() string

String returns the string representation

type CreateContainerRequest 

type CreateContainerRequest struct {
	*aws.Request
	Input *CreateContainerInput
	Copy  func(*CreateContainerInput) CreateContainerRequest
}

CreateContainerRequest is a API request type for the CreateContainer API operation.

func (CreateContainerRequest) Send 

func (r CreateContainerRequest) Send() (*CreateContainerOutput, error)

Send marshals and sends the CreateContainer API request.

type DeleteContainerInput 

type DeleteContainerInput struct {

	// The name of the container to delete.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainerInput

func (DeleteContainerInput) GoString 

func (s DeleteContainerInput) GoString() string

GoString returns the string representation

func (DeleteContainerInput) String 

func (s DeleteContainerInput) String() string

String returns the string representation

func (*DeleteContainerInput) Validate 

func (s *DeleteContainerInput) Validate() error

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

type DeleteContainerOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainerOutput

func (DeleteContainerOutput) GoString 

func (s DeleteContainerOutput) GoString() string

GoString returns the string representation

func (DeleteContainerOutput) SDKResponseMetadata 

func (s DeleteContainerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteContainerOutput) String 

func (s DeleteContainerOutput) String() string

String returns the string representation

type DeleteContainerPolicyInput 

type DeleteContainerPolicyInput struct {

	// The name of the container that holds the policy.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainerPolicyInput

func (DeleteContainerPolicyInput) GoString 

func (s DeleteContainerPolicyInput) GoString() string

GoString returns the string representation

func (DeleteContainerPolicyInput) String 

func (s DeleteContainerPolicyInput) String() string

String returns the string representation

func (*DeleteContainerPolicyInput) Validate 

func (s *DeleteContainerPolicyInput) Validate() error

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

type DeleteContainerPolicyOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainerPolicyOutput

func (DeleteContainerPolicyOutput) GoString 

func (s DeleteContainerPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteContainerPolicyOutput) SDKResponseMetadata 

func (s DeleteContainerPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteContainerPolicyOutput) String 

func (s DeleteContainerPolicyOutput) String() string

String returns the string representation

type DeleteContainerPolicyRequest 

type DeleteContainerPolicyRequest struct {
	*aws.Request
	Input *DeleteContainerPolicyInput
	Copy  func(*DeleteContainerPolicyInput) DeleteContainerPolicyRequest
}

DeleteContainerPolicyRequest is a API request type for the DeleteContainerPolicy API operation.

func (DeleteContainerPolicyRequest) Send 

func (r DeleteContainerPolicyRequest) Send() (*DeleteContainerPolicyOutput, error)

Send marshals and sends the DeleteContainerPolicy API request.

type DeleteContainerRequest 

type DeleteContainerRequest struct {
	*aws.Request
	Input *DeleteContainerInput
	Copy  func(*DeleteContainerInput) DeleteContainerRequest
}

DeleteContainerRequest is a API request type for the DeleteContainer API operation.

func (DeleteContainerRequest) Send 

func (r DeleteContainerRequest) Send() (*DeleteContainerOutput, error)

Send marshals and sends the DeleteContainer API request.

type DeleteCorsPolicyInput added in v0.3.0 

type DeleteCorsPolicyInput struct {

	// The name of the container to remove the policy from.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteCorsPolicyInput

func (DeleteCorsPolicyInput) GoString added in v0.3.0 

func (s DeleteCorsPolicyInput) GoString() string

GoString returns the string representation

func (DeleteCorsPolicyInput) String added in v0.3.0 

func (s DeleteCorsPolicyInput) String() string

String returns the string representation

func (*DeleteCorsPolicyInput) Validate added in v0.3.0 

func (s *DeleteCorsPolicyInput) Validate() error

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

type DeleteCorsPolicyOutput added in v0.3.0 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteCorsPolicyOutput

func (DeleteCorsPolicyOutput) GoString added in v0.3.0 

func (s DeleteCorsPolicyOutput) GoString() string

GoString returns the string representation

func (DeleteCorsPolicyOutput) SDKResponseMetadata added in v0.3.0 

func (s DeleteCorsPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteCorsPolicyOutput) String added in v0.3.0 

func (s DeleteCorsPolicyOutput) String() string

String returns the string representation

type DeleteCorsPolicyRequest added in v0.3.0 

type DeleteCorsPolicyRequest struct {
	*aws.Request
	Input *DeleteCorsPolicyInput
	Copy  func(*DeleteCorsPolicyInput) DeleteCorsPolicyRequest
}

DeleteCorsPolicyRequest is a API request type for the DeleteCorsPolicy API operation.

func (DeleteCorsPolicyRequest) Send added in v0.3.0 

func (r DeleteCorsPolicyRequest) Send() (*DeleteCorsPolicyOutput, error)

Send marshals and sends the DeleteCorsPolicy API request.

type DescribeContainerInput 

type DescribeContainerInput struct {

	// The name of the container to query.
	ContainerName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DescribeContainerInput

func (DescribeContainerInput) GoString 

func (s DescribeContainerInput) GoString() string

GoString returns the string representation

func (DescribeContainerInput) String 

func (s DescribeContainerInput) String() string

String returns the string representation

func (*DescribeContainerInput) Validate 

func (s *DescribeContainerInput) Validate() error

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

type DescribeContainerOutput 

type DescribeContainerOutput struct {

	// The name of the queried container.
	Container *Container `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DescribeContainerOutput

func (DescribeContainerOutput) GoString 

func (s DescribeContainerOutput) GoString() string

GoString returns the string representation

func (DescribeContainerOutput) SDKResponseMetadata 

func (s DescribeContainerOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeContainerOutput) String 

func (s DescribeContainerOutput) String() string

String returns the string representation

type DescribeContainerRequest 

type DescribeContainerRequest struct {
	*aws.Request
	Input *DescribeContainerInput
	Copy  func(*DescribeContainerInput) DescribeContainerRequest
}

DescribeContainerRequest is a API request type for the DescribeContainer API operation.

func (DescribeContainerRequest) Send 

func (r DescribeContainerRequest) Send() (*DescribeContainerOutput, error)

Send marshals and sends the DescribeContainer API request.

type GetContainerPolicyInput 

type GetContainerPolicyInput struct {

	// The name of the container.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetContainerPolicyInput

func (GetContainerPolicyInput) GoString 

func (s GetContainerPolicyInput) GoString() string

GoString returns the string representation

func (GetContainerPolicyInput) String 

func (s GetContainerPolicyInput) String() string

String returns the string representation

func (*GetContainerPolicyInput) Validate 

func (s *GetContainerPolicyInput) Validate() error

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

type GetContainerPolicyOutput 

type GetContainerPolicyOutput struct {

	// The contents of the access policy.
	//
	// Policy is a required field
	Policy *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetContainerPolicyOutput

func (GetContainerPolicyOutput) GoString 

func (s GetContainerPolicyOutput) GoString() string

GoString returns the string representation

func (GetContainerPolicyOutput) SDKResponseMetadata 

func (s GetContainerPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetContainerPolicyOutput) String 

func (s GetContainerPolicyOutput) String() string

String returns the string representation

type GetContainerPolicyRequest 

type GetContainerPolicyRequest struct {
	*aws.Request
	Input *GetContainerPolicyInput
	Copy  func(*GetContainerPolicyInput) GetContainerPolicyRequest
}

GetContainerPolicyRequest is a API request type for the GetContainerPolicy API operation.

func (GetContainerPolicyRequest) Send 

func (r GetContainerPolicyRequest) Send() (*GetContainerPolicyOutput, error)

Send marshals and sends the GetContainerPolicy API request.

type GetCorsPolicyInput added in v0.3.0 

type GetCorsPolicyInput struct {

	// The name of the container that the policy is assigned to.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetCorsPolicyInput

func (GetCorsPolicyInput) GoString added in v0.3.0 

func (s GetCorsPolicyInput) GoString() string

GoString returns the string representation

func (GetCorsPolicyInput) String added in v0.3.0 

func (s GetCorsPolicyInput) String() string

String returns the string representation

func (*GetCorsPolicyInput) Validate added in v0.3.0 

func (s *GetCorsPolicyInput) Validate() error

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

type GetCorsPolicyOutput added in v0.3.0 

type GetCorsPolicyOutput struct {

	// The CORS policy of the container.
	//
	// CorsPolicy is a required field
	CorsPolicy []CorsRule `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetCorsPolicyOutput

func (GetCorsPolicyOutput) GoString added in v0.3.0 

func (s GetCorsPolicyOutput) GoString() string

GoString returns the string representation

func (GetCorsPolicyOutput) SDKResponseMetadata added in v0.3.0 

func (s GetCorsPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (GetCorsPolicyOutput) String added in v0.3.0 

func (s GetCorsPolicyOutput) String() string

String returns the string representation

type GetCorsPolicyRequest added in v0.3.0 

type GetCorsPolicyRequest struct {
	*aws.Request
	Input *GetCorsPolicyInput
	Copy  func(*GetCorsPolicyInput) GetCorsPolicyRequest
}

GetCorsPolicyRequest is a API request type for the GetCorsPolicy API operation.

func (GetCorsPolicyRequest) Send added in v0.3.0 

func (r GetCorsPolicyRequest) Send() (*GetCorsPolicyOutput, error)

Send marshals and sends the GetCorsPolicy API request.

type ListContainersInput 

type ListContainersInput struct {

	// Enter the maximum number of containers in the response. Use from 1 to 255
	// characters.
	MaxResults *int64 `min:"1" type:"integer"`

	// Only if you used MaxResults in the first command, enter the token (which
	// was included in the previous response) to obtain the next set of containers.
	// This token is included in a response only if there actually are more containers
	// to list.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/ListContainersInput

func (ListContainersInput) GoString 

func (s ListContainersInput) GoString() string

GoString returns the string representation

func (ListContainersInput) String 

func (s ListContainersInput) String() string

String returns the string representation

func (*ListContainersInput) Validate 

func (s *ListContainersInput) Validate() error

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

type ListContainersOutput 

type ListContainersOutput struct {

	// The names of the containers.
	//
	// Containers is a required field
	Containers []Container `type:"list" required:"true"`

	// NextToken is the token to use in the next call to ListContainers. This token
	// is returned only if you included the MaxResults tag in the original command,
	// and only if there are still containers to return.
	NextToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/ListContainersOutput

func (ListContainersOutput) GoString 

func (s ListContainersOutput) GoString() string

GoString returns the string representation

func (ListContainersOutput) SDKResponseMetadata 

func (s ListContainersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListContainersOutput) String 

func (s ListContainersOutput) String() string

String returns the string representation

type ListContainersRequest 

type ListContainersRequest struct {
	*aws.Request
	Input *ListContainersInput
	Copy  func(*ListContainersInput) ListContainersRequest
}

ListContainersRequest is a API request type for the ListContainers API operation.

func (ListContainersRequest) Send 

func (r ListContainersRequest) Send() (*ListContainersOutput, error)

Send marshals and sends the ListContainers API request.

type MediaStore 

type MediaStore struct {
	*aws.Client
}

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

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

func New 

func New(config aws.Config) *MediaStore

New creates a new instance of the MediaStore client with a config.

Example: 

// Create a MediaStore client from just a config.
svc := mediastore.New(myConfig)

func (*MediaStore) CreateContainerRequest 

func (c *MediaStore) CreateContainerRequest(input *CreateContainerInput) CreateContainerRequest

CreateContainerRequest returns a request value for making API operation for AWS Elemental MediaStore.

Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service. 

// Example sending a request using the CreateContainerRequest method.
req := client.CreateContainerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/CreateContainer

func (*MediaStore) DeleteContainerPolicyRequest 

func (c *MediaStore) DeleteContainerPolicyRequest(input *DeleteContainerPolicyInput) DeleteContainerPolicyRequest

DeleteContainerPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Deletes the access policy that is associated with the specified container. 

// Example sending a request using the DeleteContainerPolicyRequest method.
req := client.DeleteContainerPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainerPolicy

func (*MediaStore) DeleteContainerRequest 

func (c *MediaStore) DeleteContainerRequest(input *DeleteContainerInput) DeleteContainerRequest

DeleteContainerRequest returns a request value for making API operation for AWS Elemental MediaStore.

Deletes the specified container. Before you make a DeleteContainer request, delete any objects in the container or in any folders in the container. You can delete only empty containers. 

// Example sending a request using the DeleteContainerRequest method.
req := client.DeleteContainerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteContainer

func (*MediaStore) DeleteCorsPolicyRequest added in v0.3.0 

func (c *MediaStore) DeleteCorsPolicyRequest(input *DeleteCorsPolicyInput) DeleteCorsPolicyRequest

DeleteCorsPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:DeleteCorsPolicy action. The container owner has this permission by default and can grant this permission to others. 

// Example sending a request using the DeleteCorsPolicyRequest method.
req := client.DeleteCorsPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DeleteCorsPolicy

func (*MediaStore) DescribeContainerRequest 

func (c *MediaStore) DescribeContainerRequest(input *DescribeContainerInput) DescribeContainerRequest

DescribeContainerRequest returns a request value for making API operation for AWS Elemental MediaStore.

Retrieves the properties of the requested container. This request is commonly used to retrieve the endpoint of a container. An endpoint is a value assigned by the service when a new container is created. A container's endpoint does not change after it has been assigned. The DescribeContainer request returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers. 

// Example sending a request using the DescribeContainerRequest method.
req := client.DescribeContainerRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/DescribeContainer

func (*MediaStore) GetContainerPolicyRequest 

func (c *MediaStore) GetContainerPolicyRequest(input *GetContainerPolicyInput) GetContainerPolicyRequest

GetContainerPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Retrieves the access policy for the specified container. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide (https://aws.amazon.com/documentation/iam/). 

// Example sending a request using the GetContainerPolicyRequest method.
req := client.GetContainerPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetContainerPolicy

func (*MediaStore) GetCorsPolicyRequest added in v0.3.0 

func (c *MediaStore) GetCorsPolicyRequest(input *GetCorsPolicyInput) GetCorsPolicyRequest

GetCorsPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.

To use this operation, you must have permission to perform the MediaStore:GetCorsPolicy action. By default, the container owner has this permission and can grant it to others. 

// Example sending a request using the GetCorsPolicyRequest method.
req := client.GetCorsPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/GetCorsPolicy

func (*MediaStore) ListContainersRequest 

func (c *MediaStore) ListContainersRequest(input *ListContainersInput) ListContainersRequest

ListContainersRequest returns a request value for making API operation for AWS Elemental MediaStore.

Lists the properties of all containers in AWS Elemental MediaStore.

You can query to receive all the containers in one response. Or you can include the MaxResults parameter to receive a limited number of containers in each response. In this case, the response includes a token. To get the next set of containers, send the command again, this time with the NextToken parameter (with the returned token as its value). The next set of responses appears, with a token if there are still more containers to receive.

See also DescribeContainer, which gets the properties of one container. 

// Example sending a request using the ListContainersRequest method.
req := client.ListContainersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/ListContainers

func (*MediaStore) PutContainerPolicyRequest 

func (c *MediaStore) PutContainerPolicyRequest(input *PutContainerPolicyInput) PutContainerPolicyRequest

PutContainerPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Creates an access policy for the specified container to restrict the users and clients that can access it. For information about the data that is included in an access policy, see the AWS Identity and Access Management User Guide (https://aws.amazon.com/documentation/iam/).

For this release of the REST API, you can create only one policy for a container. If you enter PutContainerPolicy twice, the second command modifies the existing policy. 

// Example sending a request using the PutContainerPolicyRequest method.
req := client.PutContainerPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutContainerPolicy

func (*MediaStore) PutCorsPolicyRequest added in v0.3.0 

func (c *MediaStore) PutCorsPolicyRequest(input *PutCorsPolicyInput) PutCorsPolicyRequest

PutCorsPolicyRequest returns a request value for making API operation for AWS Elemental MediaStore.

Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com to access your AWS Elemental MediaStore container at my.example.container.com by using the browser's XMLHttpRequest capability.

To enable CORS on a container, you attach a CORS policy to the container. In the CORS policy, you configure rules that identify origins and the HTTP methods that can be executed on your container. The policy can contain up to 398,000 characters. You can add up to 100 rules to a CORS policy. If more than one rule applies, the service uses the first applicable rule listed. 

// Example sending a request using the PutCorsPolicyRequest method.
req := client.PutCorsPolicyRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutCorsPolicy

type MethodName added in v0.3.0 

type MethodName string
const (
	MethodNamePut    MethodName = "PUT"
	MethodNameGet    MethodName = "GET"
	MethodNameDelete MethodName = "DELETE"
	MethodNameHead   MethodName = "HEAD"
)

Enum values for MethodName

func (MethodName) MarshalValue added in v0.3.0 

func (enum MethodName) MarshalValue() (string, error)

func (MethodName) MarshalValueBuf added in v0.3.0 

func (enum MethodName) MarshalValueBuf(b []byte) ([]byte, error)

type PutContainerPolicyInput 

type PutContainerPolicyInput struct {

	// The name of the container.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`

	// The contents of the policy, which includes the following:
	//
	//    * One Version tag
	//
	//    * One Statement tag that contains the standard tags for the policy.
	//
	// Policy is a required field
	Policy *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutContainerPolicyInput

func (PutContainerPolicyInput) GoString 

func (s PutContainerPolicyInput) GoString() string

GoString returns the string representation

func (PutContainerPolicyInput) String 

func (s PutContainerPolicyInput) String() string

String returns the string representation

func (*PutContainerPolicyInput) Validate 

func (s *PutContainerPolicyInput) Validate() error

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

type PutContainerPolicyOutput 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutContainerPolicyOutput

func (PutContainerPolicyOutput) GoString 

func (s PutContainerPolicyOutput) GoString() string

GoString returns the string representation

func (PutContainerPolicyOutput) SDKResponseMetadata 

func (s PutContainerPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutContainerPolicyOutput) String 

func (s PutContainerPolicyOutput) String() string

String returns the string representation

type PutContainerPolicyRequest 

type PutContainerPolicyRequest struct {
	*aws.Request
	Input *PutContainerPolicyInput
	Copy  func(*PutContainerPolicyInput) PutContainerPolicyRequest
}

PutContainerPolicyRequest is a API request type for the PutContainerPolicy API operation.

func (PutContainerPolicyRequest) Send 

func (r PutContainerPolicyRequest) Send() (*PutContainerPolicyOutput, error)

Send marshals and sends the PutContainerPolicy API request.

type PutCorsPolicyInput added in v0.3.0 

type PutCorsPolicyInput struct {

	// The name of the container that you want to assign the CORS policy to.
	//
	// ContainerName is a required field
	ContainerName *string `min:"1" type:"string" required:"true"`

	// The CORS policy to apply to the container.
	//
	// CorsPolicy is a required field
	CorsPolicy []CorsRule `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutCorsPolicyInput

func (PutCorsPolicyInput) GoString added in v0.3.0 

func (s PutCorsPolicyInput) GoString() string

GoString returns the string representation

func (PutCorsPolicyInput) String added in v0.3.0 

func (s PutCorsPolicyInput) String() string

String returns the string representation

func (*PutCorsPolicyInput) Validate added in v0.3.0 

func (s *PutCorsPolicyInput) Validate() error

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

type PutCorsPolicyOutput added in v0.3.0 

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/mediastore-2017-09-01/PutCorsPolicyOutput

func (PutCorsPolicyOutput) GoString added in v0.3.0 

func (s PutCorsPolicyOutput) GoString() string

GoString returns the string representation

func (PutCorsPolicyOutput) SDKResponseMetadata added in v0.3.0 

func (s PutCorsPolicyOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (PutCorsPolicyOutput) String added in v0.3.0 

func (s PutCorsPolicyOutput) String() string

String returns the string representation

type PutCorsPolicyRequest added in v0.3.0 

type PutCorsPolicyRequest struct {
	*aws.Request
	Input *PutCorsPolicyInput
	Copy  func(*PutCorsPolicyInput) PutCorsPolicyRequest
}

PutCorsPolicyRequest is a API request type for the PutCorsPolicy API operation.

func (PutCorsPolicyRequest) Send added in v0.3.0 

func (r PutCorsPolicyRequest) Send() (*PutCorsPolicyOutput, error)

Send marshals and sends the PutCorsPolicy API request.

Source Files

View all Source files

Directories

Path Synopsis
Package mediastoreiface provides an interface to enable mocking the AWS Elemental MediaStore service client for testing your code.
 Package mediastoreiface provides an interface to enable mocking the AWS Elemental MediaStore 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.