software.amazon.awssdk.services.mediastore

Interface MediaStoreAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface MediaStoreAsyncClient
extends SdkClient, SdkAutoCloseable

Service client for accessing MediaStore asynchronously. This can be created using the static 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

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

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static MediaStoreAsyncClient create()

Create a MediaStoreAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static MediaStoreAsyncClientBuilder builder()

Create a builder that can be used to configure and create a MediaStoreAsyncClient.

createContainer

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.

Parameters:

createContainerRequest -

Returns:

A Java Future containing the result of the CreateContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

createContainer

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

Parameters:

createContainerRequest - A Consumer that will call methods on CreateContainerInput.Builder to create a request.

Returns:

A Java Future containing the result of the CreateContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

deleteContainer

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.

Parameters:

deleteContainerRequest -

Returns:

A Java Future containing the result of the DeleteContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that 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.

See Also:

AWS API Documentation

deleteContainer

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

Parameters:

deleteContainerRequest - A Consumer that will call methods on DeleteContainerInput.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that 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.

See Also:

AWS API Documentation

deleteContainerPolicy

default CompletableFuture<DeleteContainerPolicyResponse> deleteContainerPolicy(DeleteContainerPolicyRequest deleteContainerPolicyRequest)

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

Parameters:

deleteContainerPolicyRequest -

Returns:

A Java Future containing the result of the DeleteContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• PolicyNotFoundException Could not perform an operation on a policy that 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.

See Also:

AWS API Documentation

deleteContainerPolicy

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

Parameters:

deleteContainerPolicyRequest - A Consumer that will call methods on DeleteContainerPolicyInput.Builder to create a request.

Returns:

A Java Future containing the result of the DeleteContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• PolicyNotFoundException Could not perform an operation on a policy that 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.

See Also:

AWS API Documentation

describeContainer

default CompletableFuture<DescribeContainerResponse> describeContainer(DescribeContainerRequest describeContainerRequest)

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

Parameters:

describeContainerRequest -

Returns:

A Java Future containing the result of the DescribeContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerNotFoundException Could not perform an operation on a container that 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.

See Also:

AWS API Documentation

describeContainer

default CompletableFuture<DescribeContainerResponse> describeContainer(Consumer<DescribeContainerRequest.Builder> describeContainerRequest)

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

This is a convenience which creates an instance of the DescribeContainerRequest.Builder avoiding the need to create one manually via DescribeContainerRequest.builder()

Parameters:

describeContainerRequest - A Consumer that will call methods on DescribeContainerInput.Builder to create a request.

Returns:

A Java Future containing the result of the DescribeContainer operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerNotFoundException Could not perform an operation on a container that 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.

See Also:

AWS API Documentation

getContainerPolicy

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.

Parameters:

getContainerPolicyRequest -

Returns:

A Java Future containing the result of the GetContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• PolicyNotFoundException Could not perform an operation on a policy that 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.

See Also:

AWS API Documentation

getContainerPolicy

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

Parameters:

getContainerPolicyRequest - A Consumer that will call methods on GetContainerPolicyInput.Builder to create a request.

Returns:

A Java Future containing the result of the GetContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerInUseException Resource already exists or is being updated.
• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• PolicyNotFoundException Could not perform an operation on a policy that 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.

See Also:

AWS API Documentation

listContainers

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.

Parameters:

listContainersRequest -

Returns:

A Java Future containing the result of the ListContainers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

listContainers

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

Parameters:

listContainersRequest - A Consumer that will call methods on ListContainersInput.Builder to create a request.

Returns:

A Java Future containing the result of the ListContainers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

listContainers

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.

Returns:

A Java Future containing the result of the ListContainers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

putContainerPolicy

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.

Parameters:

putContainerPolicyRequest -

Returns:

A Java Future containing the result of the PutContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• ContainerInUseException Resource 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.

See Also:

AWS API Documentation

putContainerPolicy

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

Parameters:

putContainerPolicyRequest - A Consumer that will call methods on PutContainerPolicyInput.Builder to create a request.

Returns:

A Java Future containing the result of the PutContainerPolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

• ContainerNotFoundException Could not perform an operation on a container that does not exist.
• ContainerInUseException Resource 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.

See Also:

AWS API Documentation