Skip to content

Type definitions#

Index > ElasticTranscoder > Type definitions

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

EncryptionTypeDef#

# EncryptionTypeDef definition

class EncryptionTypeDef(TypedDict):
    Mode: NotRequired[str],
    Key: NotRequired[str],
    KeyMd5: NotRequired[str],
    InitializationVector: NotRequired[str],

AudioCodecOptionsTypeDef#

# AudioCodecOptionsTypeDef definition

class AudioCodecOptionsTypeDef(TypedDict):
    Profile: NotRequired[str],
    BitDepth: NotRequired[str],
    BitOrder: NotRequired[str],
    Signed: NotRequired[str],

CancelJobRequestRequestTypeDef#

# CancelJobRequestRequestTypeDef definition

class CancelJobRequestRequestTypeDef(TypedDict):
    Id: str,

TimeSpanTypeDef#

# TimeSpanTypeDef definition

class TimeSpanTypeDef(TypedDict):
    StartTime: NotRequired[str],
    Duration: NotRequired[str],

HlsContentProtectionTypeDef#

# HlsContentProtectionTypeDef definition

class HlsContentProtectionTypeDef(TypedDict):
    Method: NotRequired[str],
    Key: NotRequired[str],
    KeyMd5: NotRequired[str],
    InitializationVector: NotRequired[str],
    LicenseAcquisitionUrl: NotRequired[str],
    KeyStoragePolicy: NotRequired[str],

PlayReadyDrmTypeDef#

# PlayReadyDrmTypeDef definition

class PlayReadyDrmTypeDef(TypedDict):
    Format: NotRequired[str],
    Key: NotRequired[str],
    KeyMd5: NotRequired[str],
    KeyId: NotRequired[str],
    InitializationVector: NotRequired[str],
    LicenseAcquisitionUrl: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

NotificationsTypeDef#

# NotificationsTypeDef definition

class NotificationsTypeDef(TypedDict):
    Progressing: NotRequired[str],
    Completed: NotRequired[str],
    Warning: NotRequired[str],
    Error: NotRequired[str],

WarningTypeDef#

# WarningTypeDef definition

class WarningTypeDef(TypedDict):
    Code: NotRequired[str],
    Message: NotRequired[str],

ThumbnailsTypeDef#

# ThumbnailsTypeDef definition

class ThumbnailsTypeDef(TypedDict):
    Format: NotRequired[str],
    Interval: NotRequired[str],
    Resolution: NotRequired[str],
    AspectRatio: NotRequired[str],
    MaxWidth: NotRequired[str],
    MaxHeight: NotRequired[str],
    SizingPolicy: NotRequired[str],
    PaddingPolicy: NotRequired[str],

DeletePipelineRequestRequestTypeDef#

# DeletePipelineRequestRequestTypeDef definition

class DeletePipelineRequestRequestTypeDef(TypedDict):
    Id: str,

DeletePresetRequestRequestTypeDef#

# DeletePresetRequestRequestTypeDef definition

class DeletePresetRequestRequestTypeDef(TypedDict):
    Id: str,

DetectedPropertiesTypeDef#

# DetectedPropertiesTypeDef definition

class DetectedPropertiesTypeDef(TypedDict):
    Width: NotRequired[int],
    Height: NotRequired[int],
    FrameRate: NotRequired[str],
    FileSize: NotRequired[int],
    DurationMillis: NotRequired[int],

TimingTypeDef#

# TimingTypeDef definition

class TimingTypeDef(TypedDict):
    SubmitTimeMillis: NotRequired[int],
    StartTimeMillis: NotRequired[int],
    FinishTimeMillis: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListJobsByPipelineRequestRequestTypeDef#

# ListJobsByPipelineRequestRequestTypeDef definition

class ListJobsByPipelineRequestRequestTypeDef(TypedDict):
    PipelineId: str,
    Ascending: NotRequired[str],
    PageToken: NotRequired[str],

ListJobsByStatusRequestRequestTypeDef#

# ListJobsByStatusRequestRequestTypeDef definition

class ListJobsByStatusRequestRequestTypeDef(TypedDict):
    Status: str,
    Ascending: NotRequired[str],
    PageToken: NotRequired[str],

ListPipelinesRequestRequestTypeDef#

# ListPipelinesRequestRequestTypeDef definition

class ListPipelinesRequestRequestTypeDef(TypedDict):
    Ascending: NotRequired[str],
    PageToken: NotRequired[str],

ListPresetsRequestRequestTypeDef#

# ListPresetsRequestRequestTypeDef definition

class ListPresetsRequestRequestTypeDef(TypedDict):
    Ascending: NotRequired[str],
    PageToken: NotRequired[str],

