com.amazonaws.services.mediaconnect

Interface AWSMediaConnect

All Known Subinterfaces:

AWSMediaConnectAsync

All Known Implementing Classes:

AbstractAWSMediaConnect, AbstractAWSMediaConnectAsync, AWSMediaConnectAsyncClient, AWSMediaConnectClient

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

Interface for accessing AWS MediaConnect.

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

API for AWS Elemental MediaConnect

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
AddFlowOutputsResult	addFlowOutputs(AddFlowOutputsRequest addFlowOutputsRequest) Adds outputs to an existing flow.
CreateFlowResult	createFlow(CreateFlowRequest createFlowRequest) Creates a new flow.
DeleteFlowResult	deleteFlow(DeleteFlowRequest deleteFlowRequest) Deletes a flow.
DescribeFlowResult	describeFlow(DescribeFlowRequest describeFlowRequest) Displays the details of a flow.
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.
GrantFlowEntitlementsResult	grantFlowEntitlements(GrantFlowEntitlementsRequest grantFlowEntitlementsRequest) Grants entitlements to an existing flow.
ListEntitlementsResult	listEntitlements(ListEntitlementsRequest listEntitlementsRequest) Displays a list of all entitlements that have been granted to this account.
ListFlowsResult	listFlows(ListFlowsRequest listFlowsRequest) Displays a list of flows that are associated with this account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List all tags on an AWS Elemental MediaConnect resource
RemoveFlowOutputResult	removeFlowOutput(RemoveFlowOutputRequest removeFlowOutputRequest) Removes an output from an existing flow.
RevokeFlowEntitlementResult	revokeFlowEntitlement(RevokeFlowEntitlementRequest revokeFlowEntitlementRequest) Revokes an entitlement from a flow.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartFlowResult	startFlow(StartFlowRequest startFlowRequest) Starts a flow.
StopFlowResult	stopFlow(StopFlowRequest stopFlowRequest) Stops a flow.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.
UpdateFlowEntitlementResult	updateFlowEntitlement(UpdateFlowEntitlementRequest updateFlowEntitlementRequest) You can change an entitlement's description, subscribers, and encryption.
UpdateFlowOutputResult	updateFlowOutput(UpdateFlowOutputRequest updateFlowOutputRequest) Updates an existing flow output.
UpdateFlowSourceResult	updateFlowSource(UpdateFlowSourceRequest updateFlowSourceRequest) Updates the source of a flow.

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

addFlowOutputs

AddFlowOutputsResult addFlowOutputs(AddFlowOutputsRequest addFlowOutputsRequest)

Adds outputs to an existing flow. You can create up to 20 outputs per flow.

Parameters:

addFlowOutputsRequest - A request to add outputs to the specified flow.

Returns:

Result of the AddFlowOutputs operation returned by the service.

Throws:

AddFlowOutputs420Exception - AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed outputs (20). For more information, contact AWS Customer Support.

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

createFlow

CreateFlowResult createFlow(CreateFlowRequest createFlowRequest)

Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).

Parameters:

createFlowRequest - Creates a new flow. The request must include one source. The request optionally can include outputs (up to 20) and entitlements (up to 50).

Returns:

Result of the CreateFlow operation returned by the service.

Throws:

CreateFlow420Exception - Your account already contains the maximum number of 20 flows per account, per Region. For more information, contact AWS Customer Support.

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

deleteFlow

DeleteFlowResult deleteFlow(DeleteFlowRequest deleteFlowRequest)

Deletes a flow. Before you can delete a flow, you must stop the flow.

Parameters:

deleteFlowRequest -

Returns:

Result of the DeleteFlow operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

describeFlow

DescribeFlowResult describeFlow(DescribeFlowRequest describeFlowRequest)

Displays the details of a flow. The response includes the flow ARN, name, and Availability Zone, as well as details about the source, outputs, and entitlements.

Parameters:

describeFlowRequest -

Returns:

Result of the DescribeFlow operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

grantFlowEntitlements

GrantFlowEntitlementsResult grantFlowEntitlements(GrantFlowEntitlementsRequest grantFlowEntitlementsRequest)

Grants entitlements to an existing flow.

Parameters:

grantFlowEntitlementsRequest - A request to grant entitlements on a flow.

Returns:

Result of the GrantFlowEntitlements operation returned by the service.

Throws:

