com.amazonaws.services.chimesdkmediapipelines

Interface AmazonChimeSDKMediaPipelines

All Known Subinterfaces:

AmazonChimeSDKMediaPipelinesAsync

All Known Implementing Classes:

AbstractAmazonChimeSDKMediaPipelines, AbstractAmazonChimeSDKMediaPipelinesAsync, AmazonChimeSDKMediaPipelinesAsyncClient, AmazonChimeSDKMediaPipelinesClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonChimeSDKMediaPipelines

Interface for accessing Amazon Chime SDK Media Pipelines.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonChimeSDKMediaPipelines instead.

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 pipelines, see Amazon Chime SDK media pipelines.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateMediaCapturePipelineResult	createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest) Creates a media pipeline.
CreateMediaConcatenationPipelineResult	createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest createMediaConcatenationPipelineRequest) Creates a media concatenation pipeline.
CreateMediaInsightsPipelineResult	createMediaInsightsPipeline(CreateMediaInsightsPipelineRequest createMediaInsightsPipelineRequest) Creates a media insights pipeline.
CreateMediaInsightsPipelineConfigurationResult	createMediaInsightsPipelineConfiguration(CreateMediaInsightsPipelineConfigurationRequest createMediaInsightsPipelineConfigurationRequest) A structure that contains the static configurations for a media insights pipeline.
CreateMediaLiveConnectorPipelineResult	createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest createMediaLiveConnectorPipelineRequest) Creates a media live connector pipeline in an Amazon Chime SDK meeting.
DeleteMediaCapturePipelineResult	deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest) Deletes the media pipeline.
DeleteMediaInsightsPipelineConfigurationResult	deleteMediaInsightsPipelineConfiguration(DeleteMediaInsightsPipelineConfigurationRequest deleteMediaInsightsPipelineConfigurationRequest) Deletes the specified configuration settings.
DeleteMediaPipelineResult	deleteMediaPipeline(DeleteMediaPipelineRequest deleteMediaPipelineRequest) 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 getMediaCapturePipelineRequest) Gets an existing media pipeline.
GetMediaInsightsPipelineConfigurationResult	getMediaInsightsPipelineConfiguration(GetMediaInsightsPipelineConfigurationRequest getMediaInsightsPipelineConfigurationRequest) Gets the configuration settings for a media insights pipeline.
GetMediaPipelineResult	getMediaPipeline(GetMediaPipelineRequest getMediaPipelineRequest) Gets an existing media pipeline.
ListMediaCapturePipelinesResult	listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest) Returns a list of media pipelines.
ListMediaInsightsPipelineConfigurationsResult	listMediaInsightsPipelineConfigurations(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest) Lists the available media insights pipeline configurations.
ListMediaPipelinesResult	listMediaPipelines(ListMediaPipelinesRequest listMediaPipelinesRequest) Returns a list of media pipelines.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) 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 tagResourceRequest) The ARN of the media pipeline that you want to tag.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes any tags from a media pipeline.
UpdateMediaInsightsPipelineConfigurationResult	updateMediaInsightsPipelineConfiguration(UpdateMediaInsightsPipelineConfigurationRequest updateMediaInsightsPipelineConfigurationRequest) Updates the media insights pipeline's configuration settings.
UpdateMediaInsightsPipelineStatusResult	updateMediaInsightsPipelineStatus(UpdateMediaInsightsPipelineStatusRequest updateMediaInsightsPipelineStatusRequest) Updates the status of a media insights pipeline.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createMediaCapturePipeline

CreateMediaCapturePipelineResult createMediaCapturePipeline(CreateMediaCapturePipelineRequest createMediaCapturePipelineRequest)

Creates a media 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.

See Also:

AWS API Documentation

createMediaConcatenationPipeline

CreateMediaConcatenationPipelineResult createMediaConcatenationPipeline(CreateMediaConcatenationPipelineRequest createMediaConcatenationPipelineRequest)

Creates a media concatenation pipeline.

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

createMediaInsightsPipeline

CreateMediaInsightsPipelineResult createMediaInsightsPipeline(CreateMediaInsightsPipelineRequest createMediaInsightsPipelineRequest)

Creates a media insights pipeline.

Parameters:

createMediaInsightsPipelineRequest -

Returns:

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

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