PermissionPaginatorTypeDef#

# PermissionPaginatorTypeDef definition

class PermissionPaginatorTypeDef(TypedDict):
    GranteeType: NotRequired[str],
    Grantee: NotRequired[str],
    Access: NotRequired[List[str]],

PermissionTypeDef#

# PermissionTypeDef definition

class PermissionTypeDef(TypedDict):
    GranteeType: NotRequired[str],
    Grantee: NotRequired[str],
    Access: NotRequired[Sequence[str]],

PresetWatermarkTypeDef#

# PresetWatermarkTypeDef definition

class PresetWatermarkTypeDef(TypedDict):
    Id: NotRequired[str],
    MaxWidth: NotRequired[str],
    MaxHeight: NotRequired[str],
    SizingPolicy: NotRequired[str],
    HorizontalAlign: NotRequired[str],
    HorizontalOffset: NotRequired[str],
    VerticalAlign: NotRequired[str],
    VerticalOffset: NotRequired[str],
    Opacity: NotRequired[str],
    Target: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

ReadJobRequestRequestTypeDef#

# ReadJobRequestRequestTypeDef definition

class ReadJobRequestRequestTypeDef(TypedDict):
    Id: str,

ReadPipelineRequestRequestTypeDef#

# ReadPipelineRequestRequestTypeDef definition

class ReadPipelineRequestRequestTypeDef(TypedDict):
    Id: str,

ReadPresetRequestRequestTypeDef#

# ReadPresetRequestRequestTypeDef definition

class ReadPresetRequestRequestTypeDef(TypedDict):
    Id: str,

TestRoleRequestRequestTypeDef#

# TestRoleRequestRequestTypeDef definition

class TestRoleRequestRequestTypeDef(TypedDict):
    Role: str,
    InputBucket: str,
    OutputBucket: str,
    Topics: Sequence[str],

UpdatePipelineStatusRequestRequestTypeDef#

# UpdatePipelineStatusRequestRequestTypeDef definition

class UpdatePipelineStatusRequestRequestTypeDef(TypedDict):
    Id: str,
    Status: str,

ArtworkTypeDef#

# ArtworkTypeDef definition

class ArtworkTypeDef(TypedDict):
    InputKey: NotRequired[str],
    MaxWidth: NotRequired[str],
    MaxHeight: NotRequired[str],
    SizingPolicy: NotRequired[str],
    PaddingPolicy: NotRequired[str],
    AlbumArtFormat: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
  1. See EncryptionTypeDef

CaptionFormatTypeDef#

# CaptionFormatTypeDef definition

class CaptionFormatTypeDef(TypedDict):
    Format: NotRequired[str],
    Pattern: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
  1. See EncryptionTypeDef

CaptionSourceTypeDef#

# CaptionSourceTypeDef definition

class CaptionSourceTypeDef(TypedDict):
    Key: NotRequired[str],
    Language: NotRequired[str],
    TimeOffset: NotRequired[str],
    Label: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
  1. See EncryptionTypeDef

JobWatermarkTypeDef#

# JobWatermarkTypeDef definition

class JobWatermarkTypeDef(TypedDict):
    PresetWatermarkId: NotRequired[str],
    InputKey: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
  1. See EncryptionTypeDef

AudioParametersTypeDef#

# AudioParametersTypeDef definition

class AudioParametersTypeDef(TypedDict):
    Codec: NotRequired[str],
    SampleRate: NotRequired[str],
    BitRate: NotRequired[str],
    Channels: NotRequired[str],
    AudioPackingMode: NotRequired[str],
    CodecOptions: NotRequired[AudioCodecOptionsTypeDef],  # (1)
  1. See AudioCodecOptionsTypeDef

ClipTypeDef#

# ClipTypeDef definition

class ClipTypeDef(TypedDict):
    TimeSpan: NotRequired[TimeSpanTypeDef],  # (1)
  1. See TimeSpanTypeDef

CreateJobPlaylistTypeDef#

# CreateJobPlaylistTypeDef definition

class CreateJobPlaylistTypeDef(TypedDict):
    Name: NotRequired[str],
    Format: NotRequired[str],
    OutputKeys: NotRequired[Sequence[str]],
    HlsContentProtection: NotRequired[HlsContentProtectionTypeDef],  # (1)
    PlayReadyDrm: NotRequired[PlayReadyDrmTypeDef],  # (2)
  1. See HlsContentProtectionTypeDef
  2. See PlayReadyDrmTypeDef

PlaylistTypeDef#

# PlaylistTypeDef definition

