mediastore

package
v1.12.36-0...-5eaaf5f Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2017 License: Apache-2.0 Imports: 7 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 contact 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 (
	// ContainerStatusActive is a ContainerStatus enum value
	ContainerStatusActive = "ACTIVE"

	// ContainerStatusCreating is a ContainerStatus enum value
	ContainerStatusCreating = "CREATING"

	// ContainerStatusDeleting is a ContainerStatus enum value
	ContainerStatusDeleting = "DELETING"
)
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"

	// 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 from 1 to 255 characters. Use this
	// endpoint to identify this container when sending requests to the data plane.
	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 *string `min:"1" type:"string" enum:"ContainerStatus"`
	// 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) SetARN 

func (s *Container) SetARN(v string) *Container

SetARN sets the ARN field's value.

func (*Container) SetCreationTime 

func (s *Container) SetCreationTime(v time.Time) *Container

SetCreationTime sets the CreationTime field's value.

func (*Container) SetEndpoint 

func (s *Container) SetEndpoint(v string) *Container

SetEndpoint sets the Endpoint field's value.

func (*Container) SetName 

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

SetName sets the Name field's value.

func (*Container) SetStatus 

func (s *Container) SetStatus(v string) *Container

SetStatus sets the Status field's value.

func (Container) String 

func (s Container) 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) SetContainerName 

func (s *CreateContainerInput) SetContainerName(v string) *CreateContainerInput

SetContainerName sets the ContainerName field's value.

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 timestamp.
	//
	// 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) SetContainer 

func (s *CreateContainerOutput) SetContainer(v *Container) *CreateContainerOutput

SetContainer sets the Container field's value.

func (CreateContainerOutput) String 

func (s CreateContainerOutput) String() string

String returns the string representation

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) SetContainerName 

func (s *DeleteContainerInput) SetContainerName(v string) *DeleteContainerInput

SetContainerName sets the ContainerName field's value.

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) 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) SetContainerName 

func (s *DeleteContainerPolicyInput) SetContainerName(v string) *DeleteContainerPolicyInput

SetContainerName sets the ContainerName field's value.

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) String 

func (s DeleteContainerPolicyOutput) String() string

String returns the string representation

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) SetContainerName 

func (s *DescribeContainerInput) SetContainerName(v string) *DescribeContainerInput

SetContainerName sets the ContainerName field's value.

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) SetContainer 

func (s *DescribeContainerOutput) SetContainer(v *Container) *DescribeContainerOutput

SetContainer sets the Container field's value.

func (DescribeContainerOutput) String 

func (s DescribeContainerOutput) String() string

String returns the string representation

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) SetContainerName 

func (s *GetContainerPolicyInput) SetContainerName(v string) *GetContainerPolicyInput

SetContainerName sets the ContainerName field's value.

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) SetPolicy 

func (s *GetContainerPolicyOutput) SetPolicy(v string) *GetContainerPolicyOutput

SetPolicy sets the Policy field's value.

func (GetContainerPolicyOutput) String 

func (s GetContainerPolicyOutput) String() string

String returns the string representation

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) SetMaxResults 

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

SetMaxResults sets the MaxResults field's value.

func (*ListContainersInput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

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) SetContainers 

func (s *ListContainersOutput) SetContainers(v []*Container) *ListContainersOutput

SetContainers sets the Containers field's value.

func (*ListContainersOutput) SetNextToken 

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

SetNextToken sets the NextToken field's value.

func (ListContainersOutput) String 

func (s ListContainersOutput) String() string

String returns the string representation

type MediaStore 

type MediaStore struct {
	*client.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(p client.ConfigProvider, cfgs ...*aws.Config) *MediaStore

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

Example: 

// Create a MediaStore client from just a session.
svc := mediastore.New(mySession)

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

func (*MediaStore) CreateContainer 

func (c *MediaStore) CreateContainer(input *CreateContainerInput) (*CreateContainerOutput, error)

CreateContainer 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.

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's API operation CreateContainer for usage and error information.

Returned Error Codes:

  • ErrCodeContainerInUseException "ContainerInUseException" Resource already exists or is being updated.

  • ErrCodeLimitExceededException "LimitExceededException" A service limit has been exceeded.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) CreateContainerRequest 

