software.amazon.awssdk.services.chimesdkmediapipelines

Interface ChimeSdkMediaPipelinesClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface ChimeSdkMediaPipelinesClient
extends SdkClient

Service client for accessing Amazon Chime SDK Media Pipelines. This can be created using the static builder() method.

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines and capture audio, video, events, and data messages from Amazon Chime SDK meetings. For more information about media pipleines, see Amzon Chime SDK media pipelines.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
static ChimeSdkMediaPipelinesClientBuilder	builder() Create a builder that can be used to configure and create a ChimeSdkMediaPipelinesClient.
static ChimeSdkMediaPipelinesClient	create() Create a ChimeSdkMediaPipelinesClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateMediaCapturePipelineResponse	createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest) Creates a media capture pipeline.
default CreateMediaCapturePipelineResponse	createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Creates a media capture pipeline.
default DeleteMediaCapturePipelineResponse	deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest) Deletes the media capture pipeline.
default DeleteMediaCapturePipelineResponse	deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deletes the media capture pipeline.
default GetMediaCapturePipelineResponse	getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest) Gets an existing media capture pipeline.
default GetMediaCapturePipelineResponse	getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest) Gets an existing media capture pipeline.
default ListMediaCapturePipelinesResponse	listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Returns a list of media capture pipelines.
default ListMediaCapturePipelinesResponse	listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Returns a list of media capture pipelines.
default ListMediaCapturePipelinesIterable	listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest) Returns a list of media capture pipelines.
default ListMediaCapturePipelinesIterable	listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Returns a list of media capture pipelines.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK media capture pipeline.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to an Amazon Chime SDK media capture pipeline.
static ServiceMetadata	serviceMetadata()
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest) Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

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

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

create

static ChimeSdkMediaPipelinesClient create()

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

builder

static ChimeSdkMediaPipelinesClientBuilder builder()

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

createMediaCapturePipeline

default CreateMediaCapturePipelineResponse createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest)
                                                               throws BadRequestException,
                                                                      ForbiddenException,
                                                                      UnauthorizedClientException,
                                                                      ThrottledClientException,
                                                                      ResourceLimitExceededException,
                                                                      ServiceUnavailableException,
                                                                      ServiceFailureException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ChimeSdkMediaPipelinesException

Creates a media capture pipeline.

Parameters:

createMediaCapturePipelineRequest -

Returns:

Result of the CreateMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

createMediaCapturePipeline

default CreateMediaCapturePipelineResponse createMediaCapturePipeline(Consumer<CreateMediaCapturePipelineRequest.Builder> createMediaCapturePipelineRequest)
                                                               throws BadRequestException,
                                                                      ForbiddenException,
                                                                      UnauthorizedClientException,
                                                                      ThrottledClientException,
                                                                      ResourceLimitExceededException,
                                                                      ServiceUnavailableException,
                                                                      ServiceFailureException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ChimeSdkMediaPipelinesException

Creates a media capture pipeline.

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

Parameters:

createMediaCapturePipelineRequest - A Consumer that will call methods on CreateMediaCapturePipelineRequest.Builder to create a request.

Returns:

Result of the CreateMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteMediaCapturePipeline

default DeleteMediaCapturePipelineResponse deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest)
                                                               throws BadRequestException,
                                                                      ForbiddenException,
                                                                      ThrottledClientException,
                                                                      NotFoundException,
                                                                      UnauthorizedClientException,
                                                                      ServiceUnavailableException,
                                                                      ServiceFailureException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ChimeSdkMediaPipelinesException

Deletes the media capture pipeline.

Parameters:

deleteMediaCapturePipelineRequest -

Returns:

Result of the DeleteMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

NotFoundException - One or more of the resources in the request does not exist in the system.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

deleteMediaCapturePipeline

default DeleteMediaCapturePipelineResponse deleteMediaCapturePipeline(Consumer<DeleteMediaCapturePipelineRequest.Builder> deleteMediaCapturePipelineRequest)
                                                               throws BadRequestException,
                                                                      ForbiddenException,
                                                                      ThrottledClientException,
                                                                      NotFoundException,
                                                                      UnauthorizedClientException,
                                                                      ServiceUnavailableException,
                                                                      ServiceFailureException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ChimeSdkMediaPipelinesException

Deletes the media capture pipeline.

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

Parameters:

deleteMediaCapturePipelineRequest - A Consumer that will call methods on DeleteMediaCapturePipelineRequest.Builder to create a request.

Returns:

Result of the DeleteMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

ThrottledClientException - The client exceeded its request rate limit.

NotFoundException - One or more of the resources in the request does not exist in the system.

UnauthorizedClientException - The client is not currently authorized to make the request.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMediaCapturePipeline

default GetMediaCapturePipelineResponse getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest)
                                                         throws BadRequestException,
                                                                ForbiddenException,
                                                                UnauthorizedClientException,
                                                                ThrottledClientException,
                                                                NotFoundException,
                                                                ServiceUnavailableException,
                                                                ServiceFailureException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ChimeSdkMediaPipelinesException

Gets an existing media capture pipeline.

Parameters:

getMediaCapturePipelineRequest -

Returns:

Result of the GetMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

NotFoundException - One or more of the resources in the request does not exist in the system.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

getMediaCapturePipeline

default GetMediaCapturePipelineResponse getMediaCapturePipeline(Consumer<GetMediaCapturePipelineRequest.Builder> getMediaCapturePipelineRequest)
                                                         throws BadRequestException,
                                                                ForbiddenException,
                                                                UnauthorizedClientException,
                                                                ThrottledClientException,
                                                                NotFoundException,
                                                                ServiceUnavailableException,
                                                                ServiceFailureException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                ChimeSdkMediaPipelinesException

Gets an existing media capture pipeline.

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

Parameters:

getMediaCapturePipelineRequest - A Consumer that will call methods on GetMediaCapturePipelineRequest.Builder to create a request.

Returns:

Result of the GetMediaCapturePipeline operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

NotFoundException - One or more of the resources in the request does not exist in the system.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listMediaCapturePipelines

default ListMediaCapturePipelinesResponse listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
                                                             throws BadRequestException,
                                                                    ForbiddenException,
                                                                    UnauthorizedClientException,
                                                                    ThrottledClientException,
                                                                    ResourceLimitExceededException,
                                                                    ServiceUnavailableException,
                                                                    ServiceFailureException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ChimeSdkMediaPipelinesException

Returns a list of media capture pipelines.

Parameters:

listMediaCapturePipelinesRequest -

Returns:

Result of the ListMediaCapturePipelines operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listMediaCapturePipelines

default ListMediaCapturePipelinesResponse listMediaCapturePipelines(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
                                                             throws BadRequestException,
                                                                    ForbiddenException,
                                                                    UnauthorizedClientException,
                                                                    ThrottledClientException,
                                                                    ResourceLimitExceededException,
                                                                    ServiceUnavailableException,
                                                                    ServiceFailureException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ChimeSdkMediaPipelinesException

Returns a list of media capture pipelines.

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

Parameters:

listMediaCapturePipelinesRequest - A Consumer that will call methods on ListMediaCapturePipelinesRequest.Builder to create a request.

Returns:

Result of the ListMediaCapturePipelines operation returned by the service.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listMediaCapturePipelinesPaginator

default ListMediaCapturePipelinesIterable listMediaCapturePipelinesPaginator(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)
                                                                      throws BadRequestException,
                                                                             ForbiddenException,
                                                                             UnauthorizedClientException,
                                                                             ThrottledClientException,
                                                                             ResourceLimitExceededException,
                                                                             ServiceUnavailableException,
                                                                             ServiceFailureException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             ChimeSdkMediaPipelinesException

Returns a list of media capture pipelines.

This is a variant of listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest) 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.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client
             .listMediaCapturePipelinesPaginator(request);
     for (software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(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 listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest) operation.

Parameters:

listMediaCapturePipelinesRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listMediaCapturePipelinesPaginator

default ListMediaCapturePipelinesIterable listMediaCapturePipelinesPaginator(Consumer<ListMediaCapturePipelinesRequest.Builder> listMediaCapturePipelinesRequest)
                                                                      throws BadRequestException,
                                                                             ForbiddenException,
                                                                             UnauthorizedClientException,
                                                                             ThrottledClientException,
                                                                             ResourceLimitExceededException,
                                                                             ServiceUnavailableException,
                                                                             ServiceFailureException,
                                                                             AwsServiceException,
                                                                             SdkClientException,
                                                                             ChimeSdkMediaPipelinesException

Returns a list of media capture pipelines.

This is a variant of listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest) 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.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client
             .listMediaCapturePipelinesPaginator(request);
     for (software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.chimesdkmediapipelines.paginators.ListMediaCapturePipelinesIterable responses = client.listMediaCapturePipelinesPaginator(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 listMediaCapturePipelines(software.amazon.awssdk.services.chimesdkmediapipelines.model.ListMediaCapturePipelinesRequest) operation.

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

Parameters:

listMediaCapturePipelinesRequest - A Consumer that will call methods on ListMediaCapturePipelinesRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

Throws:

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ResourceLimitExceededException - The request exceeds the resource limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        ForbiddenException,
                                                        UnauthorizedClientException,
                                                        ThrottledClientException,
                                                        ServiceUnavailableException,
                                                        ServiceFailureException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ChimeSdkMediaPipelinesException

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws NotFoundException,
                                                        BadRequestException,
                                                        ForbiddenException,
                                                        UnauthorizedClientException,
                                                        ThrottledClientException,
                                                        ServiceUnavailableException,
                                                        ServiceFailureException,
                                                        AwsServiceException,
                                                        SdkClientException,
                                                        ChimeSdkMediaPipelinesException

Lists the tags applied to an Amazon Chime SDK media capture pipeline.

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

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws NotFoundException,
                                        BadRequestException,
                                        ForbiddenException,
                                        UnauthorizedClientException,
                                        ThrottledClientException,
                                        ServiceUnavailableException,
                                        ServiceFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ChimeSdkMediaPipelinesException

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws NotFoundException,
                                        BadRequestException,
                                        ForbiddenException,
                                        UnauthorizedClientException,
                                        ThrottledClientException,
                                        ServiceUnavailableException,
                                        ServiceFailureException,
                                        AwsServiceException,
                                        SdkClientException,
                                        ChimeSdkMediaPipelinesException

Applies the specified tags to the specified Amazon Chime SDK media capture pipeline.

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

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            ForbiddenException,
                                            UnauthorizedClientException,
                                            ThrottledClientException,
                                            ServiceUnavailableException,
                                            ServiceFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ChimeSdkMediaPipelinesException

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws NotFoundException,
                                            BadRequestException,
                                            ForbiddenException,
                                            UnauthorizedClientException,
                                            ThrottledClientException,
                                            ServiceUnavailableException,
                                            ServiceFailureException,
                                            AwsServiceException,
                                            SdkClientException,
                                            ChimeSdkMediaPipelinesException

Removes the specified tags from the specified Amazon Chime SDK media capture pipeline.

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

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException - One or more of the resources in the request does not exist in the system.

BadRequestException - The input parameters don't match the service's restrictions.

ForbiddenException - The client is permanently forbidden from making the request.

UnauthorizedClientException - The client is not currently authorized to make the request.

ThrottledClientException - The client exceeded its request rate limit.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

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.

ChimeSdkMediaPipelinesException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.

AwsServiceException

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()