com.amazonaws.services.medialive

Class AWSMediaLiveClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.medialive.AWSMediaLiveClient

All Implemented Interfaces:

AWSMediaLive

Direct Known Subclasses:

AWSMediaLiveAsyncClient

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

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

API for AWS Elemental MediaLive

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, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.medialive.AWSMediaLive

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
BatchUpdateScheduleResult	batchUpdateSchedule(BatchUpdateScheduleRequest request) Update a channel schedule
static AWSMediaLiveClientBuilder	builder()
CreateChannelResult	createChannel(CreateChannelRequest request) Creates a new channel
CreateInputResult	createInput(CreateInputRequest request) Create an input
CreateInputSecurityGroupResult	createInputSecurityGroup(CreateInputSecurityGroupRequest request) Creates a Input Security Group
DeleteChannelResult	deleteChannel(DeleteChannelRequest request) Starts deletion of channel.
DeleteInputResult	deleteInput(DeleteInputRequest request) Deletes the input end point
DeleteInputSecurityGroupResult	deleteInputSecurityGroup(DeleteInputSecurityGroupRequest request) Deletes an Input Security Group
DeleteReservationResult	deleteReservation(DeleteReservationRequest request) Delete an expired reservation.
DescribeChannelResult	describeChannel(DescribeChannelRequest request) Gets details about a channel
DescribeInputResult	describeInput(DescribeInputRequest request) Produces details about an input
DescribeInputSecurityGroupResult	describeInputSecurityGroup(DescribeInputSecurityGroupRequest request) Produces a summary of an Input Security Group
DescribeOfferingResult	describeOffering(DescribeOfferingRequest request) Get details for an offering.
DescribeReservationResult	describeReservation(DescribeReservationRequest request) Get details for a reservation.
DescribeScheduleResult	describeSchedule(DescribeScheduleRequest request) Get a channel schedule
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.
ListChannelsResult	listChannels(ListChannelsRequest request) Produces list of channels that have been created
ListInputsResult	listInputs(ListInputsRequest request) Produces list of inputs that have been created
ListInputSecurityGroupsResult	listInputSecurityGroups(ListInputSecurityGroupsRequest request) Produces a list of Input Security Groups for an account
ListOfferingsResult	listOfferings(ListOfferingsRequest request) List offerings available for purchase.
ListReservationsResult	listReservations(ListReservationsRequest request) List purchased reservations.
PurchaseOfferingResult	purchaseOffering(PurchaseOfferingRequest request) Purchase an offering and create a reservation.
StartChannelResult	startChannel(StartChannelRequest request) Starts an existing channel
StopChannelResult	stopChannel(StopChannelRequest request) Stops a running channel
UpdateChannelResult	updateChannel(UpdateChannelRequest request) Updates a channel.
UpdateInputResult	updateInput(UpdateInputRequest request) Updates an input.
UpdateInputSecurityGroupResult	updateInputSecurityGroup(UpdateInputSecurityGroupRequest request) Update an Input Security Group's Whilelists.

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, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, shutdown, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.medialive.AWSMediaLive

shutdown

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSMediaLiveClientBuilder builder()

batchUpdateSchedule

public BatchUpdateScheduleResult batchUpdateSchedule(BatchUpdateScheduleRequest request)

Update a channel schedule

Specified by:

batchUpdateSchedule in interface AWSMediaLive

Parameters:

batchUpdateScheduleRequest - List of actions to create and list of actions to delete.

Returns:

Result of the BatchUpdateSchedule operation returned by the service.

Throws:

BadRequestException - This request was invalid.

UnprocessableEntityException - The update schedule request failed validation.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to update the channel schedule.

BadGatewayException - Bad Gateway Error

NotFoundException - The specified channel id does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on update schedule calls.

See Also:

AWS API Documentation

createChannel

public CreateChannelResult createChannel(CreateChannelRequest request)

Creates a new channel

Specified by:

createChannel in interface AWSMediaLive

Parameters:

createChannelRequest - A request to create a channel

Returns:

Result of the CreateChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid.

UnprocessableEntityException - The Channel failed validation and could not be created.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to create the channel.

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on create channel calls to channel service.

ConflictException - The channel is unable to create due to an issue with channel resources.

See Also:

AWS API Documentation

createInput

public CreateInputResult createInput(CreateInputRequest request)

Create an input

Specified by:

createInput in interface AWSMediaLive

Parameters:

createInputRequest - The name of the input

Returns:

Result of the CreateInput operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal Service Error

ForbiddenException - Access was denied

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit exceeded

See Also:

AWS API Documentation

createInputSecurityGroup

public CreateInputSecurityGroupResult createInputSecurityGroup(CreateInputSecurityGroupRequest request)

Creates a Input Security Group

Specified by:

createInputSecurityGroup in interface AWSMediaLive

Parameters:

createInputSecurityGroupRequest - The IPv4 CIDRs to whitelist for this Input Security Group

Returns:

Result of the CreateInputSecurityGroup operation returned by the service.

Throws:

BadRequestException - The request to create an Input Security Group was Invalid

InternalServerErrorException - Internal Server Error

ForbiddenException - The requester does not have permission to create an Input Security Group

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit Exceeded Error

See Also:

AWS API Documentation

deleteChannel

public DeleteChannelResult deleteChannel(DeleteChannelRequest request)

Starts deletion of channel. The associated outputs are also deleted.

Specified by:

deleteChannel in interface AWSMediaLive

Parameters:

deleteChannelRequest - Placeholder documentation for DeleteChannelRequest

Returns:

Result of the DeleteChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to delete the channel.

BadGatewayException - Bad Gateway Error

NotFoundException - The channel you're requesting to delete does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on delete channel calls to channel service.

ConflictException - The channel is unable to delete due to an issue with channel resources.

See Also:

AWS API Documentation

deleteInput

public DeleteInputResult deleteInput(DeleteInputRequest request)

Deletes the input end point

Specified by:

deleteInput in interface AWSMediaLive

Parameters:

deleteInputRequest - Placeholder documentation for DeleteInputRequest

Returns:

Result of the DeleteInput operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal Service Error

ForbiddenException - Access was denied

BadGatewayException - Bad Gateway Error

NotFoundException - Input not found

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit exceeded

ConflictException - Resource conflict

See Also:

AWS API Documentation

deleteInputSecurityGroup

public DeleteInputSecurityGroupResult deleteInputSecurityGroup(DeleteInputSecurityGroupRequest request)

Deletes an Input Security Group

Specified by:

deleteInputSecurityGroup in interface AWSMediaLive

Parameters:

deleteInputSecurityGroupRequest - Placeholder documentation for DeleteInputSecurityGroupRequest

Returns:

Result of the DeleteInputSecurityGroup operation returned by the service.

Throws:

BadRequestException - The request to delete the Input Security Group was Invalid

InternalServerErrorException - Internal Server Error

ForbiddenException - The requester does not have permission to delete this Input Security Group

BadGatewayException - Bad Gateway Error

NotFoundException - Input Security Group not found

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit Exceeded Error

See Also:

AWS API Documentation

deleteReservation

public DeleteReservationResult deleteReservation(DeleteReservationRequest request)

Delete an expired reservation.

Specified by:

deleteReservation in interface AWSMediaLive

Parameters:

deleteReservationRequest - Placeholder documentation for DeleteReservationRequest

Returns:

Result of the DeleteReservation operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to delete reservation

BadGatewayException - Bad gateway error

NotFoundException - Reservation you're attempting to delete does not exist

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on delete reservation request

ConflictException - The reservation could not be deleted because it is currently active.

See Also:

AWS API Documentation

describeChannel

public DescribeChannelResult describeChannel(DescribeChannelRequest request)

Gets details about a channel

Specified by:

describeChannel in interface AWSMediaLive

Parameters:

describeChannelRequest - Placeholder documentation for DescribeChannelRequest

Returns:

Result of the DescribeChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to describe the channel.

BadGatewayException - Bad Gateway Error

NotFoundException - The channel you're requesting to describe does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on describe channel calls to channel service.

See Also:

AWS API Documentation

describeInput

public DescribeInputResult describeInput(DescribeInputRequest request)

Produces details about an input

Specified by:

describeInput in interface AWSMediaLive

Parameters:

describeInputRequest - Placeholder documentation for DescribeInputRequest

Returns:

Result of the DescribeInput operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal Service Error

ForbiddenException - Access was denied

BadGatewayException - Bad Gateway Error

NotFoundException - Input not found

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit exceeded

See Also:

AWS API Documentation

describeInputSecurityGroup

public DescribeInputSecurityGroupResult describeInputSecurityGroup(DescribeInputSecurityGroupRequest request)

Produces a summary of an Input Security Group