GrantFlowEntitlements420Exception - AWS Elemental MediaConnect can't complete this request because this flow already has the maximum number of allowed entitlements (50). For more information, contact AWS Customer Support.

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

listEntitlements

ListEntitlementsResult listEntitlements(ListEntitlementsRequest listEntitlementsRequest)

Displays a list of all entitlements that have been granted to this account. This request returns 20 results per page.

Parameters:

listEntitlementsRequest -

Returns:

Result of the ListEntitlements operation returned by the service.

Throws:

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

See Also:

AWS API Documentation

listFlows

ListFlowsResult listFlows(ListFlowsRequest listFlowsRequest)

Displays a list of flows that are associated with this account. This request returns a paginated result.

Parameters:

listFlowsRequest -

Returns:

Result of the ListFlows operation returned by the service.

Throws:

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

List all tags on an AWS Elemental MediaConnect resource

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

NotFoundException - The requested resource was not found

BadRequestException - The client performed an invalid request

InternalServerErrorException - Internal service error

See Also:

AWS API Documentation

removeFlowOutput

RemoveFlowOutputResult removeFlowOutput(RemoveFlowOutputRequest removeFlowOutputRequest)

Removes an output from an existing flow. This request can be made only on an output that does not have an entitlement associated with it. If the output has an entitlement, you must revoke the entitlement instead. When an entitlement is revoked from a flow, the service automatically removes the associated output.

Parameters:

removeFlowOutputRequest -

Returns:

Result of the RemoveFlowOutput operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

revokeFlowEntitlement

RevokeFlowEntitlementResult revokeFlowEntitlement(RevokeFlowEntitlementRequest revokeFlowEntitlementRequest)

Revokes an entitlement from a flow. Once an entitlement is revoked, the content becomes unavailable to the subscriber and the associated output is removed.

Parameters:

revokeFlowEntitlementRequest -

Returns:

Result of the RevokeFlowEntitlement operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

startFlow

StartFlowResult startFlow(StartFlowRequest startFlowRequest)

Starts a flow.

Parameters:

startFlowRequest -

Returns:

Result of the StartFlow operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

stopFlow

StopFlowResult stopFlow(StopFlowRequest stopFlowRequest)

Stops a flow.

Parameters:

stopFlowRequest -

Returns:

Result of the StopFlow operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

Parameters:

tagResourceRequest - The tags to add to the resource. A tag is an array of key-value pairs. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Returns:

Result of the TagResource operation returned by the service.

Throws:

NotFoundException - The requested resource was not found

BadRequestException - The client performed an invalid request

InternalServerErrorException - Internal service error

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Deletes specified tags from a resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

NotFoundException - The requested resource was not found

BadRequestException - The client performed an invalid request

InternalServerErrorException - Internal service error

See Also:

AWS API Documentation

updateFlowEntitlement

UpdateFlowEntitlementResult updateFlowEntitlement(UpdateFlowEntitlementRequest updateFlowEntitlementRequest)

You can change an entitlement's description, subscribers, and encryption. If you change the subscribers, the service will remove the outputs that are are used by the subscribers that are removed.

Parameters:

updateFlowEntitlementRequest - The entitlement fields that you want to update.

Returns:

Result of the UpdateFlowEntitlement operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

updateFlowOutput

UpdateFlowOutputResult updateFlowOutput(UpdateFlowOutputRequest updateFlowOutputRequest)

Updates an existing flow output.

Parameters:

updateFlowOutputRequest - The fields that you want to update in the output.

Returns:

Result of the UpdateFlowOutput operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

See Also:

AWS API Documentation

updateFlowSource

UpdateFlowSourceResult updateFlowSource(UpdateFlowSourceRequest updateFlowSourceRequest)

Updates the source of a flow.

Parameters:

updateFlowSourceRequest - A request to update the source of a flow.

Returns:

Result of the UpdateFlowSource operation returned by the service.

Throws:

BadRequestException - The request that you submitted is not valid.

InternalServerErrorException - AWS Elemental MediaConnect can't fulfill your request because it encountered an unexpected condition.

ForbiddenException - You don't have the required permissions to perform this operation.

NotFoundException - AWS Elemental MediaConnect did not find the resource that you specified in the request.

ServiceUnavailableException - AWS Elemental MediaConnect is currently unavailable. Try again later.

TooManyRequestsException - You have exceeded the service request rate limit for your AWS Elemental MediaConnect account.

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.