createMediaInsightsPipelineConfiguration

CreateMediaInsightsPipelineConfigurationResult createMediaInsightsPipelineConfiguration(CreateMediaInsightsPipelineConfigurationRequest createMediaInsightsPipelineConfigurationRequest)

A structure that contains the static configurations for a media insights pipeline.

Parameters:

createMediaInsightsPipelineConfigurationRequest -

Returns:

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

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.

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

CreateMediaLiveConnectorPipelineResult createMediaLiveConnectorPipeline(CreateMediaLiveConnectorPipelineRequest createMediaLiveConnectorPipelineRequest)

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

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

DeleteMediaCapturePipelineResult deleteMediaCapturePipeline(DeleteMediaCapturePipelineRequest deleteMediaCapturePipelineRequest)

Deletes the media 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.

See Also:

AWS API Documentation

deleteMediaInsightsPipelineConfiguration

DeleteMediaInsightsPipelineConfigurationResult deleteMediaInsightsPipelineConfiguration(DeleteMediaInsightsPipelineConfigurationRequest deleteMediaInsightsPipelineConfigurationRequest)

Deletes the specified configuration settings.

Parameters:

deleteMediaInsightsPipelineConfigurationRequest -

Returns:

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

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

deleteMediaPipeline

DeleteMediaPipelineResult deleteMediaPipeline(DeleteMediaPipelineRequest deleteMediaPipelineRequest)

Deletes the media pipeline.

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

GetMediaCapturePipelineResult getMediaCapturePipeline(GetMediaCapturePipelineRequest getMediaCapturePipelineRequest)

Gets an existing media 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.

See Also:

AWS API Documentation

getMediaInsightsPipelineConfiguration

GetMediaInsightsPipelineConfigurationResult getMediaInsightsPipelineConfiguration(GetMediaInsightsPipelineConfigurationRequest getMediaInsightsPipelineConfigurationRequest)

Gets the configuration settings for a media insights pipeline.

Parameters:

getMediaInsightsPipelineConfigurationRequest -

Returns:

Result of the GetMediaInsightsPipelineConfiguration 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

GetMediaPipelineResult getMediaPipeline(GetMediaPipelineRequest getMediaPipelineRequest)

Gets an existing media pipeline.

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

ListMediaCapturePipelinesResult listMediaCapturePipelines(ListMediaCapturePipelinesRequest listMediaCapturePipelinesRequest)

Returns a list of media 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.

See Also:

AWS API Documentation

listMediaInsightsPipelineConfigurations

ListMediaInsightsPipelineConfigurationsResult listMediaInsightsPipelineConfigurations(ListMediaInsightsPipelineConfigurationsRequest listMediaInsightsPipelineConfigurationsRequest)

Lists the available media insights pipeline configurations.

Parameters:

listMediaInsightsPipelineConfigurationsRequest -

Returns:

Result of the ListMediaInsightsPipelineConfigurations 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

ListMediaPipelinesResult listMediaPipelines(ListMediaPipelinesRequest listMediaPipelinesRequest)

Returns a list of media pipelines.

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

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags available for a media 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.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

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

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

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes any tags from a media 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.

See Also:

AWS API Documentation

updateMediaInsightsPipelineConfiguration

UpdateMediaInsightsPipelineConfigurationResult updateMediaInsightsPipelineConfiguration(UpdateMediaInsightsPipelineConfigurationRequest updateMediaInsightsPipelineConfigurationRequest)

Updates the media insights pipeline's configuration settings.

Parameters:

updateMediaInsightsPipelineConfigurationRequest -

Returns:

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

ConflictException - The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException - The service is currently unavailable.

ServiceFailureException - The service encountered an unexpected error.

See Also:

AWS API Documentation

updateMediaInsightsPipelineStatus

UpdateMediaInsightsPipelineStatusResult updateMediaInsightsPipelineStatus(UpdateMediaInsightsPipelineStatusRequest updateMediaInsightsPipelineStatusRequest)

Updates the status of a media insights pipeline.

Parameters:

updateMediaInsightsPipelineStatusRequest -

Returns:

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

ConflictException - The request could not be processed because of conflict in the current state of the resource.

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

shutdown

void shutdown()

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.

getCachedResponseMetadata

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

Parameters:

request - The originally executed request.

Returns:

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