com.amazonaws.services.mediapackagevod.AWSMediaPackageVod Maven / Gradle / Ivy
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediapackagevod;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.mediapackagevod.model.*;
/**
* Interface for accessing MediaPackage Vod.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.mediapackagevod.AbstractAWSMediaPackageVod} instead.
*
*
* AWS Elemental MediaPackage VOD
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSMediaPackageVod {
/**
* 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 RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "mediapackage-vod";
/**
* Changes the packaging group's properities to configure log subscription
*
* @param configureLogsRequest
* The option to configure log subscription.
* @return Result of the ConfigureLogs operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.ConfigureLogs
* @see AWS
* API Documentation
*/
ConfigureLogsResult configureLogs(ConfigureLogsRequest configureLogsRequest);
/**
* Creates a new MediaPackage VOD Asset resource.
*
* @param createAssetRequest
* A new MediaPackage VOD Asset configuration.
* @return Result of the CreateAsset operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.CreateAsset
* @see AWS
* API Documentation
*/
CreateAssetResult createAsset(CreateAssetRequest createAssetRequest);
/**
* Creates a new MediaPackage VOD PackagingConfiguration resource.
*
* @param createPackagingConfigurationRequest
* A new MediaPackage VOD PackagingConfiguration resource configuration.
* @return Result of the CreatePackagingConfiguration operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.CreatePackagingConfiguration
* @see AWS API Documentation
*/
CreatePackagingConfigurationResult createPackagingConfiguration(CreatePackagingConfigurationRequest createPackagingConfigurationRequest);
/**
* Creates a new MediaPackage VOD PackagingGroup resource.
*
* @param createPackagingGroupRequest
* A new MediaPackage VOD PackagingGroup resource configuration.
* @return Result of the CreatePackagingGroup operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.CreatePackagingGroup
* @see AWS API Documentation
*/
CreatePackagingGroupResult createPackagingGroup(CreatePackagingGroupRequest createPackagingGroupRequest);
/**
* Deletes an existing MediaPackage VOD Asset resource.
*
* @param deleteAssetRequest
* @return Result of the DeleteAsset operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DeleteAsset
* @see AWS
* API Documentation
*/
DeleteAssetResult deleteAsset(DeleteAssetRequest deleteAssetRequest);
/**
* Deletes a MediaPackage VOD PackagingConfiguration resource.
*
* @param deletePackagingConfigurationRequest
* @return Result of the DeletePackagingConfiguration operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DeletePackagingConfiguration
* @see AWS API Documentation
*/
DeletePackagingConfigurationResult deletePackagingConfiguration(DeletePackagingConfigurationRequest deletePackagingConfigurationRequest);
/**
* Deletes a MediaPackage VOD PackagingGroup resource.
*
* @param deletePackagingGroupRequest
* @return Result of the DeletePackagingGroup operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DeletePackagingGroup
* @see AWS API Documentation
*/
DeletePackagingGroupResult deletePackagingGroup(DeletePackagingGroupRequest deletePackagingGroupRequest);
/**
* Returns a description of a MediaPackage VOD Asset resource.
*
* @param describeAssetRequest
* @return Result of the DescribeAsset operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DescribeAsset
* @see AWS
* API Documentation
*/
DescribeAssetResult describeAsset(DescribeAssetRequest describeAssetRequest);
/**
* Returns a description of a MediaPackage VOD PackagingConfiguration resource.
*
* @param describePackagingConfigurationRequest
* @return Result of the DescribePackagingConfiguration operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DescribePackagingConfiguration
* @see AWS API Documentation
*/
DescribePackagingConfigurationResult describePackagingConfiguration(DescribePackagingConfigurationRequest describePackagingConfigurationRequest);
/**
* Returns a description of a MediaPackage VOD PackagingGroup resource.
*
* @param describePackagingGroupRequest
* @return Result of the DescribePackagingGroup operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.DescribePackagingGroup
* @see AWS API Documentation
*/
DescribePackagingGroupResult describePackagingGroup(DescribePackagingGroupRequest describePackagingGroupRequest);
/**
* Returns a collection of MediaPackage VOD Asset resources.
*
* @param listAssetsRequest
* @return Result of the ListAssets operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.ListAssets
* @see AWS
* API Documentation
*/
ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest);
/**
* Returns a collection of MediaPackage VOD PackagingConfiguration resources.
*
* @param listPackagingConfigurationsRequest
* @return Result of the ListPackagingConfigurations operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.ListPackagingConfigurations
* @see AWS API Documentation
*/
ListPackagingConfigurationsResult listPackagingConfigurations(ListPackagingConfigurationsRequest listPackagingConfigurationsRequest);
/**
* Returns a collection of MediaPackage VOD PackagingGroup resources.
*
* @param listPackagingGroupsRequest
* @return Result of the ListPackagingGroups operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.ListPackagingGroups
* @see AWS API Documentation
*/
ListPackagingGroupsResult listPackagingGroups(ListPackagingGroupsRequest listPackagingGroupsRequest);
/**
* Returns a list of the tags assigned to the specified resource.
*
* @param listTagsForResourceRequest
* @return Result of the ListTagsForResource operation returned by the service.
* @sample AWSMediaPackageVod.ListTagsForResource
* @see AWS API Documentation
*/
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest);
/**
* Adds tags to the specified resource. You can specify one or more tags to add.
*
* @param tagResourceRequest
* @return Result of the TagResource operation returned by the service.
* @sample AWSMediaPackageVod.TagResource
* @see AWS
* API Documentation
*/
TagResourceResult tagResource(TagResourceRequest tagResourceRequest);
/**
* Removes tags from the specified resource. You can specify one or more tags to remove.
*
* @param untagResourceRequest
* @return Result of the UntagResource operation returned by the service.
* @sample AWSMediaPackageVod.UntagResource
* @see AWS
* API Documentation
*/
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest);
/**
* Updates a specific packaging group. You can't change the id attribute or any other system-generated attributes.
*
* @param updatePackagingGroupRequest
* A MediaPackage VOD PackagingGroup resource configuration.
* @return Result of the UpdatePackagingGroup operation returned by the service.
* @throws UnprocessableEntityException
* The parameters sent in the request are not valid.
* @throws InternalServerErrorException
* An unexpected error occurred.
* @throws ForbiddenException
* The client is not authorized to access the requested resource.
* @throws NotFoundException
* The requested resource does not exist.
* @throws ServiceUnavailableException
* An unexpected error occurred.
* @throws TooManyRequestsException
* The client has exceeded their resource or throttling limits.
* @sample AWSMediaPackageVod.UpdatePackagingGroup
* @see AWS API Documentation
*/
UpdatePackagingGroupResult updatePackagingGroup(UpdatePackagingGroupRequest updatePackagingGroupRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}