ElasticTranscoderClient

Index > ElasticTranscoder > ElasticTranscoderClient

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

ElasticTranscoderClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_elastictranscoder.client import ElasticTranscoderClient

session = Session()
async with session.client("elastictranscoder") as client:
    client: ElasticTranscoderClient

Exceptions

aioboto3 client exceptions are generated in runtime. This class provides code completion for session.client("elastictranscoder").exceptions structure.

Usage example

async with session.client("elastictranscoder") as client:
    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)

Type checking example

from types_aiobotocore_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 session.client("elastictranscoder").can_paginate method. boto3 documentation

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 session.client("elastictranscoder").cancel_job method. boto3 documentation

Method definition

await def cancel_job(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.cancel_job(**kwargs)

1. See CancelJobRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

Method definition

await 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 session.client("elastictranscoder").create_job method. boto3 documentation

Method definition

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

1. See JobInputTypeDef
2. See JobInputTypeDef
3. See CreateJobOutputTypeDef
4. See CreateJobOutputTypeDef
5. See CreateJobPlaylistTypeDef
6. See CreateJobResponseTypeDef

Usage example with kwargs

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 session.client("elastictranscoder").create_pipeline method. boto3 documentation

Method definition

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

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

Usage example with kwargs

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 session.client("elastictranscoder").create_preset method. boto3 documentation

Method definition

await def create_preset(
    self,
    *,
    Name: str,
    Container: str,
    Description: str = ...,
    Video: VideoParametersTypeDef = ...,  # (1)
    Audio: AudioParametersTypeDef = ...,  # (2)
    Thumbnails: ThumbnailsTypeDef = ...,  # (3)
) -> CreatePresetResponseTypeDef:  # (4)
    ...

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

Usage example with kwargs

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 session.client("elastictranscoder").delete_pipeline method. boto3 documentation

Method definition

await def delete_pipeline(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("elastictranscoder").delete_preset method. boto3 documentation

Method definition

await def delete_preset(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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 session.client("elastictranscoder").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("elastictranscoder").list_jobs_by_pipeline method. boto3 documentation

Method definition

await def list_jobs_by_pipeline(
    self,
    *,
    PipelineId: str,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListJobsByPipelineResponseTypeDef:  # (1)
    ...

1. See ListJobsByPipelineResponseTypeDef

Usage example with kwargs

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 session.client("elastictranscoder").list_jobs_by_status method. boto3 documentation

Method definition

await def list_jobs_by_status(
    self,
    *,
    Status: str,
    Ascending: str = ...,
    PageToken: str = ...,
) -> ListJobsByStatusResponseTypeDef:  # (1)
    ...

1. See ListJobsByStatusResponseTypeDef

Usage example with kwargs

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 session.client("elastictranscoder").list_pipelines method. boto3 documentation

Method definition

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

1. See ListPipelinesResponseTypeDef

Usage example with kwargs

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

parent.list_pipelines(**kwargs)

1. See ListPipelinesRequestRequestTypeDef

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 session.client("elastictranscoder").list_presets method. boto3 documentation

Method definition

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

1. See ListPresetsResponseTypeDef

Usage example with kwargs

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

parent.list_presets(**kwargs)

1. See ListPresetsRequestRequestTypeDef

read_job

The ReadJob operation returns detailed information about a job.

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

Method definition

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

1. See ReadJobResponseTypeDef

Usage example with kwargs

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

parent.read_job(**kwargs)

1. See ReadJobRequestRequestTypeDef

read_pipeline

The ReadPipeline operation gets detailed information about a pipeline.

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

Method definition

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

1. See ReadPipelineResponseTypeDef

Usage example with kwargs

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

parent.read_pipeline(**kwargs)

1. See ReadPipelineRequestRequestTypeDef

read_preset

The ReadPreset operation gets detailed information about a preset.

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

Method definition

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

1. See ReadPresetResponseTypeDef

Usage example with kwargs

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

parent.read_preset(**kwargs)

1. See ReadPresetRequestRequestTypeDef

test_role

The TestRole operation tests the IAM role used to create the pipeline.

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

Method definition

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

1. See TestRoleResponseTypeDef

Usage example with kwargs

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

parent.test_role(**kwargs)

1. See TestRoleRequestRequestTypeDef

update_pipeline

Use the UpdatePipeline operation to update settings for a pipeline.

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

Method definition

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

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

Usage example with kwargs

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

parent.update_pipeline(**kwargs)

1. See UpdatePipelineRequestRequestTypeDef

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 session.client("elastictranscoder").update_pipeline_notifications method. boto3 documentation

Method definition

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

1. See NotificationsTypeDef
2. See UpdatePipelineNotificationsResponseTypeDef

Usage example with kwargs

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

parent.update_pipeline_notifications(**kwargs)

1. See UpdatePipelineNotificationsRequestRequestTypeDef

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 session.client("elastictranscoder").update_pipeline_status method. boto3 documentation

Method definition

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

1. See UpdatePipelineStatusResponseTypeDef

Usage example with kwargs

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

parent.update_pipeline_status(**kwargs)

1. See UpdatePipelineStatusRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> ElasticTranscoderClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.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 session.client("elastictranscoder").get_waiter method with overloads.

• client.get_waiter("job_complete") -> JobCompleteWaiter