Skip to content

Examples#

Index > ElasticTranscoder > Examples

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

Client#

Implicit type annotations#

Can be used with boto3-stubs[elastictranscoder] package installed.

Write your ElasticTranscoder code as usual, type checking and code completion should work out of the box.

Client method usage example#

# ElasticTranscoderClient usage example

from boto3.session import Session


session = Session()

client = session.client("elastictranscoder")  # (1)
result = client.create_job()  # (2)
  1. client: ElasticTranscoderClient
  2. result: CreateJobResponseTypeDef

Paginator usage example#

# ListJobsByPipelinePaginator usage example

from boto3.session import Session


session = Session()
client = session.client("elastictranscoder")  # (1)

paginator = client.get_paginator("list_jobs_by_pipeline")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)
  1. client: ElasticTranscoderClient
  2. paginator: ListJobsByPipelinePaginator
  3. item: ListJobsByPipelineResponseTypeDef

Waiter usage example#

# JobCompleteWaiter usage example

from boto3.session import Session


session = Session()
client = session.client("elastictranscoder")  # (1)

waiter = client.get_waiter("job_complete")  # (2)
waiter.wait(...)
  1. client: ElasticTranscoderClient
  2. waiter: JobCompleteWaiter

Explicit type annotations#

With boto3-stubs-lite[elastictranscoder] or a standalone mypy_boto3_elastictranscoder package, you have to explicitly specify client: ElasticTranscoderClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

Client method usage example#

# ElasticTranscoderClient usage example with type annotations

from boto3.session import Session

from mypy_boto3_elastictranscoder.client import ElasticTranscoderClient
from mypy_boto3_elastictranscoder.type_defs import CreateJobResponseTypeDef
from mypy_boto3_elastictranscoder.type_defs import CreateJobRequestTypeDef


session = Session()

client: ElasticTranscoderClient = session.client("elastictranscoder")

kwargs: CreateJobRequestTypeDef = {...}
result: CreateJobResponseTypeDef = client.create_job(**kwargs)

Paginator usage example#

# ListJobsByPipelinePaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_elastictranscoder.client import ElasticTranscoderClient
from mypy_boto3_elastictranscoder.paginator import ListJobsByPipelinePaginator
from mypy_boto3_elastictranscoder.type_defs import ListJobsByPipelineResponseTypeDef


session = Session()
client: ElasticTranscoderClient = session.client("elastictranscoder")

paginator: ListJobsByPipelinePaginator = client.get_paginator("list_jobs_by_pipeline")
for item in paginator.paginate(...):
    item: ListJobsByPipelineResponseTypeDef
    print(item)

Waiter usage example#

# JobCompleteWaiter usage example with type annotations

from boto3.session import Session

from mypy_boto3_elastictranscoder.client import ElasticTranscoderClient
from mypy_boto3_elastictranscoder.waiter import JobCompleteWaiter

session = Session()
client: ElasticTranscoderClient = session.client("elastictranscoder")

waiter: JobCompleteWaiter = client.get_waiter("job_complete")
waiter.wait(...)