MediaLiveClient

Index > MediaLive > MediaLiveClient

Auto-generated documentation for MediaLive type annotations stubs module mypy-boto3-medialive.

MediaLiveClient

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

Usage example

from boto3.session import Session
from mypy_boto3_medialive.client import MediaLiveClient

def get_medialive_client() -> MediaLiveClient:
    return Session().client("medialive")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("medialive").exceptions structure.

Usage example

client = boto3.client("medialive")

try:
    do_something(client)
except (
    client.BadGatewayException,
    client.BadRequestException,
    client.ClientError,
    client.ConflictException,
    client.ForbiddenException,
    client.GatewayTimeoutException,
    client.InternalServerErrorException,
    client.NotFoundException,
    client.TooManyRequestsException,
    client.UnprocessableEntityException,
) as e:
    print(e)

Type checking example

from mypy_boto3_medialive.client import Exceptions

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

Methods

accept_input_device_transfer

Accept an incoming input device transfer.

Type annotations and code completion for boto3.client("medialive").accept_input_device_transfer method. boto3 documentation

Method definition

def accept_input_device_transfer(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: AcceptInputDeviceTransferRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.accept_input_device_transfer(**kwargs)

1. See AcceptInputDeviceTransferRequestRequestTypeDef

batch_delete

Starts delete of resources.

Type annotations and code completion for boto3.client("medialive").batch_delete method. boto3 documentation

Method definition

def batch_delete(
    self,
    *,
    ChannelIds: Sequence[str] = ...,
    InputIds: Sequence[str] = ...,
    InputSecurityGroupIds: Sequence[str] = ...,
    MultiplexIds: Sequence[str] = ...,
) -> BatchDeleteResponseTypeDef:  # (1)
    ...

1. See BatchDeleteResponseTypeDef

Usage example with kwargs

kwargs: BatchDeleteRequestRequestTypeDef = {  # (1)
    "ChannelIds": ...,
}

parent.batch_delete(**kwargs)

1. See BatchDeleteRequestRequestTypeDef

batch_start

Starts existing resources See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").batch_start method. boto3 documentation

Method definition

def batch_start(
    self,
    *,
    ChannelIds: Sequence[str] = ...,
    MultiplexIds: Sequence[str] = ...,
) -> BatchStartResponseTypeDef:  # (1)
    ...

1. See BatchStartResponseTypeDef

Usage example with kwargs

kwargs: BatchStartRequestRequestTypeDef = {  # (1)
    "ChannelIds": ...,
}

parent.batch_start(**kwargs)

1. See BatchStartRequestRequestTypeDef

batch_stop

Stops running resources See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").batch_stop method. boto3 documentation

Method definition

def batch_stop(
    self,
    *,
    ChannelIds: Sequence[str] = ...,
    MultiplexIds: Sequence[str] = ...,
) -> BatchStopResponseTypeDef:  # (1)
    ...

1. See BatchStopResponseTypeDef

Usage example with kwargs

kwargs: BatchStopRequestRequestTypeDef = {  # (1)
    "ChannelIds": ...,
}

parent.batch_stop(**kwargs)

1. See BatchStopRequestRequestTypeDef

batch_update_schedule

Update a channel schedule See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").batch_update_schedule method. boto3 documentation

Method definition

def batch_update_schedule(
    self,
    *,
    ChannelId: str,
    Creates: BatchScheduleActionCreateRequestTypeDef = ...,  # (1)
    Deletes: BatchScheduleActionDeleteRequestTypeDef = ...,  # (2)
) -> BatchUpdateScheduleResponseTypeDef:  # (3)
    ...

1. See BatchScheduleActionCreateRequestTypeDef
2. See BatchScheduleActionDeleteRequestTypeDef
3. See BatchUpdateScheduleResponseTypeDef

Usage example with kwargs

kwargs: BatchUpdateScheduleRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.batch_update_schedule(**kwargs)

1. See BatchUpdateScheduleRequestRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("medialive").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

cancel_input_device_transfer

Cancel an input device transfer that you have requested.

Type annotations and code completion for boto3.client("medialive").cancel_input_device_transfer method. boto3 documentation

Method definition

def cancel_input_device_transfer(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: CancelInputDeviceTransferRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.cancel_input_device_transfer(**kwargs)

1. See CancelInputDeviceTransferRequestRequestTypeDef

claim_device

Send a request to claim an AWS Elemental device that you have purchased from a third-party vendor.

Type annotations and code completion for boto3.client("medialive").claim_device method. boto3 documentation

Method definition

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

Usage example with kwargs

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

parent.claim_device(**kwargs)

1. See ClaimDeviceRequestRequestTypeDef

close

Closes underlying endpoint connections.

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

Method definition

def close(
    self,
) -> None:
    ...

create_channel

Creates a new channel See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").create_channel method. boto3 documentation

Method definition

def create_channel(
    self,
    *,
    CdiInputSpecification: CdiInputSpecificationTypeDef = ...,  # (1)
    ChannelClass: ChannelClassType = ...,  # (2)
    Destinations: Sequence[OutputDestinationTypeDef] = ...,  # (3)
    EncoderSettings: EncoderSettingsTypeDef = ...,  # (4)
    InputAttachments: Sequence[InputAttachmentTypeDef] = ...,  # (5)
    InputSpecification: InputSpecificationTypeDef = ...,  # (6)
    LogLevel: LogLevelType = ...,  # (7)
    Maintenance: MaintenanceCreateSettingsTypeDef = ...,  # (8)
    Name: str = ...,
    RequestId: str = ...,
    Reserved: str = ...,
    RoleArn: str = ...,
    Tags: Mapping[str, str] = ...,
    Vpc: VpcOutputSettingsTypeDef = ...,  # (9)
) -> CreateChannelResponseTypeDef:  # (10)
    ...

1. See CdiInputSpecificationTypeDef
2. See ChannelClassType
3. See OutputDestinationTypeDef
4. See EncoderSettingsTypeDef
5. See InputAttachmentTypeDef
6. See InputSpecificationTypeDef
7. See LogLevelType
8. See MaintenanceCreateSettingsTypeDef
9. See VpcOutputSettingsTypeDef
10. See CreateChannelResponseTypeDef

Usage example with kwargs

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "CdiInputSpecification": ...,
}

parent.create_channel(**kwargs)

1. See CreateChannelRequestRequestTypeDef

create_input

Create an input See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").create_input method. boto3 documentation

Method definition

def create_input(
    self,
    *,
    Destinations: Sequence[InputDestinationRequestTypeDef] = ...,  # (1)
    InputDevices: Sequence[InputDeviceSettingsTypeDef] = ...,  # (2)
    InputSecurityGroups: Sequence[str] = ...,
    MediaConnectFlows: Sequence[MediaConnectFlowRequestTypeDef] = ...,  # (3)
    Name: str = ...,
    RequestId: str = ...,
    RoleArn: str = ...,
    Sources: Sequence[InputSourceRequestTypeDef] = ...,  # (4)
    Tags: Mapping[str, str] = ...,
    Type: InputTypeType = ...,  # (5)
    Vpc: InputVpcRequestTypeDef = ...,  # (6)
) -> CreateInputResponseTypeDef:  # (7)
    ...

1. See InputDestinationRequestTypeDef
2. See InputDeviceSettingsTypeDef
3. See MediaConnectFlowRequestTypeDef
4. See InputSourceRequestTypeDef
5. See InputTypeType
6. See InputVpcRequestTypeDef
7. See CreateInputResponseTypeDef

Usage example with kwargs

kwargs: CreateInputRequestRequestTypeDef = {  # (1)
    "Destinations": ...,
}

parent.create_input(**kwargs)

1. See CreateInputRequestRequestTypeDef

create_input_security_group

Creates a Input Security Group See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").create_input_security_group method. boto3 documentation

Method definition

def create_input_security_group(
    self,
    *,
    Tags: Mapping[str, str] = ...,
    WhitelistRules: Sequence[InputWhitelistRuleCidrTypeDef] = ...,  # (1)
) -> CreateInputSecurityGroupResponseTypeDef:  # (2)
    ...

1. See InputWhitelistRuleCidrTypeDef
2. See CreateInputSecurityGroupResponseTypeDef

Usage example with kwargs

kwargs: CreateInputSecurityGroupRequestRequestTypeDef = {  # (1)
    "Tags": ...,
}

parent.create_input_security_group(**kwargs)

1. See CreateInputSecurityGroupRequestRequestTypeDef

create_multiplex

Create a new multiplex.

Type annotations and code completion for boto3.client("medialive").create_multiplex method. boto3 documentation

Method definition

def create_multiplex(
    self,
    *,
    AvailabilityZones: Sequence[str],
    MultiplexSettings: MultiplexSettingsTypeDef,  # (1)
    Name: str,
    RequestId: str,
    Tags: Mapping[str, str] = ...,
) -> CreateMultiplexResponseTypeDef:  # (2)
    ...

1. See MultiplexSettingsTypeDef
2. See CreateMultiplexResponseTypeDef

Usage example with kwargs

kwargs: CreateMultiplexRequestRequestTypeDef = {  # (1)
    "AvailabilityZones": ...,
    "MultiplexSettings": ...,
    "Name": ...,
    "RequestId": ...,
}

parent.create_multiplex(**kwargs)

1. See CreateMultiplexRequestRequestTypeDef

create_multiplex_program

Create a new program in the multiplex.

Type annotations and code completion for boto3.client("medialive").create_multiplex_program method. boto3 documentation

Method definition

def create_multiplex_program(
    self,
    *,
    MultiplexId: str,
    MultiplexProgramSettings: MultiplexProgramSettingsTypeDef,  # (1)
    ProgramName: str,
    RequestId: str,
) -> CreateMultiplexProgramResponseTypeDef:  # (2)
    ...

1. See MultiplexProgramSettingsTypeDef
2. See CreateMultiplexProgramResponseTypeDef

Usage example with kwargs

kwargs: CreateMultiplexProgramRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
    "MultiplexProgramSettings": ...,
    "ProgramName": ...,
    "RequestId": ...,
}

