ElasticTranscoderClient

Index > ElasticTranscoder > ElasticTranscoderClient

Auto-generated documentation for ElasticTranscoder type annotations stubs module types-boto3-elastictranscoder.

ElasticTranscoderClient

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

# ElasticTranscoderClient usage example

from boto3.session import Session
from types_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 types_boto3_elastictranscoder.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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: CancelJobRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.cancel_job(**kwargs)

1. See CancelJobRequestTypeDef

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: JobInputUnionTypeDef = ...,  # (1)
    Inputs: Sequence[JobInputUnionTypeDef] = ...,  # (2)
    Output: CreateJobOutputTypeDef = ...,  # (3)
    Outputs: Sequence[CreateJobOutputTypeDef] = ...,  # (4)
    OutputKeyPrefix: str = ...,
    Playlists: Sequence[CreateJobPlaylistTypeDef] = ...,  # (5)
    UserMetadata: Mapping[str, str] = ...,
) -> CreateJobResponseTypeDef:  # (6)
    ...

1. See JobInputUnionTypeDef
2. See Sequence[JobInputUnionTypeDef]
3. See CreateJobOutputTypeDef
4. See Sequence[CreateJobOutputTypeDef]
5. See Sequence[CreateJobPlaylistTypeDef]
6. See CreateJobResponseTypeDef

# create_job method usage example with argument unpacking

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

parent.create_job(**kwargs)

1. See CreateJobRequestTypeDef

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: PipelineOutputConfigUnionTypeDef = ...,  # (2)
    ThumbnailConfig: PipelineOutputConfigUnionTypeDef = ...,  # (2)
) -> CreatePipelineResponseTypeDef:  # (4)
    ...

1. See NotificationsTypeDef
2. See PipelineOutputConfigUnionTypeDef
3. See PipelineOutputConfigUnionTypeDef
4. See CreatePipelineResponseTypeDef

# create_pipeline method usage example with argument unpacking

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

parent.create_pipeline(**kwargs)

1. See CreatePipelineRequestTypeDef

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: VideoParametersUnionTypeDef = ...,  # (1)
    Audio: AudioParametersTypeDef = ...,  # (2)
    Thumbnails: ThumbnailsTypeDef = ...,  # (3)
) -> CreatePresetResponseTypeDef:  # (4)
    ...

1. See VideoParametersUnionTypeDef
2. See AudioParametersTypeDef
3. See ThumbnailsTypeDef
4. See CreatePresetResponseTypeDef

# create_preset method usage example with argument unpacking

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

parent.create_preset(**kwargs)

1. See CreatePresetRequestTypeDef

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: DeletePipelineRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_pipeline(**kwargs)

1. See DeletePipelineRequestTypeDef

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: DeletePresetRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.delete_preset(**kwargs)

1. See DeletePresetRequestTypeDef

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: ListJobsByPipelineRequestTypeDef = {  # (1)
    "PipelineId": ...,
}

parent.list_jobs_by_pipeline(**kwargs)

1. See ListJobsByPipelineRequestTypeDef

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: ListJobsByStatusRequestTypeDef = {  # (1)
    "Status": ...,
}

parent.list_jobs_by_status(**kwargs)

1. See ListJobsByStatusRequestTypeDef

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 ListPipelinesResponseTypeDef

# list_pipelines method usage example with argument unpacking

kwargs: ListPipelinesRequestTypeDef = {  # (1)
    "Ascending": ...,
}

parent.list_pipelines(**kwargs)

1. See ListPipelinesRequestTypeDef

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

# list_presets method definition

def list_presets(
    self,
    *,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListPresetsResponseTypeDef:  # (1)
    ...

1. See ListPresetsResponseTypeDef

# list_presets method usage example with argument unpacking

kwargs: ListPresetsRequestTypeDef = {  # (1)
    "Ascending": ...,
}

parent.list_presets(**kwargs)

1. See ListPresetsRequestTypeDef

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

# read_job method definition

def read_job(
    self,
    *,
    Id: str,
) -> ReadJobResponseTypeDef:  # (1)
    ...

1. See ReadJobResponseTypeDef

# read_job method usage example with argument unpacking

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

parent.read_job(**kwargs)

1. See ReadJobRequestTypeDef

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

# read_pipeline method definition

def read_pipeline(
    self,
    *,
    Id: str,
) -> ReadPipelineResponseTypeDef:  # (1)
    ...

1. See ReadPipelineResponseTypeDef

# read_pipeline method usage example with argument unpacking

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

parent.read_pipeline(**kwargs)

1. See ReadPipelineRequestTypeDef

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

# read_preset method definition

def read_preset(
    self,
    *,
    Id: str,
) -> ReadPresetResponseTypeDef:  # (1)
    ...

1. See ReadPresetResponseTypeDef

# read_preset method usage example with argument unpacking

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

parent.read_preset(**kwargs)

1. See ReadPresetRequestTypeDef

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

# test_role method definition

def test_role(
    self,
    *,
    Role: str,
    InputBucket: str,
    OutputBucket: str,
    Topics: Sequence[str],
) -> TestRoleResponseTypeDef:  # (1)
    ...

1. See TestRoleResponseTypeDef

# test_role method usage example with argument unpacking

kwargs: TestRoleRequestTypeDef = {  # (1)
    "Role": ...,
    "InputBucket": ...,
    "OutputBucket": ...,
    "Topics": ...,
}

parent.test_role(**kwargs)

1. See TestRoleRequestTypeDef

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

# update_pipeline method definition

def update_pipeline(
    self,
    *,
    Id: str,
    Name: str = ...,
    InputBucket: str = ...,
    Role: str = ...,
    AwsKmsKeyArn: str = ...,
    Notifications: NotificationsTypeDef = ...,  # (1)
    ContentConfig: PipelineOutputConfigUnionTypeDef = ...,  # (2)
    ThumbnailConfig: PipelineOutputConfigUnionTypeDef = ...,  # (2)
) -> UpdatePipelineResponseTypeDef:  # (4)
    ...

1. See NotificationsTypeDef
2. See PipelineOutputConfigUnionTypeDef
3. See PipelineOutputConfigUnionTypeDef
4. See UpdatePipelineResponseTypeDef

# update_pipeline method usage example with argument unpacking

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

parent.update_pipeline(**kwargs)

1. See UpdatePipelineRequestTypeDef

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

# update_pipeline_notifications method definition

def update_pipeline_notifications(
    self,
    *,
    Id: str,
    Notifications: NotificationsTypeDef,  # (1)
) -> UpdatePipelineNotificationsResponseTypeDef:  # (2)
    ...

1. See NotificationsTypeDef
2. See UpdatePipelineNotificationsResponseTypeDef

# update_pipeline_notifications method usage example with argument unpacking

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

parent.update_pipeline_notifications(**kwargs)

1. See UpdatePipelineNotificationsRequestTypeDef

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

# update_pipeline_status method definition

def update_pipeline_status(
    self,
    *,
    Id: str,
    Status: str,
) -> UpdatePipelineStatusResponseTypeDef:  # (1)
    ...

1. See UpdatePipelineStatusResponseTypeDef

# update_pipeline_status method usage example with argument unpacking

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

parent.update_pipeline_status(**kwargs)

1. See UpdatePipelineStatusRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("elastictranscoder").get_paginator method with overloads.

• client.get_paginator("list_jobs_by_pipeline") -> ListJobsByPipelinePaginator
• client.get_paginator("list_jobs_by_status") -> ListJobsByStatusPaginator
• client.get_paginator("list_pipelines") -> ListPipelinesPaginator
• client.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