func (c *MediaStore) CreateContainerRequest(input *CreateContainerInput) (req *request.Request, output *CreateContainerOutput)

CreateContainerRequest generates a "aws/request.Request" representing the client's request for the CreateContainer operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 CreateContainer for more information on using the CreateContainer 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 CreateContainerRequest method.
req, resp := client.CreateContainerRequest(params)

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

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

func (*MediaStore) CreateContainerWithContext 

func (c *MediaStore) CreateContainerWithContext(ctx aws.Context, input *CreateContainerInput, opts ...request.Option) (*CreateContainerOutput, error)

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

See CreateContainer 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 (*MediaStore) DeleteContainer 

func (c *MediaStore) DeleteContainer(input *DeleteContainerInput) (*DeleteContainerOutput, error)

DeleteContainer 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.

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's API operation DeleteContainer for usage and error information.

Returned Error Codes:

  • ErrCodeContainerInUseException "ContainerInUseException" Resource already exists or is being updated.

  • ErrCodeContainerNotFoundException "ContainerNotFoundException" Could not perform an operation on a container that does not exist.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) DeleteContainerPolicy 

func (c *MediaStore) DeleteContainerPolicy(input *DeleteContainerPolicyInput) (*DeleteContainerPolicyOutput, error)

DeleteContainerPolicy API operation for AWS Elemental MediaStore.

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

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's API operation DeleteContainerPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeContainerInUseException "ContainerInUseException" Resource already exists or is being updated.

  • ErrCodeContainerNotFoundException "ContainerNotFoundException" Could not perform an operation on a container that does not exist.

  • ErrCodePolicyNotFoundException "PolicyNotFoundException" Could not perform an operation on a policy that does not exist.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) DeleteContainerPolicyRequest 

func (c *MediaStore) DeleteContainerPolicyRequest(input *DeleteContainerPolicyInput) (req *request.Request, output *DeleteContainerPolicyOutput)

DeleteContainerPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteContainerPolicy operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DeleteContainerPolicy for more information on using the DeleteContainerPolicy 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 DeleteContainerPolicyRequest method.
req, resp := client.DeleteContainerPolicyRequest(params)

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

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

func (*MediaStore) DeleteContainerPolicyWithContext 

func (c *MediaStore) DeleteContainerPolicyWithContext(ctx aws.Context, input *DeleteContainerPolicyInput, opts ...request.Option) (*DeleteContainerPolicyOutput, error)

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

See DeleteContainerPolicy 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 (*MediaStore) DeleteContainerRequest 

func (c *MediaStore) DeleteContainerRequest(input *DeleteContainerInput) (req *request.Request, output *DeleteContainerOutput)

DeleteContainerRequest generates a "aws/request.Request" representing the client's request for the DeleteContainer operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DeleteContainer for more information on using the DeleteContainer 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 DeleteContainerRequest method.
req, resp := client.DeleteContainerRequest(params)

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

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

func (*MediaStore) DeleteContainerWithContext 

func (c *MediaStore) DeleteContainerWithContext(ctx aws.Context, input *DeleteContainerInput, opts ...request.Option) (*DeleteContainerOutput, error)

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

See DeleteContainer 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 (*MediaStore) DescribeContainer 

func (c *MediaStore) DescribeContainer(input *DescribeContainerInput) (*DescribeContainerOutput, error)

DescribeContainer API operation for AWS Elemental MediaStore.

Retrieves the properties of the requested container. This returns a single Container object based on ContainerName. To return all Container objects that are associated with a specified AWS account, use ListContainers.

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's API operation DescribeContainer for usage and error information.

Returned Error Codes:

  • ErrCodeContainerNotFoundException "ContainerNotFoundException" Could not perform an operation on a container that does not exist.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) DescribeContainerRequest 

func (c *MediaStore) DescribeContainerRequest(input *DescribeContainerInput) (req *request.Request, output *DescribeContainerOutput)

DescribeContainerRequest generates a "aws/request.Request" representing the client's request for the DescribeContainer operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 DescribeContainer for more information on using the DescribeContainer 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 DescribeContainerRequest method.
req, resp := client.DescribeContainerRequest(params)

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

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

