Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Hierarchy

Implements

Index

Constructors

constructor

Properties

Readonly config

The resolved configuration of MediaStoreClient class. This is resolved and normalized from the constructor configuration interface.

middlewareStack

Methods

createContainer

deleteContainer

deleteContainerPolicy

deleteCorsPolicy

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

    Parameters

    Returns Promise<DeleteCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DeleteCorsPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DeleteCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

deleteLifecyclePolicy

deleteMetricPolicy

describeContainer

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

    Parameters

    Returns Promise<DescribeContainerCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: DescribeContainerCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<DescribeContainerCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

destroy

  • destroy(): void
  • Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

    Returns void

getContainerPolicy

getCorsPolicy

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

    Parameters

    Returns Promise<GetCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: GetCorsPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<GetCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

getLifecyclePolicy

getMetricPolicy

listContainers

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

    Parameters

    Returns Promise<ListContainersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: ListContainersCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<ListContainersCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

listTagsForResource

putContainerPolicy

putCorsPolicy

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

    Parameters

    Returns Promise<PutCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: PutCorsPolicyCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<PutCorsPolicyCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

putLifecyclePolicy

putMetricPolicy

send

startAccessLogging

stopAccessLogging

tagResource

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

    Parameters

    Returns Promise<TagResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

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

    Parameters

    • args: TagResourceCommandInput
    • Optional options: __HttpHandlerOptions

    Returns Promise<TagResourceCommandOutput>

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

    Parameters

    Returns void

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

    Parameters

    Returns void

untagResource