MediaConvertClient#
Index > MediaConvert > MediaConvertClient
Auto-generated documentation for MediaConvert type annotations stubs module mypy-boto3-mediaconvert.
MediaConvertClient#
Type annotations and code completion for boto3.client("mediaconvert")
.
boto3 documentation
# MediaConvertClient usage example
from boto3.session import Session
from mypy_boto3_mediaconvert.client import MediaConvertClient
def get_mediaconvert_client() -> MediaConvertClient:
return Session().client("mediaconvert")
Exceptions#
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("mediaconvert").exceptions
structure.
# Exceptions.exceptions usage example
client = boto3.client("mediaconvert")
try:
do_something(client)
except (
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ForbiddenException,
client.exceptions.InternalServerErrorException,
client.exceptions.NotFoundException,
client.exceptions.TooManyRequestsException,
) as e:
print(e)
# Exceptions.exceptions type checking example
from mypy_boto3_mediaconvert.client import Exceptions
def handle_error(exc: Exceptions.BadRequestException) -> None:
...
Methods#
associate_certificate#
Associates an AWS Certificate Manager (ACM) Amazon Resource Name (ARN) with AWS Elemental MediaConvert.
Type annotations and code completion for boto3.client("mediaconvert").associate_certificate
method.
boto3 documentation
# associate_certificate method definition
def associate_certificate(
self,
*,
Arn: str,
) -> Dict[str, Any]:
...
# associate_certificate method usage example with argument unpacking
kwargs: AssociateCertificateRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.associate_certificate(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("mediaconvert").can_paginate
method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...
cancel_job#
Permanently cancel a job.
Type annotations and code completion for boto3.client("mediaconvert").cancel_job
method.
boto3 documentation
# cancel_job method definition
def cancel_job(
self,
*,
Id: str,
) -> Dict[str, Any]:
...
# cancel_job method usage example with argument unpacking
kwargs: CancelJobRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.cancel_job(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("mediaconvert").close
method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...
create_job#
Create a new transcoding job.
Type annotations and code completion for boto3.client("mediaconvert").create_job
method.
boto3 documentation
# create_job method definition
def create_job(
self,
*,
Role: str,
Settings: JobSettingsTypeDef, # (1)
AccelerationSettings: AccelerationSettingsTypeDef = ..., # (2)
BillingTagsSource: BillingTagsSourceType = ..., # (3)
ClientRequestToken: str = ...,
HopDestinations: Sequence[HopDestinationTypeDef] = ..., # (4)
JobEngineVersion: str = ...,
JobTemplate: str = ...,
Priority: int = ...,
Queue: str = ...,
SimulateReservedQueue: SimulateReservedQueueType = ..., # (5)
StatusUpdateInterval: StatusUpdateIntervalType = ..., # (6)
Tags: Mapping[str, str] = ...,
UserMetadata: Mapping[str, str] = ...,
) -> CreateJobResponseTypeDef: # (7)
...
- See JobSettingsTypeDef
- See AccelerationSettingsTypeDef
- See BillingTagsSourceType
- See HopDestinationTypeDef
- See SimulateReservedQueueType
- See StatusUpdateIntervalType
- See CreateJobResponseTypeDef
# create_job method usage example with argument unpacking
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"Role": ...,
"Settings": ...,
}
parent.create_job(**kwargs)
create_job_template#
Create a new job template.
Type annotations and code completion for boto3.client("mediaconvert").create_job_template
method.
boto3 documentation
# create_job_template method definition
def create_job_template(
self,
*,
Name: str,
Settings: JobTemplateSettingsTypeDef, # (1)
AccelerationSettings: AccelerationSettingsTypeDef = ..., # (2)
Category: str = ...,
Description: str = ...,
HopDestinations: Sequence[HopDestinationTypeDef] = ..., # (3)
Priority: int = ...,
Queue: str = ...,
StatusUpdateInterval: StatusUpdateIntervalType = ..., # (4)
Tags: Mapping[str, str] = ...,
) -> CreateJobTemplateResponseTypeDef: # (5)
...
- See JobTemplateSettingsTypeDef
- See AccelerationSettingsTypeDef
- See HopDestinationTypeDef
- See StatusUpdateIntervalType
- See CreateJobTemplateResponseTypeDef
# create_job_template method usage example with argument unpacking
kwargs: CreateJobTemplateRequestRequestTypeDef = { # (1)
"Name": ...,
"Settings": ...,
}
parent.create_job_template(**kwargs)
create_preset#
Create a new preset.
Type annotations and code completion for boto3.client("mediaconvert").create_preset
method.
boto3 documentation
# create_preset method definition
def create_preset(
self,
*,
Name: str,
Settings: PresetSettingsTypeDef, # (1)
Category: str = ...,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreatePresetResponseTypeDef: # (2)
...
# create_preset method usage example with argument unpacking
kwargs: CreatePresetRequestRequestTypeDef = { # (1)
"Name": ...,
"Settings": ...,
}
parent.create_preset(**kwargs)
create_queue#
Create a new transcoding queue.
Type annotations and code completion for boto3.client("mediaconvert").create_queue
method.
boto3 documentation
# create_queue method definition
def create_queue(
self,
*,
Name: str,
Description: str = ...,
PricingPlan: PricingPlanType = ..., # (1)
ReservationPlanSettings: ReservationPlanSettingsTypeDef = ..., # (2)
Status: QueueStatusType = ..., # (3)
Tags: Mapping[str, str] = ...,
) -> CreateQueueResponseTypeDef: # (4)
...
- See PricingPlanType
- See ReservationPlanSettingsTypeDef
- See QueueStatusType
- See CreateQueueResponseTypeDef
# create_queue method usage example with argument unpacking
kwargs: CreateQueueRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_queue(**kwargs)
delete_job_template#
Permanently delete a job template you have created.
Type annotations and code completion for boto3.client("mediaconvert").delete_job_template
method.
boto3 documentation
# delete_job_template method definition
def delete_job_template(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_job_template method usage example with argument unpacking
kwargs: DeleteJobTemplateRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_job_template(**kwargs)
delete_policy#
Permanently delete a policy that you created.
Type annotations and code completion for boto3.client("mediaconvert").delete_policy
method.
boto3 documentation
# delete_policy method definition
def delete_policy(
self,
) -> Dict[str, Any]:
...
delete_preset#
Permanently delete a preset you have created.
Type annotations and code completion for boto3.client("mediaconvert").delete_preset
method.
boto3 documentation
# delete_preset method definition
def delete_preset(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_preset method usage example with argument unpacking
kwargs: DeletePresetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_preset(**kwargs)
delete_queue#
Permanently delete a queue you have created.
Type annotations and code completion for boto3.client("mediaconvert").delete_queue
method.
boto3 documentation
# delete_queue method definition
def delete_queue(
self,
*,
Name: str,
) -> Dict[str, Any]:
...
# delete_queue method usage example with argument unpacking
kwargs: DeleteQueueRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.delete_queue(**kwargs)
describe_endpoints#
Send a request with an empty body to the regional API endpoint to get your account API endpoint.
Type annotations and code completion for boto3.client("mediaconvert").describe_endpoints
method.
boto3 documentation
# describe_endpoints method definition
def describe_endpoints(
self,
*,
MaxResults: int = ...,
Mode: DescribeEndpointsModeType = ..., # (1)
NextToken: str = ...,
) -> DescribeEndpointsResponseTypeDef: # (2)
...
# describe_endpoints method usage example with argument unpacking
kwargs: DescribeEndpointsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.describe_endpoints(**kwargs)
disassociate_certificate#
Removes an association between the Amazon Resource Name (ARN) of an AWS Certificate Manager (ACM) certificate and an AWS Elemental MediaConvert resource.
Type annotations and code completion for boto3.client("mediaconvert").disassociate_certificate
method.
boto3 documentation
# disassociate_certificate method definition
def disassociate_certificate(
self,
*,
Arn: str,
) -> Dict[str, Any]:
...
# disassociate_certificate method usage example with argument unpacking
kwargs: DisassociateCertificateRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.disassociate_certificate(**kwargs)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("mediaconvert").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
get_job#
Retrieve the JSON for a specific transcoding job.
Type annotations and code completion for boto3.client("mediaconvert").get_job
method.
boto3 documentation
# get_job method definition
def get_job(
self,
*,
Id: str,
) -> GetJobResponseTypeDef: # (1)
...
# get_job method usage example with argument unpacking
kwargs: GetJobRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.get_job(**kwargs)
get_job_template#
Retrieve the JSON for a specific job template.
Type annotations and code completion for boto3.client("mediaconvert").get_job_template
method.
boto3 documentation
# get_job_template method definition
def get_job_template(
self,
*,
Name: str,
) -> GetJobTemplateResponseTypeDef: # (1)
...
# get_job_template method usage example with argument unpacking
kwargs: GetJobTemplateRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_job_template(**kwargs)
get_policy#
Retrieve the JSON for your policy.
Type annotations and code completion for boto3.client("mediaconvert").get_policy
method.
boto3 documentation
# get_policy method definition
def get_policy(
self,
) -> GetPolicyResponseTypeDef: # (1)
...
get_preset#
Retrieve the JSON for a specific preset.
Type annotations and code completion for boto3.client("mediaconvert").get_preset
method.
boto3 documentation
# get_preset method definition
def get_preset(
self,
*,
Name: str,
) -> GetPresetResponseTypeDef: # (1)
...
# get_preset method usage example with argument unpacking
kwargs: GetPresetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_preset(**kwargs)
get_queue#
Retrieve the JSON for a specific queue.
Type annotations and code completion for boto3.client("mediaconvert").get_queue
method.
boto3 documentation
# get_queue method definition
def get_queue(
self,
*,
Name: str,
) -> GetQueueResponseTypeDef: # (1)
...
# get_queue method usage example with argument unpacking
kwargs: GetQueueRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.get_queue(**kwargs)
list_job_templates#
Retrieve a JSON array of up to twenty of your job templates.
Type annotations and code completion for boto3.client("mediaconvert").list_job_templates
method.
boto3 documentation
# list_job_templates method definition
def list_job_templates(
self,
*,
Category: str = ...,
ListBy: JobTemplateListByType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
Order: OrderType = ..., # (2)
) -> ListJobTemplatesResponseTypeDef: # (3)
...
# list_job_templates method usage example with argument unpacking
kwargs: ListJobTemplatesRequestRequestTypeDef = { # (1)
"Category": ...,
}
parent.list_job_templates(**kwargs)
list_jobs#
Retrieve a JSON array of up to twenty of your most recently created jobs.
Type annotations and code completion for boto3.client("mediaconvert").list_jobs
method.
boto3 documentation
# list_jobs method definition
def list_jobs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
Order: OrderType = ..., # (1)
Queue: str = ...,
Status: JobStatusType = ..., # (2)
) -> ListJobsResponseTypeDef: # (3)
...
- See OrderType
- See JobStatusType
- See ListJobsResponseTypeDef
# list_jobs method usage example with argument unpacking
kwargs: ListJobsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_jobs(**kwargs)
list_presets#
Retrieve a JSON array of up to twenty of your presets.
Type annotations and code completion for boto3.client("mediaconvert").list_presets
method.
boto3 documentation
# list_presets method definition
def list_presets(
self,
*,
Category: str = ...,
ListBy: PresetListByType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
Order: OrderType = ..., # (2)
) -> ListPresetsResponseTypeDef: # (3)
...
- See PresetListByType
- See OrderType
- See ListPresetsResponseTypeDef
# list_presets method usage example with argument unpacking
kwargs: ListPresetsRequestRequestTypeDef = { # (1)
"Category": ...,
}
parent.list_presets(**kwargs)
list_queues#
Retrieve a JSON array of up to twenty of your queues.
Type annotations and code completion for boto3.client("mediaconvert").list_queues
method.
boto3 documentation
# list_queues method definition
def list_queues(
self,
*,
ListBy: QueueListByType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
Order: OrderType = ..., # (2)
) -> ListQueuesResponseTypeDef: # (3)
...
- See QueueListByType
- See OrderType
- See ListQueuesResponseTypeDef
# list_queues method usage example with argument unpacking
kwargs: ListQueuesRequestRequestTypeDef = { # (1)
"ListBy": ...,
}
parent.list_queues(**kwargs)
list_tags_for_resource#
Retrieve the tags for a MediaConvert resource.
Type annotations and code completion for boto3.client("mediaconvert").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
Arn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.list_tags_for_resource(**kwargs)
list_versions#
Retrieve a JSON array of all available Job engine versions and the date they expire.
Type annotations and code completion for boto3.client("mediaconvert").list_versions
method.
boto3 documentation
# list_versions method definition
def list_versions(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListVersionsResponseTypeDef: # (1)
...
# list_versions method usage example with argument unpacking
kwargs: ListVersionsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_versions(**kwargs)
put_policy#
Create or change your policy.
Type annotations and code completion for boto3.client("mediaconvert").put_policy
method.
boto3 documentation
# put_policy method definition
def put_policy(
self,
*,
Policy: PolicyTypeDef, # (1)
) -> PutPolicyResponseTypeDef: # (2)
...
# put_policy method usage example with argument unpacking
kwargs: PutPolicyRequestRequestTypeDef = { # (1)
"Policy": ...,
}
parent.put_policy(**kwargs)
search_jobs#
Retrieve a JSON array that includes job details for up to twenty of your most recent jobs.
Type annotations and code completion for boto3.client("mediaconvert").search_jobs
method.
boto3 documentation
# search_jobs method definition
def search_jobs(
self,
*,
InputFile: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
Order: OrderType = ..., # (1)
Queue: str = ...,
Status: JobStatusType = ..., # (2)
) -> SearchJobsResponseTypeDef: # (3)
...
- See OrderType
- See JobStatusType
- See SearchJobsResponseTypeDef
# search_jobs method usage example with argument unpacking
kwargs: SearchJobsRequestRequestTypeDef = { # (1)
"InputFile": ...,
}
parent.search_jobs(**kwargs)
tag_resource#
Add tags to a MediaConvert queue, preset, or job template.
Type annotations and code completion for boto3.client("mediaconvert").tag_resource
method.
boto3 documentation
# tag_resource method definition
def tag_resource(
self,
*,
Arn: str,
Tags: Mapping[str, str],
) -> Dict[str, Any]:
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource#
Remove tags from a MediaConvert queue, preset, or job template.
Type annotations and code completion for boto3.client("mediaconvert").untag_resource
method.
boto3 documentation
# untag_resource method definition
def untag_resource(
self,
*,
Arn: str,
TagKeys: Sequence[str] = ...,
) -> Dict[str, Any]:
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"Arn": ...,
}
parent.untag_resource(**kwargs)
update_job_template#
Modify one of your existing job templates.
Type annotations and code completion for boto3.client("mediaconvert").update_job_template
method.
boto3 documentation
# update_job_template method definition
def update_job_template(
self,
*,
Name: str,
AccelerationSettings: AccelerationSettingsTypeDef = ..., # (1)
Category: str = ...,
Description: str = ...,
HopDestinations: Sequence[HopDestinationTypeDef] = ..., # (2)
Priority: int = ...,
Queue: str = ...,
Settings: JobTemplateSettingsTypeDef = ..., # (3)
StatusUpdateInterval: StatusUpdateIntervalType = ..., # (4)
) -> UpdateJobTemplateResponseTypeDef: # (5)
...
- See AccelerationSettingsTypeDef
- See HopDestinationTypeDef
- See JobTemplateSettingsTypeDef
- See StatusUpdateIntervalType
- See UpdateJobTemplateResponseTypeDef
# update_job_template method usage example with argument unpacking
kwargs: UpdateJobTemplateRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_job_template(**kwargs)
update_preset#
Modify one of your existing presets.
Type annotations and code completion for boto3.client("mediaconvert").update_preset
method.
boto3 documentation
# update_preset method definition
def update_preset(
self,
*,
Name: str,
Category: str = ...,
Description: str = ...,
Settings: PresetSettingsTypeDef = ..., # (1)
) -> UpdatePresetResponseTypeDef: # (2)
...
# update_preset method usage example with argument unpacking
kwargs: UpdatePresetRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_preset(**kwargs)
update_queue#
Modify one of your existing queues.
Type annotations and code completion for boto3.client("mediaconvert").update_queue
method.
boto3 documentation
# update_queue method definition
def update_queue(
self,
*,
Name: str,
Description: str = ...,
ReservationPlanSettings: ReservationPlanSettingsTypeDef = ..., # (1)
Status: QueueStatusType = ..., # (2)
) -> UpdateQueueResponseTypeDef: # (3)
...
# update_queue method usage example with argument unpacking
kwargs: UpdateQueueRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.update_queue(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("mediaconvert").get_paginator
method with overloads.
client.get_paginator("describe_endpoints")
-> DescribeEndpointsPaginatorclient.get_paginator("list_job_templates")
-> ListJobTemplatesPaginatorclient.get_paginator("list_jobs")
-> ListJobsPaginatorclient.get_paginator("list_presets")
-> ListPresetsPaginatorclient.get_paginator("list_queues")
-> ListQueuesPaginatorclient.get_paginator("list_versions")
-> ListVersionsPaginatorclient.get_paginator("search_jobs")
-> SearchJobsPaginator