com.amazonaws.services.mediaconnect

Class AWSMediaConnectClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.mediaconnect.AWSMediaConnectClient

All Implemented Interfaces:

AWSMediaConnect

Direct Known Subclasses:

AWSMediaConnectAsyncClient

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

Client for accessing AWS MediaConnect. All service calls made using this client are blocking, and will not return until the service call completes.

API for AWS Elemental MediaConnect

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.mediaconnect.AWSMediaConnect

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
AddFlowOutputsResult	addFlowOutputs(AddFlowOutputsRequest request) Adds outputs to an existing flow.
static AWSMediaConnectClientBuilder	builder()
CreateFlowResult	createFlow(CreateFlowRequest request) Creates a new flow.
DeleteFlowResult	deleteFlow(DeleteFlowRequest request) Deletes a flow.
DescribeFlowResult	describeFlow(DescribeFlowRequest request) 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 request) Grants entitlements to an existing flow.
ListEntitlementsResult	listEntitlements(ListEntitlementsRequest request) Displays a list of all entitlements that have been granted to this account.
ListFlowsResult	listFlows(ListFlowsRequest request) Displays a list of flows that are associated with this account.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest request) List all tags on an AWS Elemental MediaConnect resource
RemoveFlowOutputResult	removeFlowOutput(RemoveFlowOutputRequest request) Removes an output from an existing flow.
RevokeFlowEntitlementResult	revokeFlowEntitlement(RevokeFlowEntitlementRequest request) Revokes an entitlement from a flow.
StartFlowResult	startFlow(StartFlowRequest request) Starts a flow.
StopFlowResult	stopFlow(StopFlowRequest request) Stops a flow.
TagResourceResult	tagResource(TagResourceRequest request) Associates the specified tags to a resource with the specified resourceArn.
UntagResourceResult	untagResource(UntagResourceRequest request) Deletes specified tags from a resource.
UpdateFlowEntitlementResult	updateFlowEntitlement(UpdateFlowEntitlementRequest request) You can change an entitlement's description, subscribers, and encryption.
UpdateFlowOutputResult	updateFlowOutput(UpdateFlowOutputRequest request) Updates an existing flow output.
UpdateFlowSourceResult	updateFlowSource(UpdateFlowSourceRequest request) Updates the source of a flow.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.mediaconnect.AWSMediaConnect

shutdown

Method Detail

builder

public static AWSMediaConnectClientBuilder builder()

addFlowOutputs

public AddFlowOutputsResult addFlowOutputs(AddFlowOutputsRequest request)

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

Specified by:

addFlowOutputs in interface AWSMediaConnect

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

public CreateFlowResult createFlow(CreateFlowRequest request)

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

Specified by:

createFlow in interface AWSMediaConnect

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

public DeleteFlowResult deleteFlow(DeleteFlowRequest request)

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

Specified by:

deleteFlow in interface AWSMediaConnect

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

public DescribeFlowResult describeFlow(DescribeFlowRequest request)

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.

Specified by:

describeFlow in interface AWSMediaConnect

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

public GrantFlowEntitlementsResult grantFlowEntitlements(GrantFlowEntitlementsRequest request)

Grants entitlements to an existing flow.

Specified by:

grantFlowEntitlements in interface AWSMediaConnect

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

public ListEntitlementsResult listEntitlements(ListEntitlementsRequest request)

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

Specified by:

listEntitlements in interface AWSMediaConnect

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

public ListFlowsResult listFlows(ListFlowsRequest request)

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

Specified by:

listFlows in interface AWSMediaConnect

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

public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)

List all tags on an AWS Elemental MediaConnect resource

Specified by:

listTagsForResource in interface AWSMediaConnect

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

public RemoveFlowOutputResult removeFlowOutput(RemoveFlowOutputRequest request)

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.

Specified by:

removeFlowOutput in interface AWSMediaConnect

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

public RevokeFlowEntitlementResult revokeFlowEntitlement(RevokeFlowEntitlementRequest request)

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

Specified by:

revokeFlowEntitlement in interface AWSMediaConnect

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

public StartFlowResult startFlow(StartFlowRequest request)

Starts a flow.

Specified by:

startFlow in interface AWSMediaConnect

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

public StopFlowResult stopFlow(StopFlowRequest request)

Stops a flow.

Specified by:

stopFlow in interface AWSMediaConnect

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

public TagResourceResult tagResource(TagResourceRequest request)

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.

Specified by:

tagResource in interface AWSMediaConnect

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

public UntagResourceResult untagResource(UntagResourceRequest request)

Deletes specified tags from a resource.

Specified by:

untagResource in interface AWSMediaConnect

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

public UpdateFlowEntitlementResult updateFlowEntitlement(UpdateFlowEntitlementRequest request)

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.

Specified by:

updateFlowEntitlement in interface AWSMediaConnect

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

public UpdateFlowOutputResult updateFlowOutput(UpdateFlowOutputRequest request)

Updates an existing flow output.

Specified by:

updateFlowOutput in interface AWSMediaConnect

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

public UpdateFlowSourceResult updateFlowSource(UpdateFlowSourceRequest request)

Updates the source of a flow.

Specified by:

updateFlowSource in interface AWSMediaConnect

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

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 AWSMediaConnect

Parameters:

request - The originally executed request

Returns:

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