Specified by:

describeInputSecurityGroup in interface AWSMediaLive

Parameters:

describeInputSecurityGroupRequest - Placeholder documentation for DescribeInputSecurityGroupRequest

Returns:

Result of the DescribeInputSecurityGroup operation returned by the service.

Throws:

BadRequestException - The request to describe an Input Security Group was Invalid

InternalServerErrorException - Internal Server Error

ForbiddenException - The requester does not have permission to describe this Input Security Group

BadGatewayException - Bad Gateway Error

NotFoundException - Input Security Group not found

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit Exceeded Error

See Also:

AWS API Documentation

describeOffering

public DescribeOfferingResult describeOffering(DescribeOfferingRequest request)

Get details for an offering.

Specified by:

describeOffering in interface AWSMediaLive

Parameters:

describeOfferingRequest - Placeholder documentation for DescribeOfferingRequest

Returns:

Result of the DescribeOffering operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to describe offering

BadGatewayException - Bad gateway error

NotFoundException - Offering you're attempting to describe does not exist

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on describe offering request

See Also:

AWS API Documentation

describeReservation

public DescribeReservationResult describeReservation(DescribeReservationRequest request)

Get details for a reservation.

Specified by:

describeReservation in interface AWSMediaLive

Parameters:

describeReservationRequest - Placeholder documentation for DescribeReservationRequest

Returns:

Result of the DescribeReservation operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to describe reservation

BadGatewayException - Bad gateway error

NotFoundException - Reservation you're attempting to describe does not exist

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on describe reservation request

See Also:

AWS API Documentation

describeSchedule

public DescribeScheduleResult describeSchedule(DescribeScheduleRequest request)

Get a channel schedule

Specified by:

describeSchedule in interface AWSMediaLive

Parameters:

describeScheduleRequest - Request for a describe schedule call.

Returns:

Result of the DescribeSchedule operation returned by the service.

Throws:

BadRequestException - This request was invalid.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to describe the channel schedule.

BadGatewayException - Bad Gateway Error

NotFoundException - The channel you're requesting a schedule describe for does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on describe schedule calls.

See Also:

AWS API Documentation

listChannels

public ListChannelsResult listChannels(ListChannelsRequest request)

Produces list of channels that have been created

Specified by:

listChannels in interface AWSMediaLive

Parameters:

listChannelsRequest - Placeholder documentation for ListChannelsRequest

Returns:

Result of the ListChannels operation returned by the service.

Throws:

BadRequestException - This request was invalid.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to list channels.

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on list channel calls to channel service.

See Also:

AWS API Documentation

listInputSecurityGroups

public ListInputSecurityGroupsResult listInputSecurityGroups(ListInputSecurityGroupsRequest request)

Produces a list of Input Security Groups for an account

Specified by:

listInputSecurityGroups in interface AWSMediaLive

Parameters:

listInputSecurityGroupsRequest - Placeholder documentation for ListInputSecurityGroupsRequest

Returns:

Result of the ListInputSecurityGroups operation returned by the service.

Throws:

BadRequestException - The request to list Input Security Groups was invalid

InternalServerErrorException - Internal Server Error

ForbiddenException - The requester does not have permission to call ListInputSecurityGroups

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit Exceeded Error

See Also:

AWS API Documentation

listInputs

public ListInputsResult listInputs(ListInputsRequest request)

Produces list of inputs that have been created

Specified by:

listInputs in interface AWSMediaLive

Parameters:

listInputsRequest - Placeholder documentation for ListInputsRequest

Returns:

Result of the ListInputs operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal Service Error

ForbiddenException - Access was denied

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Limit exceeded

See Also:

AWS API Documentation

listOfferings

public ListOfferingsResult listOfferings(ListOfferingsRequest request)

List offerings available for purchase.

Specified by:

listOfferings in interface AWSMediaLive

Parameters:

listOfferingsRequest - Placeholder documentation for ListOfferingsRequest

Returns:

Result of the ListOfferings operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to list offerings

BadGatewayException - Bad gateway error

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on list offerings request

See Also:

AWS API Documentation

listReservations

public ListReservationsResult listReservations(ListReservationsRequest request)

List purchased reservations.

Specified by:

listReservations in interface AWSMediaLive

Parameters:

listReservationsRequest - Placeholder documentation for ListReservationsRequest

Returns:

Result of the ListReservations operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to list reservations

BadGatewayException - Bad gateway error

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on list reservations request