class PlaylistTypeDef(TypedDict):
    Name: NotRequired[str],
    Format: NotRequired[str],
    OutputKeys: NotRequired[List[str]],
    HlsContentProtection: NotRequired[HlsContentProtectionTypeDef],  # (1)
    PlayReadyDrm: NotRequired[PlayReadyDrmTypeDef],  # (2)
    Status: NotRequired[str],
    StatusDetail: NotRequired[str],
  1. See HlsContentProtectionTypeDef
  2. See PlayReadyDrmTypeDef

TestRoleResponseTypeDef#

# TestRoleResponseTypeDef definition

class TestRoleResponseTypeDef(TypedDict):
    Success: str,
    Messages: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdatePipelineNotificationsRequestRequestTypeDef#

# UpdatePipelineNotificationsRequestRequestTypeDef definition

class UpdatePipelineNotificationsRequestRequestTypeDef(TypedDict):
    Id: str,
    Notifications: NotificationsTypeDef,  # (1)
  1. See NotificationsTypeDef

ListJobsByPipelineRequestListJobsByPipelinePaginateTypeDef#

# ListJobsByPipelineRequestListJobsByPipelinePaginateTypeDef definition

class ListJobsByPipelineRequestListJobsByPipelinePaginateTypeDef(TypedDict):
    PipelineId: str,
    Ascending: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListJobsByStatusRequestListJobsByStatusPaginateTypeDef#

# ListJobsByStatusRequestListJobsByStatusPaginateTypeDef definition

class ListJobsByStatusRequestListJobsByStatusPaginateTypeDef(TypedDict):
    Status: str,
    Ascending: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPipelinesRequestListPipelinesPaginateTypeDef#

# ListPipelinesRequestListPipelinesPaginateTypeDef definition

class ListPipelinesRequestListPipelinesPaginateTypeDef(TypedDict):
    Ascending: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListPresetsRequestListPresetsPaginateTypeDef#

# ListPresetsRequestListPresetsPaginateTypeDef definition

class ListPresetsRequestListPresetsPaginateTypeDef(TypedDict):
    Ascending: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

PipelineOutputConfigPaginatorTypeDef#

# PipelineOutputConfigPaginatorTypeDef definition

class PipelineOutputConfigPaginatorTypeDef(TypedDict):
    Bucket: NotRequired[str],
    StorageClass: NotRequired[str],
    Permissions: NotRequired[List[PermissionPaginatorTypeDef]],  # (1)
  1. See PermissionPaginatorTypeDef

PipelineOutputConfigTypeDef#

# PipelineOutputConfigTypeDef definition

class PipelineOutputConfigTypeDef(TypedDict):
    Bucket: NotRequired[str],
    StorageClass: NotRequired[str],
    Permissions: NotRequired[Sequence[PermissionTypeDef]],  # (1)
  1. See PermissionTypeDef

VideoParametersPaginatorTypeDef#

# VideoParametersPaginatorTypeDef definition

class VideoParametersPaginatorTypeDef(TypedDict):
    Codec: NotRequired[str],
    CodecOptions: NotRequired[Dict[str, str]],
    KeyframesMaxDist: NotRequired[str],
    FixedGOP: NotRequired[str],
    BitRate: NotRequired[str],
    FrameRate: NotRequired[str],
    MaxFrameRate: NotRequired[str],
    Resolution: NotRequired[str],
    AspectRatio: NotRequired[str],
    MaxWidth: NotRequired[str],
    MaxHeight: NotRequired[str],
    DisplayAspectRatio: NotRequired[str],
    SizingPolicy: NotRequired[str],
    PaddingPolicy: NotRequired[str],
    Watermarks: NotRequired[List[PresetWatermarkTypeDef]],  # (1)
  1. See PresetWatermarkTypeDef

VideoParametersTypeDef#

# VideoParametersTypeDef definition

class VideoParametersTypeDef(TypedDict):
    Codec: NotRequired[str],
    CodecOptions: NotRequired[Mapping[str, str]],
    KeyframesMaxDist: NotRequired[str],
    FixedGOP: NotRequired[str],
    BitRate: NotRequired[str],
    FrameRate: NotRequired[str],
    MaxFrameRate: NotRequired[str],
    Resolution: NotRequired[str],
    AspectRatio: NotRequired[str],
    MaxWidth: NotRequired[str],
    MaxHeight: NotRequired[str],
    DisplayAspectRatio: NotRequired[str],
    SizingPolicy: NotRequired[str],
    PaddingPolicy: NotRequired[str],
    Watermarks: NotRequired[Sequence[PresetWatermarkTypeDef]],  # (1)
  1. See PresetWatermarkTypeDef

