@Generated(value="software.amazon.awssdk:codegen") public interface MediaStoreClient extends SdkClient
builder()
method.
An AWS Elemental MediaStore container is a namespace that holds folders and objects. You use a container endpoint to create, read, and delete objects.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider . |
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static MediaStoreClientBuilder |
builder()
Create a builder that can be used to configure and create a
MediaStoreClient . |
static MediaStoreClient |
create()
Create a
MediaStoreClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CreateContainerResponse |
createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
Creates a storage container to hold objects.
|
default CreateContainerResponse |
createContainer(CreateContainerRequest createContainerRequest)
Creates a storage container to hold objects.
|
default DeleteContainerResponse |
deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
Deletes the specified container.
|
default DeleteContainerResponse |
deleteContainer(DeleteContainerRequest deleteContainerRequest)
Deletes the specified container.
|
default DeleteContainerPolicyResponse |
deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default DeleteContainerPolicyResponse |
deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default DeleteCorsPolicyResponse |
deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default DeleteCorsPolicyResponse |
deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container.
|
default DeleteLifecyclePolicyResponse |
deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest)
Removes an object lifecycle policy from a container.
|
default DeleteMetricPolicyResponse |
deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container.
|
default DeleteMetricPolicyResponse |
deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest)
Deletes the metric policy that is associated with the specified container.
|
default DescribeContainerResponse |
describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
Retrieves the properties of the requested container.
|
default DescribeContainerResponse |
describeContainer(DescribeContainerRequest describeContainerRequest)
Retrieves the properties of the requested container.
|
default GetContainerPolicyResponse |
getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default GetContainerPolicyResponse |
getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default GetCorsPolicyResponse |
getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default GetCorsPolicyResponse |
getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
|
default GetLifecyclePolicyResponse |
getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest)
Retrieves the object lifecycle policy that is assigned to a container.
|
default GetMetricPolicyResponse |
getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest)
Returns the metric policy for the specified container.
|
default GetMetricPolicyResponse |
getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest)
Returns the metric policy for the specified container.
|
default ListContainersResponse |
listContainers()
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersResponse |
listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersResponse |
listContainers(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersIterable |
listContainersPaginator()
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersIterable |
listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListContainersIterable |
listContainersPaginator(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default ListTagsForResourceResponse |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
|
default ListTagsForResourceResponse |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Returns a list of the tags assigned to the specified container.
|
default PutContainerPolicyResponse |
putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it.
|
default PutContainerPolicyResponse |
putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it.
|
default PutCorsPolicyResponse |
putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service
cross-origin requests.
|
default PutCorsPolicyResponse |
putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service
cross-origin requests.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container.
|
default PutLifecyclePolicyResponse |
putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest)
Writes an object lifecycle policy to a container.
|
default PutMetricPolicyResponse |
putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest)
The metric policy that you want to add to the container.
|
default PutMetricPolicyResponse |
putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest)
The metric policy that you want to add to the container.
|
static ServiceMetadata |
serviceMetadata() |
default StartAccessLoggingResponse |
startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest)
Starts access logging on the specified container.
|
default StartAccessLoggingResponse |
startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest)
Starts access logging on the specified container.
|
default StopAccessLoggingResponse |
stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest)
Stops access logging on the specified container.
|
default StopAccessLoggingResponse |
stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest)
Stops access logging on the specified container.
|
default TagResourceResponse |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container.
|
default TagResourceResponse |
tagResource(TagResourceRequest tagResourceRequest)
Adds tags to the specified AWS Elemental MediaStore container.
|
default UntagResourceResponse |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from the specified container.
|
default UntagResourceResponse |
untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from the specified container.
|
serviceName
close
static final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider
.static MediaStoreClient create()
MediaStoreClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MediaStoreClientBuilder builder()
MediaStoreClient
.default CreateContainerResponse createContainer(CreateContainerRequest createContainerRequest) throws ContainerInUseException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
createContainerRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.LimitExceededException
- A service limit has been exceeded.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default CreateContainerResponse createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest) throws ContainerInUseException, LimitExceededException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
This is a convenience which creates an instance of the CreateContainerRequest.Builder
avoiding the need
to create one manually via CreateContainerRequest.builder()
createContainerRequest
- A Consumer
that will call methods on CreateContainerInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.LimitExceededException
- A service limit has been exceeded.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContainerResponse deleteContainer(DeleteContainerRequest deleteContainerRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
deleteContainerRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContainerResponse deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the DeleteContainerRequest.Builder
avoiding the need
to create one manually via DeleteContainerRequest.builder()
deleteContainerRequest
- A Consumer
that will call methods on DeleteContainerInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContainerPolicyResponse deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Deletes the access policy that is associated with the specified container.
deleteContainerPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteContainerPolicyResponse deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Deletes the access policy that is associated with the specified container.
This is a convenience which creates an instance of the DeleteContainerPolicyRequest.Builder
avoiding the
need to create one manually via DeleteContainerPolicyRequest.builder()
deleteContainerPolicyRequest
- A Consumer
that will call methods on DeleteContainerPolicyInput.Builder
to create a
request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCorsPolicyResponse deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, CorsPolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
deleteCorsPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.CorsPolicyNotFoundException
- The CORS policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteCorsPolicyResponse deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, CorsPolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the DeleteCorsPolicyRequest.Builder
avoiding the need
to create one manually via DeleteCorsPolicyRequest.builder()
deleteCorsPolicyRequest
- A Consumer
that will call methods on DeleteCorsPolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.CorsPolicyNotFoundException
- The CORS policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(DeleteLifecyclePolicyRequest deleteLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
deleteLifecyclePolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteLifecyclePolicyResponse deleteLifecyclePolicy(Consumer<DeleteLifecyclePolicyRequest.Builder> deleteLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Removes an object lifecycle policy from a container. It takes up to 20 minutes for the change to take effect.
This is a convenience which creates an instance of the DeleteLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via DeleteLifecyclePolicyRequest.builder()
deleteLifecyclePolicyRequest
- A Consumer
that will call methods on DeleteLifecyclePolicyInput.Builder
to create a
request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMetricPolicyResponse deleteMetricPolicy(DeleteMetricPolicyRequest deleteMetricPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
deleteMetricPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteMetricPolicyResponse deleteMetricPolicy(Consumer<DeleteMetricPolicyRequest.Builder> deleteMetricPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the DeleteMetricPolicyRequest.Builder
avoiding the
need to create one manually via DeleteMetricPolicyRequest.builder()
deleteMetricPolicyRequest
- A Consumer
that will call methods on DeleteMetricPolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeContainerResponse describeContainer(DescribeContainerRequest describeContainerRequest) throws ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
describeContainerRequest
- ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeContainerResponse describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest) throws ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the DescribeContainerRequest.Builder
avoiding the need
to create one manually via DescribeContainerRequest.builder()
describeContainerRequest
- A Consumer
that will call methods on DescribeContainerInput.Builder
to create a request.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContainerPolicyResponse getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
getContainerPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetContainerPolicyResponse getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the GetContainerPolicyRequest.Builder
avoiding the
need to create one manually via GetContainerPolicyRequest.builder()
getContainerPolicyRequest
- A Consumer
that will call methods on GetContainerPolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCorsPolicyResponse getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, CorsPolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
getCorsPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.CorsPolicyNotFoundException
- The CORS policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetCorsPolicyResponse getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, CorsPolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the GetCorsPolicyRequest.Builder
avoiding the need to
create one manually via GetCorsPolicyRequest.builder()
getCorsPolicyRequest
- A Consumer
that will call methods on GetCorsPolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.CorsPolicyNotFoundException
- The CORS policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyResponse getLifecyclePolicy(GetLifecyclePolicyRequest getLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Retrieves the object lifecycle policy that is assigned to a container.
getLifecyclePolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetLifecyclePolicyResponse getLifecyclePolicy(Consumer<GetLifecyclePolicyRequest.Builder> getLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, PolicyNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Retrieves the object lifecycle policy that is assigned to a container.
This is a convenience which creates an instance of the GetLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via GetLifecyclePolicyRequest.builder()
getLifecyclePolicyRequest
- A Consumer
that will call methods on GetLifecyclePolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricPolicyResponse getMetricPolicy(GetMetricPolicyRequest getMetricPolicyRequest) throws ContainerNotFoundException, PolicyNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Returns the metric policy for the specified container.
getMetricPolicyRequest
- ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetMetricPolicyResponse getMetricPolicy(Consumer<GetMetricPolicyRequest.Builder> getMetricPolicyRequest) throws ContainerNotFoundException, PolicyNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Returns the metric policy for the specified container.
This is a convenience which creates an instance of the GetMetricPolicyRequest.Builder
avoiding the need
to create one manually via GetMetricPolicyRequest.builder()
getMetricPolicyRequest
- A Consumer
that will call methods on GetMetricPolicyInput.Builder
to create a request.ContainerNotFoundException
- The container that you specified in the request does not exist.PolicyNotFoundException
- The policy that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainersResponse listContainers() throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listContainers(ListContainersRequest)
,
AWS API
Documentationdefault ListContainersResponse listContainers(ListContainersRequest listContainersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
listContainersRequest
- InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainersResponse listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the ListContainersRequest.Builder
avoiding the need to
create one manually via ListContainersRequest.builder()
listContainersRequest
- A Consumer
that will call methods on ListContainersInput.Builder
to create a request.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainersIterable listContainersPaginator() throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client .listContainersPaginator(request); for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation.
InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listContainersPaginator(ListContainersRequest)
,
AWS API
Documentationdefault ListContainersIterable listContainersPaginator(ListContainersRequest listContainersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client .listContainersPaginator(request); for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation.
listContainersRequest
- InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListContainersIterable listContainersPaginator(Consumer<ListContainersRequest.Builder> listContainersRequest) throws InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a variant of
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation. The
return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle
making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client .listContainersPaginator(request); for (software.amazon.awssdk.services.mediastore.model.ListContainersResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.mediastore.paginators.ListContainersIterable responses = client.listContainersPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listContainers(software.amazon.awssdk.services.mediastore.model.ListContainersRequest)
operation.
This is a convenience which creates an instance of the ListContainersRequest.Builder
avoiding the need to
create one manually via ListContainersRequest.builder()
listContainersRequest
- A Consumer
that will call methods on ListContainersInput.Builder
to create a request.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Returns a list of the tags assigned to the specified container.
listTagsForResourceRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Returns a list of the tags assigned to the specified container.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder
avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutContainerPolicyResponse putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest) throws ContainerNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
putContainerPolicyRequest
- ContainerNotFoundException
- The container that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutContainerPolicyResponse putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest) throws ContainerNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the PutContainerPolicyRequest.Builder
avoiding the
need to create one manually via PutContainerPolicyRequest.builder()
putContainerPolicyRequest
- A Consumer
that will call methods on PutContainerPolicyInput.Builder
to create a request.ContainerNotFoundException
- The container that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutCorsPolicyResponse putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest) throws ContainerNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
putCorsPolicyRequest
- ContainerNotFoundException
- The container that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutCorsPolicyResponse putCorsPolicy(Consumer<PutCorsPolicyRequest.Builder> putCorsPolicyRequest) throws ContainerNotFoundException, ContainerInUseException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the PutCorsPolicyRequest.Builder
avoiding the need to
create one manually via PutCorsPolicyRequest.builder()
putCorsPolicyRequest
- A Consumer
that will call methods on PutCorsPolicyInput.Builder
to create a request.ContainerNotFoundException
- The container that you specified in the request does not exist.ContainerInUseException
- The container that you specified in the request already exists or is being updated.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutLifecyclePolicyResponse putLifecyclePolicy(PutLifecyclePolicyRequest putLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
putLifecyclePolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutLifecyclePolicyResponse putLifecyclePolicy(Consumer<PutLifecyclePolicyRequest.Builder> putLifecyclePolicyRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the PutLifecyclePolicyRequest.Builder
avoiding the
need to create one manually via PutLifecyclePolicyRequest.builder()
putLifecyclePolicyRequest
- A Consumer
that will call methods on PutLifecyclePolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricPolicyResponse putMetricPolicy(PutMetricPolicyRequest putMetricPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
putMetricPolicyRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutMetricPolicyResponse putMetricPolicy(Consumer<PutMetricPolicyRequest.Builder> putMetricPolicyRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the PutMetricPolicyRequest.Builder
avoiding the need
to create one manually via PutMetricPolicyRequest.builder()
putMetricPolicyRequest
- A Consumer
that will call methods on PutMetricPolicyInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartAccessLoggingResponse startAccessLogging(StartAccessLoggingRequest startAccessLoggingRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
startAccessLoggingRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartAccessLoggingResponse startAccessLogging(Consumer<StartAccessLoggingRequest.Builder> startAccessLoggingRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the StartAccessLoggingRequest.Builder
avoiding the
need to create one manually via StartAccessLoggingRequest.builder()
startAccessLoggingRequest
- A Consumer
that will call methods on StartAccessLoggingInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopAccessLoggingResponse stopAccessLogging(StopAccessLoggingRequest stopAccessLoggingRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
stopAccessLoggingRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopAccessLoggingResponse stopAccessLogging(Consumer<StopAccessLoggingRequest.Builder> stopAccessLoggingRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the StopAccessLoggingRequest.Builder
avoiding the need
to create one manually via StopAccessLoggingRequest.builder()
stopAccessLoggingRequest
- A Consumer
that will call methods on StopAccessLoggingInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
tagResourceRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
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.
This is a convenience which creates an instance of the TagResourceRequest.Builder
avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Removes tags from the specified container. You can specify one or more tags to remove.
untagResourceRequest
- ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ContainerInUseException, ContainerNotFoundException, InternalServerErrorException, AwsServiceException, SdkClientException, MediaStoreException
Removes tags from the specified container. You can specify one or more tags to remove.
This is a convenience which creates an instance of the UntagResourceRequest.Builder
avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceInput.Builder
to create a request.ContainerInUseException
- The container that you specified in the request already exists or is being updated.ContainerNotFoundException
- The container that you specified in the request does not exist.InternalServerErrorException
- The service is temporarily unavailable.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.MediaStoreException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()