MediaStore

public struct MediaStore

Client object for interacting with AWS MediaStore service.

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

Member variables

Initialization

  • Initialize the MediaStore client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

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

    Declaration

    Swift

    public func createContainer(_ input: CreateContainerInput) -> EventLoopFuture<CreateContainerOutput>

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

    Declaration

    Swift

    public func deleteContainer(_ input: DeleteContainerInput) -> EventLoopFuture<DeleteContainerOutput>

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

    Declaration

    Swift

    public func deleteContainerPolicy(_ input: DeleteContainerPolicyInput) -> EventLoopFuture<DeleteContainerPolicyOutput>

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

    Declaration

    Swift

    public func deleteCorsPolicy(_ input: DeleteCorsPolicyInput) -> EventLoopFuture<DeleteCorsPolicyOutput>

  • Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.

    Declaration

    Swift

    public func deleteLifecyclePolicy(_ input: DeleteLifecyclePolicyInput) -> EventLoopFuture<DeleteLifecyclePolicyOutput>

  • Deletes the metric policy that is associated with the specified container. If there is no metric policy associated with the container, MediaStore doesn’t send metrics to CloudWatch.

    Declaration

    Swift

    public func deleteMetricPolicy(_ input: DeleteMetricPolicyInput) -> EventLoopFuture<DeleteMetricPolicyOutput>

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

    Declaration

    Swift

    public func describeContainer(_ input: DescribeContainerInput) -> EventLoopFuture<DescribeContainerOutput>

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

    Declaration

    Swift

    public func getContainerPolicy(_ input: GetContainerPolicyInput) -> EventLoopFuture<GetContainerPolicyOutput>

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

    Declaration

    Swift

    public func getCorsPolicy(_ input: GetCorsPolicyInput) -> EventLoopFuture<GetCorsPolicyOutput>

  • Retrieves the object lifecycle policy that is assigned to a container.

    Declaration

    Swift

    public func getLifecyclePolicy(_ input: GetLifecyclePolicyInput) -> EventLoopFuture<GetLifecyclePolicyOutput>

  • Returns the metric policy for the specified container.

    Declaration

    Swift

    public func getMetricPolicy(_ input: GetMetricPolicyInput) -> EventLoopFuture<GetMetricPolicyOutput>

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

    Declaration

    Swift

    public func listContainers(_ input: ListContainersInput) -> EventLoopFuture<ListContainersOutput>

  • Returns a list of the tags assigned to the specified container.

    Declaration

    Swift

    public func listTagsForResource(_ input: ListTagsForResourceInput) -> EventLoopFuture<ListTagsForResourceOutput>

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

    Declaration

    Swift

    public func putContainerPolicy(_ input: PutContainerPolicyInput) -> EventLoopFuture<PutContainerPolicyOutput>

  • 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. To learn more about CORS, see Cross-Origin Resource Sharing (CORS) in AWS Elemental MediaStore.

    Declaration

    Swift

    public func putCorsPolicy(_ input: PutCorsPolicyInput) -> EventLoopFuture<PutCorsPolicyOutput>

  • Writes an object lifecycle policy to a container. If the container already has an object lifecycle policy, the service replaces the existing policy with the new policy. It takes up to 20 minutes for the change to take effect. For information about how to construct an object lifecycle policy, see Components of an Object Lifecycle Policy.

    Declaration

    Swift

    public func putLifecyclePolicy(_ input: PutLifecyclePolicyInput) -> EventLoopFuture<PutLifecyclePolicyOutput>

  • The metric policy that you want to add to the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. It takes up to 20 minutes for the new policy to take effect.

    Declaration

    Swift

    public func putMetricPolicy(_ input: PutMetricPolicyInput) -> EventLoopFuture<PutMetricPolicyOutput>

  • Starts access logging on the specified container. When you enable access logging on a container, MediaStore delivers access logs for objects stored in that container to Amazon CloudWatch Logs.

    Declaration

    Swift

    public func startAccessLogging(_ input: StartAccessLoggingInput) -> EventLoopFuture<StartAccessLoggingOutput>

  • Stops access logging on the specified container. When you stop access logging on a container, MediaStore stops sending access logs to Amazon CloudWatch Logs. These access logs are not saved and are not retrievable.

    Declaration

    Swift

    public func stopAccessLogging(_ input: StopAccessLoggingInput) -> EventLoopFuture<StopAccessLoggingOutput>

  • Adds tags to the specified AWS Elemental MediaStore container. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be “customer” and the tag value might be “companyA.” You can specify one or more tags to add to each container. You can add up to 50 tags to each container. For more information about tagging, including naming and usage conventions, see Tagging Resources in MediaStore.

    Declaration

    Swift

    public func tagResource(_ input: TagResourceInput) -> EventLoopFuture<TagResourceOutput>

  • Removes tags from the specified container. You can specify one or more tags to remove.

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceInput) -> EventLoopFuture<UntagResourceOutput>

Paginators

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

    Declaration

    Swift

    public func listContainersPaginator(_ input: ListContainersInput, onPage: @escaping (ListContainersOutput, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum ContainerLevelMetrics : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ContainerStatus : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum MethodName : String, CustomStringConvertible, Codable