ReadJobRequestJobCompleteWaitTypeDef#

# ReadJobRequestJobCompleteWaitTypeDef definition

class ReadJobRequestJobCompleteWaitTypeDef(TypedDict):
    Id: str,
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (1)
  1. See WaiterConfigTypeDef

JobAlbumArtPaginatorTypeDef#

# JobAlbumArtPaginatorTypeDef definition

class JobAlbumArtPaginatorTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    Artwork: NotRequired[List[ArtworkTypeDef]],  # (1)
  1. See ArtworkTypeDef

JobAlbumArtTypeDef#

# JobAlbumArtTypeDef definition

class JobAlbumArtTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    Artwork: NotRequired[Sequence[ArtworkTypeDef]],  # (1)
  1. See ArtworkTypeDef

CaptionsPaginatorTypeDef#

# CaptionsPaginatorTypeDef definition

class CaptionsPaginatorTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    CaptionSources: NotRequired[List[CaptionSourceTypeDef]],  # (1)
    CaptionFormats: NotRequired[List[CaptionFormatTypeDef]],  # (2)
  1. See CaptionSourceTypeDef
  2. See CaptionFormatTypeDef

CaptionsTypeDef#

# CaptionsTypeDef definition

class CaptionsTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    CaptionSources: NotRequired[Sequence[CaptionSourceTypeDef]],  # (1)
    CaptionFormats: NotRequired[Sequence[CaptionFormatTypeDef]],  # (2)
  1. See CaptionSourceTypeDef
  2. See CaptionFormatTypeDef

InputCaptionsPaginatorTypeDef#

# InputCaptionsPaginatorTypeDef definition

class InputCaptionsPaginatorTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    CaptionSources: NotRequired[List[CaptionSourceTypeDef]],  # (1)
  1. See CaptionSourceTypeDef

InputCaptionsTypeDef#

# InputCaptionsTypeDef definition

class InputCaptionsTypeDef(TypedDict):
    MergePolicy: NotRequired[str],
    CaptionSources: NotRequired[Sequence[CaptionSourceTypeDef]],  # (1)
  1. See CaptionSourceTypeDef

PipelinePaginatorTypeDef#

# PipelinePaginatorTypeDef definition

class PipelinePaginatorTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[str],
    InputBucket: NotRequired[str],
    OutputBucket: NotRequired[str],
    Role: NotRequired[str],
    AwsKmsKeyArn: NotRequired[str],
    Notifications: NotRequired[NotificationsTypeDef],  # (1)
    ContentConfig: NotRequired[PipelineOutputConfigPaginatorTypeDef],  # (2)
    ThumbnailConfig: NotRequired[PipelineOutputConfigPaginatorTypeDef],  # (2)
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigPaginatorTypeDef
  3. See PipelineOutputConfigPaginatorTypeDef

CreatePipelineRequestRequestTypeDef#

# CreatePipelineRequestRequestTypeDef definition

class CreatePipelineRequestRequestTypeDef(TypedDict):
    Name: str,
    InputBucket: str,
    Role: str,
    OutputBucket: NotRequired[str],
    AwsKmsKeyArn: NotRequired[str],
    Notifications: NotRequired[NotificationsTypeDef],  # (1)
    ContentConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
    ThumbnailConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigTypeDef
  3. See PipelineOutputConfigTypeDef

PipelineTypeDef#

# PipelineTypeDef definition

class PipelineTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Status: NotRequired[str],
    InputBucket: NotRequired[str],
    OutputBucket: NotRequired[str],
    Role: NotRequired[str],
    AwsKmsKeyArn: NotRequired[str],
    Notifications: NotRequired[NotificationsTypeDef],  # (1)
    ContentConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
    ThumbnailConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigTypeDef
  3. See PipelineOutputConfigTypeDef

UpdatePipelineRequestRequestTypeDef#

# UpdatePipelineRequestRequestTypeDef definition

class UpdatePipelineRequestRequestTypeDef(TypedDict):
    Id: str,
    Name: NotRequired[str],
    InputBucket: NotRequired[str],
    Role: NotRequired[str],
    AwsKmsKeyArn: NotRequired[str],
    Notifications: NotRequired[NotificationsTypeDef],  # (1)
    ContentConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
    ThumbnailConfig: NotRequired[PipelineOutputConfigTypeDef],  # (2)
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigTypeDef
  3. See PipelineOutputConfigTypeDef

PresetPaginatorTypeDef#

# PresetPaginatorTypeDef definition

class PresetPaginatorTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Container: NotRequired[str],
    Audio: NotRequired[AudioParametersTypeDef],  # (1)