Skip to content

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

# ElasticTranscoderClient usage example

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.

# Exceptions.exceptions usage example

client = boto3.client("elastictranscoder")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.IncompatibleVersionException,
    client.exceptions.InternalServiceException,
    client.exceptions.LimitExceededException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

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

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_job#

The CancelJob operation cancels an unfinished job.

Type annotations and code completion for boto3.client("elastictranscoder").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)
  1. See CancelJobRequestRequestTypeDef

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("elastictranscoder").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

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

# create_job method definition

def create_job(
    self,
    *,
    PipelineId: str,
    Input: Union[JobInputTypeDef, JobInputExtraOutputTypeDef] = ...,  # (1)
    Inputs: Sequence[Union[JobInputTypeDef, JobInputExtraOutputTypeDef]] = ...,  # (2)
    Output: CreateJobOutputTypeDef = ...,  # (3)
    Outputs: Sequence[CreateJobOutputTypeDef] = ...,  # (4)
    OutputKeyPrefix: str = ...,
    Playlists: Sequence[CreateJobPlaylistTypeDef] = ...,  # (5)
    UserMetadata: Mapping[str, str] = ...,
) -> CreateJobResponseTypeDef:  # (6)
    ...
  1. See JobInputTypeDef JobInputExtraOutputTypeDef
  2. See JobInputTypeDef JobInputExtraOutputTypeDef
  3. See CreateJobOutputTypeDef
  4. See CreateJobOutputTypeDef
  5. See CreateJobPlaylistTypeDef
  6. See CreateJobResponseTypeDef
# create_job method usage example with argument unpacking

kwargs: CreateJobRequestRequestTypeDef = {  # (1)
    "PipelineId": ...,
}

parent.create_job(**kwargs)
  1. See CreateJobRequestRequestTypeDef

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

# create_pipeline method definition

def create_pipeline(
    self,
    *,
    Name: str,
    InputBucket: str,
    Role: str,
    OutputBucket: str = ...,
    AwsKmsKeyArn: str = ...,
    Notifications: NotificationsTypeDef = ...,  # (1)
    ContentConfig: Union[PipelineOutputConfigTypeDef, PipelineOutputConfigExtraOutputTypeDef] = ...,  # (2)
    ThumbnailConfig: Union[PipelineOutputConfigTypeDef, PipelineOutputConfigExtraOutputTypeDef] = ...,  # (2)
) -> CreatePipelineResponseTypeDef:  # (4)
    ...
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigTypeDef PipelineOutputConfigExtraOutputTypeDef
  3. See PipelineOutputConfigTypeDef PipelineOutputConfigExtraOutputTypeDef
  4. See CreatePipelineResponseTypeDef
# create_pipeline method usage example with argument unpacking

kwargs: CreatePipelineRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "InputBucket": ...,
    "Role": ...,
}

parent.create_pipeline(**kwargs)
  1. See CreatePipelineRequestRequestTypeDef

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

# create_preset method definition

def create_preset(
    self,
    *,
    Name: str,
    Container: str,
    Description: str = ...,
    Video: Union[VideoParametersTypeDef, VideoParametersExtraOutputTypeDef] = ...,  # (1)
    Audio: AudioParametersTypeDef = ...,  # (2)
    Thumbnails: ThumbnailsTypeDef = ...,  # (3)
) -> CreatePresetResponseTypeDef:  # (4)
    ...
  1. See VideoParametersTypeDef VideoParametersExtraOutputTypeDef
  2. See AudioParametersTypeDef
  3. See ThumbnailsTypeDef
  4. See CreatePresetResponseTypeDef
# create_preset method usage example with argument unpacking

kwargs: CreatePresetRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "Container": ...,
}

parent.create_preset(**kwargs)
  1. See CreatePresetRequestRequestTypeDef

delete_pipeline#

The DeletePipeline operation removes a pipeline.

Type annotations and code completion for boto3.client("elastictranscoder").delete_pipeline method. boto3 documentation

# delete_pipeline method definition

def delete_pipeline(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_pipeline method usage example with argument unpacking

kwargs: DeletePipelineRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_pipeline(**kwargs)
  1. See DeletePipelineRequestRequestTypeDef

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

# delete_preset method definition

def delete_preset(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...
# delete_preset method usage example with argument unpacking

kwargs: DeletePresetRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_preset(**kwargs)
  1. See DeletePresetRequestRequestTypeDef

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

# generate_presigned_url method definition

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

# list_jobs_by_pipeline method definition

def list_jobs_by_pipeline(
    self,
    *,
    PipelineId: str,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListJobsByPipelineResponseTypeDef:  # (1)
    ...
  1. See ListJobsByPipelineResponseTypeDef
# list_jobs_by_pipeline method usage example with argument unpacking

kwargs: ListJobsByPipelineRequestRequestTypeDef = {  # (1)
    "PipelineId": ...,
}

parent.list_jobs_by_pipeline(**kwargs)
  1. See ListJobsByPipelineRequestRequestTypeDef

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

# list_jobs_by_status method definition

def list_jobs_by_status(
    self,
    *,
    Status: str,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListJobsByStatusResponseTypeDef:  # (1)
    ...
  1. See ListJobsByStatusResponseTypeDef
# list_jobs_by_status method usage example with argument unpacking

kwargs: ListJobsByStatusRequestRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_jobs_by_status(**kwargs)
  1. See ListJobsByStatusRequestRequestTypeDef

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

# list_pipelines method definition

def list_pipelines(
    self,
    *,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListPipelinesResponseTypeDef:  # (1)
    ...
  1. See