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)
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 an 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.