func (*MediaStore) DescribeContainerWithContext 

func (c *MediaStore) DescribeContainerWithContext(ctx aws.Context, input *DescribeContainerInput, opts ...request.Option) (*DescribeContainerOutput, error)

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

See DescribeContainer 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 (*MediaStore) GetContainerPolicy 

func (c *MediaStore) GetContainerPolicy(input *GetContainerPolicyInput) (*GetContainerPolicyOutput, error)

GetContainerPolicy 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/).

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's API operation GetContainerPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeContainerInUseException "ContainerInUseException" Resource already exists or is being updated.

  • ErrCodeContainerNotFoundException "ContainerNotFoundException" Could not perform an operation on a container that does not exist.

  • ErrCodePolicyNotFoundException "PolicyNotFoundException" Could not perform an operation on a policy that does not exist.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) GetContainerPolicyRequest 

func (c *MediaStore) GetContainerPolicyRequest(input *GetContainerPolicyInput) (req *request.Request, output *GetContainerPolicyOutput)

GetContainerPolicyRequest generates a "aws/request.Request" representing the client's request for the GetContainerPolicy operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 GetContainerPolicy for more information on using the GetContainerPolicy 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 GetContainerPolicyRequest method.
req, resp := client.GetContainerPolicyRequest(params)

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

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

func (*MediaStore) GetContainerPolicyWithContext 

func (c *MediaStore) GetContainerPolicyWithContext(ctx aws.Context, input *GetContainerPolicyInput, opts ...request.Option) (*GetContainerPolicyOutput, error)

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

See GetContainerPolicy 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 (*MediaStore) ListContainers 

func (c *MediaStore) ListContainers(input *ListContainersInput) (*ListContainersOutput, error)

ListContainers 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.

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's API operation ListContainers for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) ListContainersRequest 

func (c *MediaStore) ListContainersRequest(input *ListContainersInput) (req *request.Request, output *ListContainersOutput)

ListContainersRequest generates a "aws/request.Request" representing the client's request for the ListContainers operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 ListContainers for more information on using the ListContainers 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 ListContainersRequest method.
req, resp := client.ListContainersRequest(params)

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

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

func (*MediaStore) ListContainersWithContext 

func (c *MediaStore) ListContainersWithContext(ctx aws.Context, input *ListContainersInput, opts ...request.Option) (*ListContainersOutput, error)

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

See ListContainers 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 (*MediaStore) PutContainerPolicy 

func (c *MediaStore) PutContainerPolicy(input *PutContainerPolicyInput) (*PutContainerPolicyOutput, error)

PutContainerPolicy 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.

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's API operation PutContainerPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeContainerNotFoundException "ContainerNotFoundException" Could not perform an operation on a container that does not exist.

  • ErrCodeContainerInUseException "ContainerInUseException" Resource already exists or is being updated.

  • ErrCodeInternalServerError "InternalServerError" The service is temporarily unavailable.

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

func (*MediaStore) PutContainerPolicyRequest 

func (c *MediaStore) PutContainerPolicyRequest(input *PutContainerPolicyInput) (req *request.Request, output *PutContainerPolicyOutput)

PutContainerPolicyRequest generates a "aws/request.Request" representing the client's request for the PutContainerPolicy operation. The "output" return value will be populated with the request's response once the request complets successfuly.

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 PutContainerPolicy for more information on using the PutContainerPolicy 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 PutContainerPolicyRequest method.
req, resp := client.PutContainerPolicyRequest(params)

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

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

func (*MediaStore) PutContainerPolicyWithContext 

func (c *MediaStore) PutContainerPolicyWithContext(ctx aws.Context, input *PutContainerPolicyInput, opts ...request.Option) (*PutContainerPolicyOutput, error)

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

See PutContainerPolicy 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 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) SetContainerName 

func (s *PutContainerPolicyInput) SetContainerName(v string) *PutContainerPolicyInput

SetContainerName sets the ContainerName field's value.

func (*PutContainerPolicyInput) SetPolicy 

func (s *PutContainerPolicyInput) SetPolicy(v string) *PutContainerPolicyInput

SetPolicy sets the Policy field's value.

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) String 

func (s PutContainerPolicyOutput) String() string

String returns the string representation

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.