See Also:

AWS API Documentation

purchaseOffering

public PurchaseOfferingResult purchaseOffering(PurchaseOfferingRequest request)

Purchase an offering and create a reservation.

Specified by:

purchaseOffering in interface AWSMediaLive

Parameters:

purchaseOfferingRequest - Placeholder documentation for PurchaseOfferingRequest

Returns:

Result of the PurchaseOffering operation returned by the service.

Throws:

BadRequestException - This request was invalid

InternalServerErrorException - Internal service error

ForbiddenException - You do not have permission to purchase the offering

BadGatewayException - Bad gateway error

NotFoundException - Offering you're attempting to purchase does not exist

GatewayTimeoutException - Gateway timeout error

TooManyRequestsException - Request limit exceeded on purchase offering request

ConflictException - Offering purchase prevented by service resource issue

See Also:

AWS API Documentation

startChannel

public StartChannelResult startChannel(StartChannelRequest request)

Starts an existing channel

Specified by:

startChannel in interface AWSMediaLive

Parameters:

startChannelRequest - Placeholder documentation for StartChannelRequest

Returns:

Result of the StartChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to start the channel.

BadGatewayException - Bad Gateway Error

NotFoundException - The channel you're requesting to start does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on start channel calls to channel service.

ConflictException - The channel is unable to start due to an issue with channel resources.

See Also:

AWS API Documentation

stopChannel

public StopChannelResult stopChannel(StopChannelRequest request)

Stops a running channel

Specified by:

stopChannel in interface AWSMediaLive

Parameters:

stopChannelRequest - Placeholder documentation for StopChannelRequest

Returns:

Result of the StopChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to stop the channel.

BadGatewayException - Bad Gateway Error

NotFoundException - The channel you're requesting to stop does not exist.

GatewayTimeoutException - Gateway Timeout Error

TooManyRequestsException - Request limit exceeded on stop channel calls to channel service.

ConflictException - The channel is unable to stop due to an issue with channel resources.

See Also:

AWS API Documentation

updateChannel

public UpdateChannelResult updateChannel(UpdateChannelRequest request)

Updates a channel.

Specified by:

updateChannel in interface AWSMediaLive

Parameters:

updateChannelRequest - A request to update a channel.

Returns:

Result of the UpdateChannel operation returned by the service.

Throws:

BadRequestException - This request was invalid.

UnprocessableEntityException - The channel configuration failed validation and could not be updated.

InternalServerErrorException - Unexpected internal service error.

ForbiddenException - You do not have permission to update the channel.

BadGatewayException - Bad Gateway Error

GatewayTimeoutException - Gateway Timeout Error

ConflictException - The channel is unable to update due to an issue with channel resources.

See Also:

AWS API Documentation

updateInput

public UpdateInputResult updateInput(UpdateInputRequest request)

Updates an input.

Specified by:

updateInput in interface AWSMediaLive

Parameters:

updateInputRequest - A request to update an input.

Returns:

Result of the UpdateInput operation returned by the service.

Throws:

BadRequestException - This request to update the input was invalid.

InternalServerErrorException - Internal Service Error

ForbiddenException - The requester does not have permission to update an input.

BadGatewayException - Bad Gateway Error

NotFoundException - The input was not found.

GatewayTimeoutException - Gateway Timeout Error

ConflictException - The input was unable to be updated at this time due to an issue with input resources.

See Also:

AWS API Documentation

updateInputSecurityGroup

public UpdateInputSecurityGroupResult updateInputSecurityGroup(UpdateInputSecurityGroupRequest request)

Update an Input Security Group's Whilelists.

Specified by:

updateInputSecurityGroup in interface AWSMediaLive

Parameters:

updateInputSecurityGroupRequest - The request to update some combination of the Input Security Group name and the IPv4 CIDRs the Input Security Group should allow.

Returns:

Result of the UpdateInputSecurityGroup operation returned by the service.

Throws:

BadRequestException - The request to update the Input Security Group was invalid

InternalServerErrorException - Internal Server Error

ForbiddenException - The requester does not have permission to update an Input Security Group

BadGatewayException - Bad Gateway Error

NotFoundException - The Input Security Group was not found.

GatewayTimeoutException - Gateway Timeout Error

ConflictException - The Input Security Group was unable to be updated due to an issue with input security group resources.

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 AWSMediaLive

Parameters:

request - The originally executed request

Returns:

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