ElasticTranscoderClient
Index > ElasticTranscoder > ElasticTranscoderClient
Auto-generated documentation for ElasticTranscoder type annotations stubs module mypy-boto3-elastictranscoder.
ElasticTranscoderClient
Type annotations and code completion for boto3.client("elastictranscoder")
.
boto3 documentation
from boto3.session import Session
from mypy_boto3_elastictranscoder.client import ElasticTranscoderClient
def get_elastictranscoder_client() -> ElasticTranscoderClient:
return Session().client("elastictranscoder")
Exceptions
boto3
client exceptions are generated in runtime.
This class provides code completion for boto3.client("elastictranscoder").exceptions
structure.
client = boto3.client("elastictranscoder")
try:
do_something(client)
except (
client.AccessDeniedException,
client.ClientError,
client.IncompatibleVersionException,
client.InternalServiceException,
client.LimitExceededException,
client.ResourceInUseException,
client.ResourceNotFoundException,
client.ValidationException,
) as e:
print(e)
from mypy_boto3_elastictranscoder.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("elastictranscoder").can_paginate
method.
boto3 documentation
cancel_job
The CancelJob operation cancels an unfinished job.
Type annotations and code completion for boto3.client("elastictranscoder").cancel_job
method.
boto3 documentation
kwargs: CancelJobRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.cancel_job(**kwargs)
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("elastictranscoder").close
method.
boto3 documentation
create_job
When you create a job, Elastic Transcoder returns JSON data that includes the values that you specified plus information about the job that is created.
Type annotations and code completion for boto3.client("elastictranscoder").create_job
method.
boto3 documentation
def create_job(
self,
*,
PipelineId: str,
Input: JobInputTypeDef = ..., # (1)
Inputs: Sequence[JobInputTypeDef] = ..., # (2)
Output: CreateJobOutputTypeDef = ..., # (3)
Outputs: Sequence[CreateJobOutputTypeDef] = ..., # (4)
OutputKeyPrefix: str = ...,
Playlists: Sequence[CreateJobPlaylistTypeDef] = ..., # (5)
UserMetadata: Mapping[str, str] = ...,
) -> CreateJobResponseTypeDef: # (6)
...
- See JobInputTypeDef
- See JobInputTypeDef
- See CreateJobOutputTypeDef
- See CreateJobOutputTypeDef
- See CreateJobPlaylistTypeDef
- See CreateJobResponseTypeDef
kwargs: CreateJobRequestRequestTypeDef = { # (1)
"PipelineId": ...,
}
parent.create_job(**kwargs)
create_pipeline
The CreatePipeline operation creates a pipeline with settings that you specify.
Type annotations and code completion for boto3.client("elastictranscoder").create_pipeline
method.
boto3 documentation
def create_pipeline(
self,
*,
Name: str,
InputBucket: str,
Role: str,
OutputBucket: str = ...,
AwsKmsKeyArn: str = ...,
Notifications: NotificationsTypeDef = ..., # (1)
ContentConfig: PipelineOutputConfigTypeDef = ..., # (2)
ThumbnailConfig: PipelineOutputConfigTypeDef = ..., # (2)
) -> CreatePipelineResponseTypeDef: # (4)
...
- See NotificationsTypeDef
- See PipelineOutputConfigTypeDef
- See PipelineOutputConfigTypeDef
- See CreatePipelineResponseTypeDef
kwargs: CreatePipelineRequestRequestTypeDef = { # (1)
"Name": ...,
"InputBucket": ...,
"Role": ...,
}
parent.create_pipeline(**kwargs)
create_preset
The CreatePreset operation creates a preset with settings that you specify.
Type annotations and code completion for boto3.client("elastictranscoder").create_preset
method.
boto3 documentation
def create_preset(
self,
*,
Name: str,
Container: str,
Description: str = ...,
Video: VideoParametersTypeDef = ..., # (1)
Audio: AudioParametersTypeDef = ..., # (2)
Thumbnails: ThumbnailsTypeDef = ..., # (3)
) -> CreatePresetResponseTypeDef: # (4)
...
- See VideoParametersTypeDef
- See AudioParametersTypeDef
- See ThumbnailsTypeDef
- See CreatePresetResponseTypeDef
kwargs: CreatePresetRequestRequestTypeDef = { # (1)
"Name": ...,
"Container": ...,
}
parent.create_preset(**kwargs)
delete_pipeline
The DeletePipeline operation removes a pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").delete_pipeline
method.
boto3 documentation
kwargs: DeletePipelineRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_pipeline(**kwargs)
delete_preset
The DeletePreset operation removes a preset that you've added in an AWS region.
Type annotations and code completion for boto3.client("elastictranscoder").delete_preset
method.
boto3 documentation
kwargs: DeletePresetRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_preset(**kwargs)
generate_presigned_url
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("elastictranscoder").generate_presigned_url
method.
boto3 documentation
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...
list_jobs_by_pipeline
The ListJobsByPipeline operation gets a list of the jobs currently in a pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").list_jobs_by_pipeline
method.
boto3 documentation
def list_jobs_by_pipeline(
self,
*,
PipelineId: str,
Ascending: str = ...,
PageToken: str = ...,
) -> ListJobsByPipelineResponseTypeDef: # (1)
...
kwargs: ListJobsByPipelineRequestRequestTypeDef = { # (1)
"PipelineId": ...,
}
parent.list_jobs_by_pipeline(**kwargs)
list_jobs_by_status
The ListJobsByStatus operation gets a list of jobs that have a specified status.
Type annotations and code completion for boto3.client("elastictranscoder").list_jobs_by_status
method.
boto3 documentation
def list_jobs_by_status(
self,
*,
Status: str,
Ascending: str = ...,
PageToken: str = ...,
) -> ListJobsByStatusResponseTypeDef: # (1)
...
kwargs: ListJobsByStatusRequestRequestTypeDef = { # (1)
"Status": ...,
}
parent.list_jobs_by_status(**kwargs)
list_pipelines
The ListPipelines operation gets a list of the pipelines associated with the current AWS account.
Type annotations and code completion for boto3.client("elastictranscoder").list_pipelines
method.
boto3 documentation
def list_pipelines(
self,
*,
Ascending: str = ...,
PageToken: str = ...,
) -> ListPipelinesResponseTypeDef: # (1)
...
kwargs: ListPipelinesRequestRequestTypeDef = { # (1)
"Ascending": ...,
}
parent.list_pipelines(**kwargs)
list_presets
The ListPresets operation gets a list of the default presets included with Elastic Transcoder and the presets that you've added in an AWS region.
Type annotations and code completion for boto3.client("elastictranscoder").list_presets
method.
boto3 documentation
def list_presets(
self,
*,
Ascending: str = ...,
PageToken: str = ...,
) -> ListPresetsResponseTypeDef: # (1)
...
kwargs: ListPresetsRequestRequestTypeDef = { # (1)
"Ascending": ...,
}
parent.list_presets(**kwargs)
read_job
The ReadJob operation returns detailed information about a job.
Type annotations and code completion for boto3.client("elastictranscoder").read_job
method.
boto3 documentation
kwargs: ReadJobRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.read_job(**kwargs)
read_pipeline
The ReadPipeline operation gets detailed information about a pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").read_pipeline
method.
boto3 documentation
kwargs: ReadPipelineRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.read_pipeline(**kwargs)
read_preset
The ReadPreset operation gets detailed information about a preset.
Type annotations and code completion for boto3.client("elastictranscoder").read_preset
method.
boto3 documentation
kwargs: ReadPresetRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.read_preset(**kwargs)
test_role
The TestRole operation tests the IAM role used to create the pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").test_role
method.
boto3 documentation
def test_role(
self,
*,
Role: str,
InputBucket: str,
OutputBucket: str,
Topics: Sequence[str],
) -> TestRoleResponseTypeDef: # (1)
...
kwargs: TestRoleRequestRequestTypeDef = { # (1)
"Role": ...,
"InputBucket": ...,
"OutputBucket": ...,
"Topics": ...,
}
parent.test_role(**kwargs)
update_pipeline
Use the UpdatePipeline
operation to update settings for a pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").update_pipeline
method.
boto3 documentation
def update_pipeline(
self,
*,
Id: str,
Name: str = ...,
InputBucket: str = ...,
Role: str = ...,
AwsKmsKeyArn: str = ...,
Notifications: NotificationsTypeDef = ..., # (1)
ContentConfig: PipelineOutputConfigTypeDef = ..., # (2)
ThumbnailConfig: PipelineOutputConfigTypeDef = ..., # (2)
) -> UpdatePipelineResponseTypeDef: # (4)
...
- See NotificationsTypeDef
- See PipelineOutputConfigTypeDef
- See PipelineOutputConfigTypeDef
- See UpdatePipelineResponseTypeDef
kwargs: UpdatePipelineRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_pipeline(**kwargs)
update_pipeline_notifications
With the UpdatePipelineNotifications operation, you can update Amazon Simple Notification Service (Amazon SNS) notifications for a pipeline.
Type annotations and code completion for boto3.client("elastictranscoder").update_pipeline_notifications
method.
boto3 documentation
def update_pipeline_notifications(
self,
*,
Id: str,
Notifications: NotificationsTypeDef, # (1)
) -> UpdatePipelineNotificationsResponseTypeDef: # (2)
...
kwargs: UpdatePipelineNotificationsRequestRequestTypeDef = { # (1)
"Id": ...,
"Notifications": ...,
}
parent.update_pipeline_notifications(**kwargs)
update_pipeline_status
The UpdatePipelineStatus operation pauses or reactivates a pipeline, so that the pipeline stops or restarts the processing of jobs.
Type annotations and code completion for boto3.client("elastictranscoder").update_pipeline_status
method.
boto3 documentation
def update_pipeline_status(
self,
*,
Id: str,
Status: str,
) -> UpdatePipelineStatusResponseTypeDef: # (1)
...
kwargs: UpdatePipelineStatusRequestRequestTypeDef = { # (1)
"Id": ...,
"Status": ...,
}
parent.update_pipeline_status(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("elastictranscoder").get_paginator
method with overloads.
client.get_paginator("list_jobs_by_pipeline")
-> ListJobsByPipelinePaginatorclient.get_paginator("list_jobs_by_status")
-> ListJobsByStatusPaginatorclient.get_paginator("list_pipelines")
-> ListPipelinesPaginatorclient.get_paginator("list_presets")
-> ListPresetsPaginator
get_waiter
Type annotations and code completion for boto3.client("elastictranscoder").get_waiter
method with overloads.
client.get_waiter("job_complete")
-> JobCompleteWaiter