com.amazonaws.services.kinesisvideo

Interface AmazonKinesisVideoArchivedMedia

All Known Subinterfaces:

AmazonKinesisVideoArchivedMediaAsync

All Known Implementing Classes:

AbstractAmazonKinesisVideoArchivedMedia, AbstractAmazonKinesisVideoArchivedMediaAsync, AmazonKinesisVideoArchivedMediaAsyncClient, AmazonKinesisVideoArchivedMediaClient

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

Interface for accessing Kinesis Video Archived Media.

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

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
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.
GetMediaForFragmentListResult	getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest) Gets media for a list of fragments (specified by fragment number) from the archived data in a Kinesis video stream.
ListFragmentsResult	listFragments(ListFragmentsRequest listFragmentsRequest) Returns a list of Fragment objects from the specified stream and start location within the archived data.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

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

getMediaForFragmentList

GetMediaForFragmentListResult getMediaForFragmentList(GetMediaForFragmentListRequest getMediaForFragmentListRequest)

Gets media for a list of fragments (specified by fragment number) from the archived data in a Kinesis video stream.

This operation is only available for the AWS SDK for Java. It is not supported in AWS SDKs for other languages.

The following limits apply when using the GetMediaForFragmentList API:

• A client can call GetMediaForFragmentList up to five times per second per stream.

• Kinesis Video Streams sends media data at a rate of up to 25 megabytes per second (or 200 megabits per second) during a GetMediaForFragmentList session.

Parameters:

getMediaForFragmentListRequest -

Returns:

Result of the GetMediaForFragmentList operation returned by the service.

Throws:

ResourceNotFoundException - Kinesis Video Streams can't find the stream that you specified.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

See Also:

AWS API Documentation

listFragments

ListFragmentsResult listFragments(ListFragmentsRequest listFragmentsRequest)

Returns a list of Fragment objects from the specified stream and start location within the archived data.

Parameters:

listFragmentsRequest -

Returns:

Result of the ListFragments operation returned by the service.

Throws:

ResourceNotFoundException - Kinesis Video Streams can't find the stream that you specified.

InvalidArgumentException - A specified parameter exceeds its restrictions, is not supported, or can't be used.

ClientLimitExceededException - Kinesis Video Streams has throttled the request because you have exceeded the limit of allowed client calls. Try making the call later.

NotAuthorizedException - Status Code: 403, The caller is not authorized to perform an operation on the given stream, or the token has expired.

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.