com.amazonaws.services.chimesdkmediapipelines

Class AmazonChimeSDKMediaPipelinesClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.chimesdkmediapipelines.AmazonChimeSDKMediaPipelinesClient

All Implemented Interfaces:

AmazonChimeSDKMediaPipelines

Direct Known Subclasses:

AmazonChimeSDKMediaPipelinesAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AmazonChimeSDKMediaPipelinesClient
extends AmazonWebServiceClient
implements AmazonChimeSDKMediaPipelines

Client for accessing Amazon Chime SDK Media Pipelines. All service calls made using this client are blocking, and will not return until the service call completes.

The Amazon Chime SDK media pipeline APIs in this section allow software developers to create Amazon Chime SDK media pipelines that capture, concatenate, or stream your Amazon Chime SDK meetings. For more information about media pipleines, see Amazon Chime SDK media pipelines.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.chimesdkmediapipelines.AmazonChimeSDKMediaPipelines

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AmazonChimeSDKMediaPipelinesClientBuilder	builder()
CreateMediaCapturePipelineResult	createMediaCapturePipeline(CreateMediaCapturePipelineRequest request) Creates a media pipeline.
CreateMediaConcatenationPipelineResult	createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest request) Creates a media concatenation pipeline.
CreateMediaLiveConnectorPipelineResult	createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest request) Creates a streaming media pipeline in an Amazon Chime SDK meeting.
DeleteMediaCapturePipelineResult	deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request) Deletes the media pipeline.
DeleteMediaPipelineResult	deleteMediaPipeline(DeleteMediaPipelineRequest request) Deletes the media pipeline.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetMediaCapturePipelineResult	getMediaCapturePipeline(GetMediaCapturePipelineRequest request) Gets an existing media pipeline.
GetMediaPipelineResult	getMediaPipeline(GetMediaPipelineRequest request) Gets an existing media pipeline.
ListMediaCapturePipelinesResult	listMediaCapturePipelines(ListMediaCapturePipelinesRequest request) Returns a list of media pipelines.
ListMediaPipelinesResult	listMediaPipelines(ListMediaPipelinesRequest request) Returns a list of media pipelines.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) Lists the tags available for a media pipeline.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TagResourceResult	tagResource(TagResourceRequest request) The ARN of the media pipeline that you want to tag.
UntagResourceResult	untagResource(UntagResourceRequest request) Removes any tags from a media pipeline.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AmazonChimeSDKMediaPipelinesClientBuilder builder()

createMediaCapturePipeline

public CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest request)

Creates a media pipeline.

Specified by:

createMediaCapturePipeline in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

createMediaConcatenationPipeline

public CreateMediaConcatenationPipelineResult createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest request)

Creates a media concatenation pipeline.

Specified by:

createMediaConcatenationPipeline in interface AmazonChimeSDKMediaPipelines

Parameters:

createMediaConcatenationPipelineRequest -

Returns:

Result of the CreateMediaConcatenationPipeline 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.

See Also:

AWS API Documentation

createMediaLiveConnectorPipeline

public CreateMediaLiveConnectorPipelineResult createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest request)

Creates a streaming media pipeline in an Amazon Chime SDK meeting.

Specified by:

createMediaLiveConnectorPipeline in interface AmazonChimeSDKMediaPipelines

Parameters:

createMediaLiveConnectorPipelineRequest -

Returns:

Result of the CreateMediaLiveConnectorPipeline 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.

See Also:

AWS API Documentation

deleteMediaCapturePipeline

public DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest request)

Deletes the media pipeline.

Specified by:

deleteMediaCapturePipeline in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

deleteMediaPipeline

public DeleteMediaPipelineResult deleteMediaPipeline(DeleteMediaPipelineRequest request)

Deletes the media pipeline.

Specified by:

deleteMediaPipeline in interface AmazonChimeSDKMediaPipelines

Parameters:

deleteMediaPipelineRequest -

Returns:

Result of the DeleteMediaPipeline 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.

See Also:

AWS API Documentation

getMediaCapturePipeline

public GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest request)

Gets an existing media pipeline.

Specified by:

getMediaCapturePipeline in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

getMediaPipeline

public GetMediaPipelineResult getMediaPipeline(GetMediaPipelineRequest request)

Gets an existing media pipeline.

Specified by:

getMediaPipeline in interface AmazonChimeSDKMediaPipelines

Parameters:

getMediaPipelineRequest -

Returns:

Result of the GetMediaPipeline 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.

See Also:

AWS API Documentation

listMediaCapturePipelines

public ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest request)

Returns a list of media pipelines.

Specified by:

listMediaCapturePipelines in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

listMediaPipelines

public ListMediaPipelinesResult listMediaPipelines(ListMediaPipelinesRequest request)

Returns a list of media pipelines.

Specified by:

listMediaPipelines in interface AmazonChimeSDKMediaPipelines

Parameters:

listMediaPipelinesRequest -

Returns:

Result of the ListMediaPipelines 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.

See Also:

AWS API Documentation

listTagsForResource

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

Lists the tags available for a media pipeline.

Specified by:

listTagsForResource in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

tagResource

public TagResourceResult tagResource(TagResourceRequest request)

The ARN of the media pipeline that you want to tag. Consists of he pipeline's endpoint region, resource ID, and pipeline ID.

Specified by:

tagResource in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

untagResource

public UntagResourceResult untagResource(UntagResourceRequest request)

Removes any tags from a media pipeline.

Specified by:

untagResource in interface AmazonChimeSDKMediaPipelines

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AmazonChimeSDKMediaPipelines

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AmazonChimeSDKMediaPipelines

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AmazonChimeSDKMediaPipelines

Overrides:

shutdown in class AmazonWebServiceClient