Skip to content

Type definitions#

Index > ElasticTranscoder > Type definitions

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

PermissionUnionTypeDef#

# PermissionUnionTypeDef definition

PermissionUnionTypeDef = Union[
    PermissionTypeDef,  # (1)
    PermissionOutputTypeDef,  # (2)
]
  1. See PermissionTypeDef
  2. See PermissionOutputTypeDef

JobAlbumArtUnionTypeDef#

# JobAlbumArtUnionTypeDef definition

JobAlbumArtUnionTypeDef = Union[
    JobAlbumArtTypeDef,  # (1)
    JobAlbumArtOutputTypeDef,  # (2)
]
  1. See JobAlbumArtTypeDef
  2. See JobAlbumArtOutputTypeDef

CaptionsUnionTypeDef#

# CaptionsUnionTypeDef definition

CaptionsUnionTypeDef = Union[
    CaptionsTypeDef,  # (1)
    CaptionsOutputTypeDef,  # (2)
]
  1. See CaptionsTypeDef
  2. See CaptionsOutputTypeDef

InputCaptionsUnionTypeDef#

# InputCaptionsUnionTypeDef definition

InputCaptionsUnionTypeDef = Union[
    InputCaptionsTypeDef,  # (1)
    InputCaptionsOutputTypeDef,  # (2)
]
  1. See InputCaptionsTypeDef
  2. See InputCaptionsOutputTypeDef

JobInputUnionTypeDef#

# JobInputUnionTypeDef definition

JobInputUnionTypeDef = Union[
    JobInputTypeDef,  # (1)
    JobInputOutputTypeDef,  # (2)
]
  1. See JobInputTypeDef
  2. See JobInputOutputTypeDef

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],

PermissionOutputTypeDef#

# PermissionOutputTypeDef definition

class PermissionOutputTypeDef(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],

ReadJobRequestRequestTypeDef#

# ReadJobRequestRequestTypeDef definition

class ReadJobRequestRequestTypeDef(TypedDict):
    Id: str,

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

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

ListJobsByPipelineRequestPaginateTypeDef#

# ListJobsByPipelineRequestPaginateTypeDef definition

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

ListJobsByStatusRequestPaginateTypeDef#

# ListJobsByStatusRequestPaginateTypeDef definition

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

ListPipelinesRequestPaginateTypeDef#

# ListPipelinesRequestPaginateTypeDef definition

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

ListPresetsRequestPaginateTypeDef#

# ListPresetsRequestPaginateTypeDef definition

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

PipelineOutputConfigOutputTypeDef#

# PipelineOutputConfigOutputTypeDef definition

class PipelineOutputConfigOutputTypeDef(TypedDict):
    Bucket: NotRequired[str],
    StorageClass: NotRequired[str],
    Permissions: NotRequired[list[PermissionOutputTypeDef]],  # (1)
  1. See PermissionOutputTypeDef

VideoParametersOutputTypeDef#

# VideoParametersOutputTypeDef definition