parent.create_multiplex_program(**kwargs)

1. See CreateMultiplexProgramRequestRequestTypeDef

create_partner_input

Create a partner input See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").create_partner_input method. boto3 documentation

Method definition

def create_partner_input(
    self,
    *,
    InputId: str,
    RequestId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreatePartnerInputResponseTypeDef:  # (1)
    ...

1. See CreatePartnerInputResponseTypeDef

Usage example with kwargs

kwargs: CreatePartnerInputRequestRequestTypeDef = {  # (1)
    "InputId": ...,
}

parent.create_partner_input(**kwargs)

1. See CreatePartnerInputRequestRequestTypeDef

create_tags

Create tags for a resource See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").create_tags method. boto3 documentation

Method definition

def create_tags(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: CreateTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.create_tags(**kwargs)

1. See CreateTagsRequestRequestTypeDef

delete_channel

Starts deletion of channel.

Type annotations and code completion for boto3.client("medialive").delete_channel method. boto3 documentation

Method definition

def delete_channel(
    self,
    *,
    ChannelId: str,
) -> DeleteChannelResponseTypeDef:  # (1)
    ...

1. See DeleteChannelResponseTypeDef

Usage example with kwargs

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestRequestTypeDef

delete_input

Deletes the input end point See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").delete_input method. boto3 documentation

Method definition

def delete_input(
    self,
    *,
    InputId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteInputRequestRequestTypeDef = {  # (1)
    "InputId": ...,
}

parent.delete_input(**kwargs)

1. See DeleteInputRequestRequestTypeDef

delete_input_security_group

Deletes an Input Security Group See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").delete_input_security_group method. boto3 documentation

Method definition

def delete_input_security_group(
    self,
    *,
    InputSecurityGroupId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteInputSecurityGroupRequestRequestTypeDef = {  # (1)
    "InputSecurityGroupId": ...,
}

parent.delete_input_security_group(**kwargs)

1. See DeleteInputSecurityGroupRequestRequestTypeDef

delete_multiplex

Delete a multiplex.

Type annotations and code completion for boto3.client("medialive").delete_multiplex method. boto3 documentation

Method definition

def delete_multiplex(
    self,
    *,
    MultiplexId: str,
) -> DeleteMultiplexResponseTypeDef:  # (1)
    ...

1. See DeleteMultiplexResponseTypeDef

Usage example with kwargs

kwargs: DeleteMultiplexRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.delete_multiplex(**kwargs)

1. See DeleteMultiplexRequestRequestTypeDef

delete_multiplex_program

Delete a program from a multiplex.

Type annotations and code completion for boto3.client("medialive").delete_multiplex_program method. boto3 documentation

Method definition

def delete_multiplex_program(
    self,
    *,
    MultiplexId: str,
    ProgramName: str,
) -> DeleteMultiplexProgramResponseTypeDef:  # (1)
    ...

1. See DeleteMultiplexProgramResponseTypeDef

Usage example with kwargs

kwargs: DeleteMultiplexProgramRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
    "ProgramName": ...,
}

parent.delete_multiplex_program(**kwargs)

1. See DeleteMultiplexProgramRequestRequestTypeDef

delete_reservation

Delete an expired reservation.

Type annotations and code completion for boto3.client("medialive").delete_reservation method. boto3 documentation

Method definition

def delete_reservation(
    self,
    *,
    ReservationId: str,
) -> DeleteReservationResponseTypeDef:  # (1)
    ...

1. See DeleteReservationResponseTypeDef

Usage example with kwargs

kwargs: DeleteReservationRequestRequestTypeDef = {  # (1)
    "ReservationId": ...,
}

parent.delete_reservation(**kwargs)

1. See DeleteReservationRequestRequestTypeDef

delete_schedule

Delete all schedule actions on a channel.

Type annotations and code completion for boto3.client("medialive").delete_schedule method. boto3 documentation

Method definition

def delete_schedule(
    self,
    *,
    ChannelId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: DeleteScheduleRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.delete_schedule(**kwargs)

1. See DeleteScheduleRequestRequestTypeDef

delete_tags

Removes tags for a resource See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").delete_tags method. boto3 documentation

Method definition

def delete_tags(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: DeleteTagsRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.delete_tags(**kwargs)

1. See DeleteTagsRequestRequestTypeDef

describe_channel

Gets details about a channel See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").describe_channel method. boto3 documentation

Method definition

def describe_channel(
    self,
    *,
    ChannelId: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...

1. See DescribeChannelResponseTypeDef

Usage example with kwargs

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.describe_channel(**kwargs)

1. See DescribeChannelRequestRequestTypeDef

describe_input

Produces details about an input See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").describe_input method. boto3 documentation

Method definition

def describe_input(
    self,
    *,
    InputId: str,
) -> DescribeInputResponseTypeDef:  # (1)
    ...

1. See DescribeInputResponseTypeDef

Usage example with kwargs

kwargs: DescribeInputRequestRequestTypeDef = {  # (1)
    "InputId": ...,
}

parent.describe_input(**kwargs)

1. See DescribeInputRequestRequestTypeDef

describe_input_device

Gets the details for the input device See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").describe_input_device method. boto3 documentation

Method definition

def describe_input_device(
    self,
    *,
    InputDeviceId: str,
) -> DescribeInputDeviceResponseTypeDef:  # (1)
    ...

1. See DescribeInputDeviceResponseTypeDef

Usage example with kwargs

kwargs: DescribeInputDeviceRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.describe_input_device(**kwargs)

1. See DescribeInputDeviceRequestRequestTypeDef

describe_input_device_thumbnail

Get the latest thumbnail data for the input device.

Type annotations and code completion for boto3.client("medialive").describe_input_device_thumbnail method. boto3 documentation

Method definition

def describe_input_device_thumbnail(
    self,
    *,
    InputDeviceId: str,
    Accept: AcceptHeaderType,  # (1)
) -> DescribeInputDeviceThumbnailResponseTypeDef:  # (2)
    ...

1. See AcceptHeaderType
2. See DescribeInputDeviceThumbnailResponseTypeDef

Usage example with kwargs

kwargs: DescribeInputDeviceThumbnailRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
    "Accept": ...,
}

parent.describe_input_device_thumbnail(**kwargs)

1. See DescribeInputDeviceThumbnailRequestRequestTypeDef

describe_input_security_group

Produces a summary of an Input Security Group See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").describe_input_security_group method. boto3 documentation

Method definition

def describe_input_security_group(
    self,
    *,
    InputSecurityGroupId: str,
) -> DescribeInputSecurityGroupResponseTypeDef:  # (1)
    ...

1. See DescribeInputSecurityGroupResponseTypeDef

Usage example with kwargs

kwargs: DescribeInputSecurityGroupRequestRequestTypeDef = {  # (1)
    "InputSecurityGroupId": ...,
}

parent.describe_input_security_group(**kwargs)

1. See DescribeInputSecurityGroupRequestRequestTypeDef

describe_multiplex

Gets details about a multiplex.

Type annotations and code completion for boto3.client("medialive").describe_multiplex method. boto3 documentation

Method definition

def describe_multiplex(
    self,
    *,
    MultiplexId: str,
) -> DescribeMultiplexResponseTypeDef:  # (1)
    ...

1. See DescribeMultiplexResponseTypeDef

Usage example with kwargs

kwargs: DescribeMultiplexRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.describe_multiplex(**kwargs)

1. See DescribeMultiplexRequestRequestTypeDef

describe_multiplex_program

Get the details for a program in a multiplex.

Type annotations and code completion for boto3.client("medialive").describe_multiplex_program method. boto3 documentation

Method definition

def describe_multiplex_program(
    self,
    *,
    MultiplexId: str,
    ProgramName: str,
) -> DescribeMultiplexProgramResponseTypeDef:  # (1)
    ...

1. See DescribeMultiplexProgramResponseTypeDef

Usage example with kwargs

kwargs: DescribeMultiplexProgramRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
    "ProgramName": ...,
}

parent.describe_multiplex_program(**kwargs)

1. See DescribeMultiplexProgramRequestRequestTypeDef

describe_offering

Get details for an offering.

Type annotations and code completion for boto3.client("medialive").describe_offering method. boto3 documentation

Method definition

def describe_offering(
    self,
    *,
    OfferingId: str,
) -> DescribeOfferingResponseTypeDef:  # (1)
    ...

1. See DescribeOfferingResponseTypeDef

Usage example with kwargs

kwargs: DescribeOfferingRequestRequestTypeDef = {  # (1)
    "OfferingId": ...,
}

parent.describe_offering(**kwargs)

1. See DescribeOfferingRequestRequestTypeDef

describe_reservation

Get details for a reservation.

Type annotations and code completion for boto3.client("medialive").describe_reservation method. boto3 documentation

Method definition

def describe_reservation(
    self,
    *,
    ReservationId: str,
) -> DescribeReservationResponseTypeDef:  # (1)
    ...

1. See DescribeReservationResponseTypeDef

Usage example with kwargs

kwargs: DescribeReservationRequestRequestTypeDef = {  # (1)
    "ReservationId": ...,
}

parent.describe_reservation(**kwargs)

1. See DescribeReservationRequestRequestTypeDef

describe_schedule

Get a channel schedule See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").describe_schedule method. boto3 documentation

Method definition

def describe_schedule(
    self,
    *,
    ChannelId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> DescribeScheduleResponseTypeDef:  # (1)
    ...

1. See DescribeScheduleResponseTypeDef

Usage example with kwargs

kwargs: DescribeScheduleRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.describe_schedule(**kwargs)

1. See DescribeScheduleRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("medialive").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_channels

Produces list of channels that have been created See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").list_channels method. boto3 documentation

Method definition

def list_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...

1. See ListChannelsResponseTypeDef

Usage example with kwargs

kwargs: ListChannelsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_channels(**kwargs)

1. See ListChannelsRequestRequestTypeDef

list_input_device_transfers

List input devices that are currently being transferred.

Type annotations and code completion for boto3.client("medialive").list_input_device_transfers method. boto3 documentation

Method definition

def list_input_device_transfers(
    self,
    *,
    TransferType: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInputDeviceTransfersResponseTypeDef:  # (1)
    ...

1. See ListInputDeviceTransfersResponseTypeDef

Usage example with kwargs

kwargs: ListInputDeviceTransfersRequestRequestTypeDef = {  # (1)
    "TransferType": ...,
}

parent.list_input_device_transfers(**kwargs)

1. See ListInputDeviceTransfersRequestRequestTypeDef

list_input_devices

List input devices See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").list_input_devices method. boto3 documentation

Method definition

def list_input_devices(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInputDevicesResponseTypeDef:  # (1)
    ...

1. See ListInputDevicesResponseTypeDef

Usage example with kwargs

kwargs: ListInputDevicesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_input_devices(**kwargs)

1. See ListInputDevicesRequestRequestTypeDef

list_input_security_groups

Produces a list of Input Security Groups for an account See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").list_input_security_groups method. boto3 documentation

Method definition

def list_input_security_groups(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInputSecurityGroupsResponseTypeDef:  # (1)
    ...

1. See ListInputSecurityGroupsResponseTypeDef

Usage example with kwargs

kwargs: ListInputSecurityGroupsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_input_security_groups(**kwargs)

1. See ListInputSecurityGroupsRequestRequestTypeDef

list_inputs

Produces list of inputs that have been created See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").list_inputs method. boto3 documentation

Method definition

def list_inputs(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListInputsResponseTypeDef:  # (1)
    ...

1. See ListInputsResponseTypeDef

Usage example with kwargs

kwargs: ListInputsRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_inputs(**kwargs)

1. See ListInputsRequestRequestTypeDef

list_multiplex_programs

List the programs that currently exist for a specific multiplex.

Type annotations and code completion for boto3.client("medialive").list_multiplex_programs method. boto3 documentation

Method definition

def list_multiplex_programs(
    self,
    *,
    MultiplexId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMultiplexProgramsResponseTypeDef:  # (1)
    ...

1. See ListMultiplexProgramsResponseTypeDef

Usage example with kwargs

kwargs: ListMultiplexProgramsRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.list_multiplex_programs(**kwargs)

1. See ListMultiplexProgramsRequestRequestTypeDef

list_multiplexes

Retrieve a list of the existing multiplexes.

Type annotations and code completion for boto3.client("medialive").list_multiplexes method. boto3 documentation

Method definition

def list_multiplexes(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListMultiplexesResponseTypeDef:  # (1)
    ...

1. See ListMultiplexesResponseTypeDef

Usage example with kwargs

kwargs: ListMultiplexesRequestRequestTypeDef = {  # (1)
    "MaxResults": ...,
}

parent.list_multiplexes(**kwargs)

1. See ListMultiplexesRequestRequestTypeDef

list_offerings

List offerings available for purchase.

Type annotations and code completion for boto3.client("medialive").list_offerings method. boto3 documentation

Method definition

def list_offerings(
    self,
    *,
    ChannelClass: str = ...,
    ChannelConfiguration: str = ...,
    Codec: str = ...,
    Duration: str = ...,
    MaxResults: int = ...,
    MaximumBitrate: str = ...,
    MaximumFramerate: str = ...,
    NextToken: str = ...,
    Resolution: str = ...,
    ResourceType: str = ...,
    SpecialFeature: str = ...,
    VideoQuality: str = ...,
) -> ListOfferingsResponseTypeDef:  # (1)
    ...

1. See ListOfferingsResponseTypeDef

Usage example with kwargs

kwargs: ListOfferingsRequestRequestTypeDef = {  # (1)
    "ChannelClass": ...,
}

parent.list_offerings(**kwargs)

1. See ListOfferingsRequestRequestTypeDef

list_reservations

List purchased reservations.

Type annotations and code completion for boto3.client("medialive").list_reservations method. boto3 documentation

Method definition

def list_reservations(
    self,
    *,
    ChannelClass: str = ...,
    Codec: str = ...,
    MaxResults: int = ...,
    MaximumBitrate: str = ...,
    MaximumFramerate: str = ...,
    NextToken: str = ...,
    Resolution: str = ...,
    ResourceType: str = ...,
    SpecialFeature: str = ...,
    VideoQuality: str = ...,
) -> ListReservationsResponseTypeDef:  # (1)
    ...

1. See ListReservationsResponseTypeDef

Usage example with kwargs

kwargs: ListReservationsRequestRequestTypeDef = {  # (1)
    "ChannelClass": ...,
}

parent.list_reservations(**kwargs)

1. See ListReservationsRequestRequestTypeDef

list_tags_for_resource

Produces list of tags that have been created for a resource See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

purchase_offering

Purchase an offering and create a reservation.

Type annotations and code completion for boto3.client("medialive").purchase_offering method. boto3 documentation

Method definition

def purchase_offering(
    self,
    *,
    Count: int,
    OfferingId: str,
    Name: str = ...,
    RenewalSettings: RenewalSettingsTypeDef = ...,  # (1)
    RequestId: str = ...,
    Start: str = ...,
    Tags: Mapping[str, str] = ...,
) -> PurchaseOfferingResponseTypeDef:  # (2)
    ...

1. See RenewalSettingsTypeDef
2. See PurchaseOfferingResponseTypeDef

Usage example with kwargs

kwargs: PurchaseOfferingRequestRequestTypeDef = {  # (1)
    "Count": ...,
    "OfferingId": ...,
}

parent.purchase_offering(**kwargs)

1. See PurchaseOfferingRequestRequestTypeDef

reboot_input_device

Send a reboot command to the specified input device.

Type annotations and code completion for boto3.client("medialive").reboot_input_device method. boto3 documentation

Method definition

def reboot_input_device(
    self,
    *,
    InputDeviceId: str,
    Force: RebootInputDeviceForceType = ...,  # (1)
) -> Dict[str, Any]:
    ...

1. See RebootInputDeviceForceType

Usage example with kwargs

kwargs: RebootInputDeviceRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.reboot_input_device(**kwargs)

1. See RebootInputDeviceRequestRequestTypeDef

reject_input_device_transfer

Reject the transfer of the specified input device to your AWS account.

Type annotations and code completion for boto3.client("medialive").reject_input_device_transfer method. boto3 documentation

Method definition

def reject_input_device_transfer(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: RejectInputDeviceTransferRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.reject_input_device_transfer(**kwargs)

1. See RejectInputDeviceTransferRequestRequestTypeDef

start_channel

Starts an existing channel See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").start_channel method. boto3 documentation

Method definition

def start_channel(
    self,
    *,
    ChannelId: str,
) -> StartChannelResponseTypeDef:  # (1)
    ...

1. See StartChannelResponseTypeDef

Usage example with kwargs

kwargs: StartChannelRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.start_channel(**kwargs)

1. See StartChannelRequestRequestTypeDef

start_input_device_maintenance_window

Start a maintenance window for the specified input device.

Type annotations and code completion for boto3.client("medialive").start_input_device_maintenance_window method. boto3 documentation

Method definition

def start_input_device_maintenance_window(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: StartInputDeviceMaintenanceWindowRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.start_input_device_maintenance_window(**kwargs)

1. See StartInputDeviceMaintenanceWindowRequestRequestTypeDef

start_multiplex

Start (run) the multiplex.

Type annotations and code completion for boto3.client("medialive").start_multiplex method. boto3 documentation

Method definition

def start_multiplex(
    self,
    *,
    MultiplexId: str,
) -> StartMultiplexResponseTypeDef:  # (1)
    ...

1. See StartMultiplexResponseTypeDef

Usage example with kwargs

kwargs: StartMultiplexRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.start_multiplex(**kwargs)

1. See StartMultiplexRequestRequestTypeDef

stop_channel

Stops a running channel See also: AWS API Documentation.

Type annotations and code completion for boto3.client("medialive").stop_channel method. boto3 documentation

Method definition

def stop_channel(
    self,
    *,
    ChannelId: str,
) -> StopChannelResponseTypeDef:  # (1)
    ...

1. See StopChannelResponseTypeDef

Usage example with kwargs

kwargs: StopChannelRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.stop_channel(**kwargs)

1. See StopChannelRequestRequestTypeDef

stop_multiplex

Stops a running multiplex.

Type annotations and code completion for boto3.client("medialive").stop_multiplex method. boto3 documentation

Method definition

def stop_multiplex(
    self,
    *,
    MultiplexId: str,
) -> StopMultiplexResponseTypeDef:  # (1)
    ...

1. See StopMultiplexResponseTypeDef

Usage example with kwargs

kwargs: StopMultiplexRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.stop_multiplex(**kwargs)

1. See StopMultiplexRequestRequestTypeDef

transfer_input_device

Start an input device transfer to another AWS account.

Type annotations and code completion for boto3.client("medialive").transfer_input_device method. boto3 documentation

Method definition

def transfer_input_device(
    self,
    *,
    InputDeviceId: str,
    TargetCustomerId: str = ...,
    TargetRegion: str = ...,
    TransferMessage: str = ...,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

kwargs: TransferInputDeviceRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.transfer_input_device(**kwargs)

1. See TransferInputDeviceRequestRequestTypeDef

update_channel

Updates a channel.

Type annotations and code completion for boto3.client("medialive").update_channel method. boto3 documentation

Method definition

def update_channel(
    self,
    *,
    ChannelId: str,
    CdiInputSpecification: CdiInputSpecificationTypeDef = ...,  # (1)
    Destinations: Sequence[OutputDestinationTypeDef] = ...,  # (2)
    EncoderSettings: EncoderSettingsTypeDef = ...,  # (3)
    InputAttachments: Sequence[InputAttachmentTypeDef] = ...,  # (4)
    InputSpecification: InputSpecificationTypeDef = ...,  # (5)
    LogLevel: LogLevelType = ...,  # (6)
    Maintenance: MaintenanceUpdateSettingsTypeDef = ...,  # (7)
    Name: str = ...,
    RoleArn: str = ...,
) -> UpdateChannelResponseTypeDef:  # (8)
    ...

1. See CdiInputSpecificationTypeDef
2. See OutputDestinationTypeDef
3. See EncoderSettingsTypeDef
4. See InputAttachmentTypeDef
5. See InputSpecificationTypeDef
6. See LogLevelType
7. See MaintenanceUpdateSettingsTypeDef
8. See UpdateChannelResponseTypeDef

Usage example with kwargs

kwargs: UpdateChannelRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

update_channel_class

Changes the class of the channel.

Type annotations and code completion for boto3.client("medialive").update_channel_class method. boto3 documentation

Method definition

def update_channel_class(
    self,
    *,
    ChannelClass: ChannelClassType,  # (1)
    ChannelId: str,
    Destinations: Sequence[OutputDestinationTypeDef] = ...,  # (2)
) -> UpdateChannelClassResponseTypeDef:  # (3)
    ...

1. See ChannelClassType
2. See OutputDestinationTypeDef
3. See UpdateChannelClassResponseTypeDef

Usage example with kwargs

kwargs: UpdateChannelClassRequestRequestTypeDef = {  # (1)
    "ChannelClass": ...,
    "ChannelId": ...,
}

parent.update_channel_class(**kwargs)

1. See UpdateChannelClassRequestRequestTypeDef

update_input

Updates an input.

Type annotations and code completion for boto3.client("medialive").update_input method. boto3 documentation

Method definition

def update_input(
    self,
    *,
    InputId: str,
    Destinations: Sequence[InputDestinationRequestTypeDef] = ...,  # (1)
    InputDevices: Sequence[InputDeviceRequestTypeDef] = ...,  # (2)
    InputSecurityGroups: Sequence[str] = ...,
    MediaConnectFlows: Sequence[MediaConnectFlowRequestTypeDef] = ...,  # (3)
    Name: str = ...,
    RoleArn: str = ...,
    Sources: Sequence[InputSourceRequestTypeDef] = ...,  # (4)
) -> UpdateInputResponseTypeDef:  # (5)
    ...

1. See InputDestinationRequestTypeDef
2. See InputDeviceRequestTypeDef
3. See MediaConnectFlowRequestTypeDef
4. See InputSourceRequestTypeDef
5. See UpdateInputResponseTypeDef

Usage example with kwargs

kwargs: UpdateInputRequestRequestTypeDef = {  # (1)
    "InputId": ...,
}

parent.update_input(**kwargs)

1. See UpdateInputRequestRequestTypeDef

update_input_device

Updates the parameters for the input device.

Type annotations and code completion for boto3.client("medialive").update_input_device method. boto3 documentation

Method definition

def update_input_device(
    self,
    *,
    InputDeviceId: str,
    HdDeviceSettings: InputDeviceConfigurableSettingsTypeDef = ...,  # (1)
    Name: str = ...,
    UhdDeviceSettings: InputDeviceConfigurableSettingsTypeDef = ...,  # (1)
) -> UpdateInputDeviceResponseTypeDef:  # (3)
    ...

1. See InputDeviceConfigurableSettingsTypeDef
2. See InputDeviceConfigurableSettingsTypeDef
3. See UpdateInputDeviceResponseTypeDef

Usage example with kwargs

kwargs: UpdateInputDeviceRequestRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.update_input_device(**kwargs)

1. See UpdateInputDeviceRequestRequestTypeDef

update_input_security_group

Update an Input Security Group's Whilelists.

Type annotations and code completion for boto3.client("medialive").update_input_security_group method. boto3 documentation

Method definition

def update_input_security_group(
    self,
    *,
    InputSecurityGroupId: str,
    Tags: Mapping[str, str] = ...,
    WhitelistRules: Sequence[InputWhitelistRuleCidrTypeDef] = ...,  # (1)
) -> UpdateInputSecurityGroupResponseTypeDef:  # (2)
    ...

1. See InputWhitelistRuleCidrTypeDef
2. See UpdateInputSecurityGroupResponseTypeDef

Usage example with kwargs

kwargs: UpdateInputSecurityGroupRequestRequestTypeDef = {  # (1)
    "InputSecurityGroupId": ...,
}

parent.update_input_security_group(**kwargs)

1. See UpdateInputSecurityGroupRequestRequestTypeDef

update_multiplex

Updates a multiplex.

Type annotations and code completion for boto3.client("medialive").update_multiplex method. boto3 documentation

Method definition

def update_multiplex(
    self,
    *,
    MultiplexId: str,
    MultiplexSettings: MultiplexSettingsTypeDef = ...,  # (1)
    Name: str = ...,
) -> UpdateMultiplexResponseTypeDef:  # (2)
    ...

1. See MultiplexSettingsTypeDef
2. See UpdateMultiplexResponseTypeDef

Usage example with kwargs

kwargs: UpdateMultiplexRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
}

parent.update_multiplex(**kwargs)

1. See UpdateMultiplexRequestRequestTypeDef

update_multiplex_program

Update a program in a multiplex.

Type annotations and code completion for boto3.client("medialive").update_multiplex_program method. boto3 documentation

Method definition

def update_multiplex_program(
    self,
    *,
    MultiplexId: str,
    ProgramName: str,
    MultiplexProgramSettings: MultiplexProgramSettingsTypeDef = ...,  # (1)
) -> UpdateMultiplexProgramResponseTypeDef:  # (2)
    ...

1. See MultiplexProgramSettingsTypeDef
2. See UpdateMultiplexProgramResponseTypeDef

Usage example with kwargs

kwargs: UpdateMultiplexProgramRequestRequestTypeDef = {  # (1)
    "MultiplexId": ...,
    "ProgramName": ...,
}

parent.update_multiplex_program(**kwargs)

1. See UpdateMultiplexProgramRequestRequestTypeDef

update_reservation

Update reservation.

Type annotations and code completion for boto3.client("medialive").update_reservation method. boto3 documentation

Method definition

def update_reservation(
    self,
    *,
    ReservationId: str,
    Name: str = ...,
    RenewalSettings: RenewalSettingsTypeDef = ...,  # (1)
) -> UpdateReservationResponseTypeDef:  # (2)
    ...

1. See RenewalSettingsTypeDef
2. See UpdateReservationResponseTypeDef

Usage example with kwargs

kwargs: UpdateReservationRequestRequestTypeDef = {  # (1)
    "ReservationId": ...,
}

parent.update_reservation(**kwargs)

1. See UpdateReservationRequestRequestTypeDef

get_paginator

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

• client.get_paginator("describe_schedule") -> DescribeSchedulePaginator
• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_input_device_transfers") -> ListInputDeviceTransfersPaginator
• client.get_paginator("list_input_devices") -> ListInputDevicesPaginator
• client.get_paginator("list_input_security_groups") -> ListInputSecurityGroupsPaginator
• client.get_paginator("list_inputs") -> ListInputsPaginator
• client.get_paginator("list_multiplex_programs") -> ListMultiplexProgramsPaginator
• client.get_paginator("list_multiplexes") -> ListMultiplexesPaginator
• client.get_paginator("list_offerings") -> ListOfferingsPaginator
• client.get_paginator("list_reservations") -> ListReservationsPaginator

get_waiter

Type annotations and code completion for boto3.client("medialive").get_waiter method with overloads.

• client.get_waiter("channel_created") -> ChannelCreatedWaiter
• client.get_waiter("channel_deleted") -> ChannelDeletedWaiter
• client.get_waiter("channel_running") -> ChannelRunningWaiter
• client.get_waiter("channel_stopped") -> ChannelStoppedWaiter
• client.get_waiter("input_attached") -> InputAttachedWaiter
• client.get_waiter("input_deleted") -> InputDeletedWaiter
• client.get_waiter("input_detached") -> InputDetachedWaiter
• client.get_waiter("multiplex_created") -> MultiplexCreatedWaiter
• client.get_waiter("multiplex_deleted") -> MultiplexDeletedWaiter
• client.get_waiter("multiplex_running") -> MultiplexRunningWaiter
• client.get_waiter("multiplex_stopped") -> MultiplexStoppedWaiter