@Generated(value="software.amazon.awssdk:codegen") public interface MediaStoreAsyncClient 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_NAME |
Modifier and Type | Method and Description |
---|---|
static MediaStoreAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
MediaStoreAsyncClient . |
static MediaStoreAsyncClient |
create()
Create a
MediaStoreAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateContainerResponse> |
createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
Creates a storage container to hold objects.
|
default CompletableFuture<CreateContainerResponse> |
createContainer(CreateContainerRequest createContainerRequest)
Creates a storage container to hold objects.
|
default CompletableFuture<DeleteContainerResponse> |
deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
Deletes the specified container.
|
default CompletableFuture<DeleteContainerResponse> |
deleteContainer(DeleteContainerRequest deleteContainerRequest)
Deletes the specified container.
|
default CompletableFuture<DeleteContainerPolicyResponse> |
deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default CompletableFuture<DeleteContainerPolicyResponse> |
deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
|
default CompletableFuture<DeleteCorsPolicyResponse> |
deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<DeleteCorsPolicyResponse> |
deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
Deletes the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<DescribeContainerResponse> |
describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
Retrieves the properties of the requested container.
|
default CompletableFuture<DescribeContainerResponse> |
describeContainer(DescribeContainerRequest describeContainerRequest)
Retrieves the properties of the requested container.
|
default CompletableFuture<GetContainerPolicyResponse> |
getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default CompletableFuture<GetContainerPolicyResponse> |
getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
Retrieves the access policy for the specified container.
|
default CompletableFuture<GetCorsPolicyResponse> |
getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<GetCorsPolicyResponse> |
getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
Returns the cross-origin resource sharing (CORS) configuration information that is set for the container.
|
default CompletableFuture<ListContainersResponse> |
listContainers()
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<ListContainersResponse> |
listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<ListContainersResponse> |
listContainers(ListContainersRequest listContainersRequest)
Lists the properties of all containers in AWS Elemental MediaStore.
|
default CompletableFuture<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 CompletableFuture<PutContainerPolicyResponse> |
putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
Creates an access policy for the specified container to restrict the users and clients that can access it.
|
default CompletableFuture<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 CompletableFuture<PutCorsPolicyResponse> |
putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
Sets the cross-origin resource sharing (CORS) configuration on a container so that the container can service
cross-origin requests.
|
serviceName
close
static final String SERVICE_NAME
static MediaStoreAsyncClient create()
MediaStoreAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static MediaStoreAsyncClientBuilder builder()
MediaStoreAsyncClient
.default CompletableFuture<CreateContainerResponse> createContainer(CreateContainerRequest createContainerRequest)
Creates a storage container to hold objects. A container is similar to a bucket in the Amazon S3 service.
createContainerRequest
- default CompletableFuture<CreateContainerResponse> createContainer(Consumer<CreateContainerRequest.Builder> createContainerRequest)
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.default CompletableFuture<DeleteContainerResponse> deleteContainer(DeleteContainerRequest deleteContainerRequest)
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
- default CompletableFuture<DeleteContainerResponse> deleteContainer(Consumer<DeleteContainerRequest.Builder> deleteContainerRequest)
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.default CompletableFuture<DeleteContainerPolicyResponse> deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)
Deletes the access policy that is associated with the specified container.
deleteContainerPolicyRequest
- default CompletableFuture<DeleteContainerPolicyResponse> deleteContainerPolicy(Consumer<DeleteContainerPolicyRequest.Builder> deleteContainerPolicyRequest)
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.default CompletableFuture<DeleteCorsPolicyResponse> deleteCorsPolicy(DeleteCorsPolicyRequest deleteCorsPolicyRequest)
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
- default CompletableFuture<DeleteCorsPolicyResponse> deleteCorsPolicy(Consumer<DeleteCorsPolicyRequest.Builder> deleteCorsPolicyRequest)
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.default CompletableFuture<DescribeContainerResponse> describeContainer(DescribeContainerRequest describeContainerRequest)
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
- default CompletableFuture<DescribeContainerResponse> describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)
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.default CompletableFuture<GetContainerPolicyResponse> getContainerPolicy(GetContainerPolicyRequest getContainerPolicyRequest)
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
- default CompletableFuture<GetContainerPolicyResponse> getContainerPolicy(Consumer<GetContainerPolicyRequest.Builder> getContainerPolicyRequest)
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.default CompletableFuture<GetCorsPolicyResponse> getCorsPolicy(GetCorsPolicyRequest getCorsPolicyRequest)
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
- default CompletableFuture<GetCorsPolicyResponse> getCorsPolicy(Consumer<GetCorsPolicyRequest.Builder> getCorsPolicyRequest)
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.default CompletableFuture<ListContainersResponse> listContainers(ListContainersRequest listContainersRequest)
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
- default CompletableFuture<ListContainersResponse> listContainers(Consumer<ListContainersRequest.Builder> listContainersRequest)
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.default CompletableFuture<ListContainersResponse> 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.
default CompletableFuture<PutContainerPolicyResponse> putContainerPolicy(PutContainerPolicyRequest putContainerPolicyRequest)
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
- default CompletableFuture<PutContainerPolicyResponse> putContainerPolicy(Consumer<PutContainerPolicyRequest.Builder> putContainerPolicyRequest)
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.default CompletableFuture<PutCorsPolicyResponse> putCorsPolicy(PutCorsPolicyRequest putCorsPolicyRequest)
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.
putCorsPolicyRequest
- default CompletableFuture<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. 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.
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.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.