class VideoParametersOutputTypeDef(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

ReadJobRequestWaitTypeDef#

# ReadJobRequestWaitTypeDef definition

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

JobAlbumArtOutputTypeDef#

# JobAlbumArtOutputTypeDef definition

class JobAlbumArtOutputTypeDef(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

CaptionsOutputTypeDef#

# CaptionsOutputTypeDef definition

class CaptionsOutputTypeDef(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

InputCaptionsOutputTypeDef#

# InputCaptionsOutputTypeDef definition

class InputCaptionsOutputTypeDef(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

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[PipelineOutputConfigOutputTypeDef],  # (2)
    ThumbnailConfig: NotRequired[PipelineOutputConfigOutputTypeDef],  # (2)
  1. See NotificationsTypeDef
  2. See PipelineOutputConfigOutputTypeDef
  3. See PipelineOutputConfigOutputTypeDef

PipelineOutputConfigTypeDef#

# PipelineOutputConfigTypeDef definition

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

PresetTypeDef#

# PresetTypeDef definition

class PresetTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    Name: NotRequired[str],
    Description: NotRequired[str],
    Container: NotRequired[str],
    Audio: NotRequired[AudioParametersTypeDef],  # (1)
    Video: NotRequired[VideoParametersOutputTypeDef],  # (2)
    Thumbnails: NotRequired[ThumbnailsTypeDef],  # (3)
    Type: NotRequired[str],
  1. See AudioParametersTypeDef
  2. See VideoParametersOutputTypeDef
  3. See ThumbnailsTypeDef

CreatePresetRequestRequestTypeDef#

# CreatePresetRequestRequestTypeDef definition

class CreatePresetRequestRequestTypeDef(TypedDict):
    Name: str,
    Container: str,
    Description: NotRequired[str],
    Video: NotRequired[VideoParametersTypeDef],  # (1)
    Audio: NotRequired[AudioParametersTypeDef],  # (2)
    Thumbnails: NotRequired[ThumbnailsTypeDef],  # (3)
  1. See VideoParametersTypeDef
  2. See AudioParametersTypeDef
  3. See ThumbnailsTypeDef

JobOutputTypeDef#

# JobOutputTypeDef definition

class JobOutputTypeDef(TypedDict):
    Id: NotRequired[str],
    Key: NotRequired[str],
    ThumbnailPattern: NotRequired[str],
    ThumbnailEncryption: NotRequired[EncryptionTypeDef],  # (1)
    Rotate: NotRequired[str],
    PresetId: NotRequired[str],
    SegmentDuration: NotRequired[str],
    Status: NotRequired[str],
    StatusDetail: NotRequired[str],
    Duration: NotRequired[int],
    Width: NotRequired[int],
    Height: NotRequired[int],
    FrameRate: NotRequired[str],
    FileSize: NotRequired[int],
    DurationMillis: NotRequired[int],
    Watermarks: NotRequired[list[JobWatermarkTypeDef]],  # (2)
    AlbumArt: NotRequired[JobAlbumArtOutputTypeDef],  # (3)
    Composition: NotRequired[list[ClipTypeDef]],  # (4)
    Captions: NotRequired[CaptionsOutputTypeDef],  # (5)
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    AppliedColorSpaceConversion: NotRequired[str],
  1. See EncryptionTypeDef
  2. See JobWatermarkTypeDef
  3. See JobAlbumArtOutputTypeDef
  4. See ClipTypeDef
  5. See CaptionsOutputTypeDef
  6. See EncryptionTypeDef

JobInputOutputTypeDef#

# JobInputOutputTypeDef definition

class JobInputOutputTypeDef(TypedDict):
    Key: NotRequired[str],
    FrameRate: NotRequired[str],
    Resolution: NotRequired[str],
    AspectRatio: NotRequired[str],
    Interlaced: NotRequired[str],
    Container: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    TimeSpan: NotRequired[TimeSpanTypeDef],  # (2)
    InputCaptions: NotRequired[InputCaptionsOutputTypeDef],  # (3)
    DetectedProperties: NotRequired[DetectedPropertiesTypeDef],  # (4)
  1. See EncryptionTypeDef
  2. See TimeSpanTypeDef
  3. See InputCaptionsOutputTypeDef
  4. See DetectedPropertiesTypeDef

CreatePipelineResponseTypeDef#

# CreatePipelineResponseTypeDef definition

class CreatePipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    Warnings: list[WarningTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PipelineTypeDef
  2. See WarningTypeDef
  3. See ResponseMetadataTypeDef

ListPipelinesResponseTypeDef#

# ListPipelinesResponseTypeDef definition

class ListPipelinesResponseTypeDef(TypedDict):
    Pipelines: list[PipelineTypeDef],  # (1)
    NextPageToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

ReadPipelineResponseTypeDef#

# ReadPipelineResponseTypeDef definition

class ReadPipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    Warnings: list[WarningTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PipelineTypeDef
  2. See WarningTypeDef
  3. See ResponseMetadataTypeDef

UpdatePipelineNotificationsResponseTypeDef#

# UpdatePipelineNotificationsResponseTypeDef definition

class UpdatePipelineNotificationsResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

UpdatePipelineResponseTypeDef#

# UpdatePipelineResponseTypeDef definition

class UpdatePipelineResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    Warnings: list[WarningTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See PipelineTypeDef
  2. See WarningTypeDef
  3. See ResponseMetadataTypeDef

UpdatePipelineStatusResponseTypeDef#

# UpdatePipelineStatusResponseTypeDef definition

class UpdatePipelineStatusResponseTypeDef(TypedDict):
    Pipeline: PipelineTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PipelineTypeDef
  2. See ResponseMetadataTypeDef

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

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

CreatePresetResponseTypeDef#

# CreatePresetResponseTypeDef definition

class CreatePresetResponseTypeDef(TypedDict):
    Preset: PresetTypeDef,  # (1)
    Warning: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PresetTypeDef
  2. See ResponseMetadataTypeDef

ListPresetsResponseTypeDef#

# ListPresetsResponseTypeDef definition

class ListPresetsResponseTypeDef(TypedDict):
    Presets: list[PresetTypeDef],  # (1)
    NextPageToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PresetTypeDef
  2. See ResponseMetadataTypeDef

ReadPresetResponseTypeDef#

# ReadPresetResponseTypeDef definition

class ReadPresetResponseTypeDef(TypedDict):
    Preset: PresetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PresetTypeDef
  2. See ResponseMetadataTypeDef

CreateJobOutputTypeDef#

# CreateJobOutputTypeDef definition

class CreateJobOutputTypeDef(TypedDict):
    Key: NotRequired[str],
    ThumbnailPattern: NotRequired[str],
    ThumbnailEncryption: NotRequired[EncryptionTypeDef],  # (1)
    Rotate: NotRequired[str],
    PresetId: NotRequired[str],
    SegmentDuration: NotRequired[str],
    Watermarks: NotRequired[Sequence[JobWatermarkTypeDef]],  # (2)
    AlbumArt: NotRequired[JobAlbumArtUnionTypeDef],  # (3)
    Composition: NotRequired[Sequence[ClipTypeDef]],  # (4)
    Captions: NotRequired[CaptionsUnionTypeDef],  # (5)
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
  1. See EncryptionTypeDef
  2. See JobWatermarkTypeDef
  3. See JobAlbumArtTypeDef JobAlbumArtOutputTypeDef
  4. See ClipTypeDef
  5. See CaptionsTypeDef CaptionsOutputTypeDef
  6. See EncryptionTypeDef

JobTypeDef#

# JobTypeDef definition

class JobTypeDef(TypedDict):
    Id: NotRequired[str],
    Arn: NotRequired[str],
    PipelineId: NotRequired[str],
    Input: NotRequired[JobInputOutputTypeDef],  # (1)
    Inputs: NotRequired[list[JobInputOutputTypeDef]],  # (2)
    Output: NotRequired[JobOutputTypeDef],  # (3)
    Outputs: NotRequired[list[JobOutputTypeDef]],  # (4)
    OutputKeyPrefix: NotRequired[str],
    Playlists: NotRequired[list[PlaylistTypeDef]],  # (5)
    Status: NotRequired[str],
    UserMetadata: NotRequired[dict[str, str]],
    Timing: NotRequired[TimingTypeDef],  # (6)
  1. See JobInputOutputTypeDef
  2. See JobInputOutputTypeDef
  3. See JobOutputTypeDef
  4. See JobOutputTypeDef
  5. See PlaylistTypeDef
  6. See TimingTypeDef

JobInputTypeDef#

# JobInputTypeDef definition

class JobInputTypeDef(TypedDict):
    Key: NotRequired[str],
    FrameRate: NotRequired[str],
    Resolution: NotRequired[str],
    AspectRatio: NotRequired[str],
    Interlaced: NotRequired[str],
    Container: NotRequired[str],
    Encryption: NotRequired[EncryptionTypeDef],  # (1)
    TimeSpan: NotRequired[TimeSpanTypeDef],  # (2)
    InputCaptions: NotRequired[InputCaptionsUnionTypeDef],  # (3)
    DetectedProperties: NotRequired[DetectedPropertiesTypeDef],  # (4)
  1. See EncryptionTypeDef
  2. See TimeSpanTypeDef
  3. See InputCaptionsTypeDef InputCaptionsOutputTypeDef
  4. See DetectedPropertiesTypeDef

CreateJobResponseTypeDef#

# CreateJobResponseTypeDef definition

class CreateJobResponseTypeDef(TypedDict):
    Job: JobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

ListJobsByPipelineResponseTypeDef#

# ListJobsByPipelineResponseTypeDef definition

class ListJobsByPipelineResponseTypeDef(TypedDict):
    Jobs: list[JobTypeDef],  # (1)
    NextPageToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

ListJobsByStatusResponseTypeDef#

# ListJobsByStatusResponseTypeDef definition

class ListJobsByStatusResponseTypeDef(TypedDict):
    Jobs: list[JobTypeDef],  # (1)
    NextPageToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

ReadJobResponseTypeDef#

# ReadJobResponseTypeDef definition

class ReadJobResponseTypeDef(TypedDict):
    Job: JobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See JobTypeDef
  2. See ResponseMetadataTypeDef

CreateJobRequestRequestTypeDef#

# CreateJobRequestRequestTypeDef definition

class CreateJobRequestRequestTypeDef(TypedDict):
    PipelineId: str,
    Input: NotRequired[JobInputTypeDef],  # (1)
    Inputs: NotRequired[Sequence[JobInputUnionTypeDef]],  # (2)
    Output: NotRequired[CreateJobOutputTypeDef],  # (3)
    Outputs: NotRequired[Sequence[CreateJobOutputTypeDef]],  # (4)
    OutputKeyPrefix: NotRequired[str],
    Playlists: NotRequired[Sequence[CreateJobPlaylistTypeDef]],  # (5)
    UserMetadata: NotRequired[Mapping[str, str]],
  1. See JobInputTypeDef
  2. See JobInputTypeDef JobInputOutputTypeDef
  3. See CreateJobOutputTypeDef
  4. See CreateJobOutputTypeDef
  5. See CreateJobPlaylistTypeDef