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
# MediaLiveClient 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.
# Exceptions.exceptions usage example
client = boto3.client("medialive")
try:
do_something(client)
except (
client.exceptions.BadGatewayException,
client.exceptions.BadRequestException,
client.exceptions.ClientError,
client.exceptions.ConflictException,
client.exceptions.ForbiddenException,
client.exceptions.GatewayTimeoutException,
client.exceptions.InternalServerErrorException,
client.exceptions.NotFoundException,
client.exceptions.TooManyRequestsException,
client.exceptions.UnprocessableEntityException,
) as e:
print(e)
# Exceptions.exceptions 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
# accept_input_device_transfer method definition
def accept_input_device_transfer(
self,
*,
InputDeviceId: str,
) -> Dict[str, Any]:
...
# accept_input_device_transfer method usage example with argument unpacking
kwargs: AcceptInputDeviceTransferRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.accept_input_device_transfer(**kwargs)
batch_delete#
Starts delete of resources.
Type annotations and code completion for boto3.client("medialive").batch_delete
method.
boto3 documentation
# batch_delete method definition
def batch_delete(
self,
*,
ChannelIds: Sequence[str] = ...,
InputIds: Sequence[str] = ...,
InputSecurityGroupIds: Sequence[str] = ...,
MultiplexIds: Sequence[str] = ...,
) -> BatchDeleteResponseTypeDef: # (1)
...
# batch_delete method usage example with argument unpacking
kwargs: BatchDeleteRequestRequestTypeDef = { # (1)
"ChannelIds": ...,
}
parent.batch_delete(**kwargs)
batch_start#
Starts existing resources See also: AWS API Documentation.
Type annotations and code completion for boto3.client("medialive").batch_start
method.
boto3 documentation
# batch_start method definition
def batch_start(
self,
*,
ChannelIds: Sequence[str] = ...,
MultiplexIds: Sequence[str] = ...,
) -> BatchStartResponseTypeDef: # (1)
...
# batch_start method usage example with argument unpacking
kwargs: BatchStartRequestRequestTypeDef = { # (1)
"ChannelIds": ...,
}
parent.batch_start(**kwargs)
batch_stop#
Stops running resources See also: AWS API Documentation.
Type annotations and code completion for boto3.client("medialive").batch_stop
method.
boto3 documentation
# batch_stop method definition
def batch_stop(
self,
*,
ChannelIds: Sequence[str] = ...,
MultiplexIds: Sequence[str] = ...,
) -> BatchStopResponseTypeDef: # (1)
...
# batch_stop method usage example with argument unpacking
kwargs: BatchStopRequestRequestTypeDef = { # (1)
"ChannelIds": ...,
}
parent.batch_stop(**kwargs)
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
# batch_update_schedule method definition
def batch_update_schedule(
self,
*,
ChannelId: str,
Creates: BatchScheduleActionCreateRequestTypeDef = ..., # (1)
Deletes: BatchScheduleActionDeleteRequestTypeDef = ..., # (2)
) -> BatchUpdateScheduleResponseTypeDef: # (3)
...
- See BatchScheduleActionCreateRequestTypeDef
- See BatchScheduleActionDeleteRequestTypeDef
- See BatchUpdateScheduleResponseTypeDef
# batch_update_schedule method usage example with argument unpacking
kwargs: BatchUpdateScheduleRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.batch_update_schedule(**kwargs)
can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("medialive").can_paginate
method.
boto3 documentation
# can_paginate 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
# cancel_input_device_transfer method definition
def cancel_input_device_transfer(
self,
*,
InputDeviceId: str,
) -> Dict[str, Any]:
...
# cancel_input_device_transfer method usage example with argument unpacking
kwargs: CancelInputDeviceTransferRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.cancel_input_device_transfer(**kwargs)
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
# claim_device method definition
def claim_device(
self,
*,
Id: str = ...,
) -> Dict[str, Any]:
...
# claim_device method usage example with argument unpacking
kwargs: ClaimDeviceRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.claim_device(**kwargs)
close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("medialive").close
method.
boto3 documentation
# close 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
# create_channel 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)
...
- See CdiInputSpecificationTypeDef
- See ChannelClassType
- See OutputDestinationTypeDef
- See EncoderSettingsTypeDef
- See InputAttachmentTypeDef
- See InputSpecificationTypeDef
- See LogLevelType
- See MaintenanceCreateSettingsTypeDef
- See VpcOutputSettingsTypeDef
- See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"CdiInputSpecification": ...,
}
parent.create_channel(**kwargs)
create_input#
Create an input See also: AWS API Documentation.
Type annotations and code completion for boto3.client("medialive").create_input
method.
boto3 documentation
# create_input 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)
...
- See InputDestinationRequestTypeDef
- See InputDeviceSettingsTypeDef
- See MediaConnectFlowRequestTypeDef
- See InputSourceRequestTypeDef
- See InputTypeType
- See InputVpcRequestTypeDef
- See CreateInputResponseTypeDef
# create_input method usage example with argument unpacking
kwargs: CreateInputRequestRequestTypeDef = { # (1)
"Destinations": ...,
}
parent.create_input(**kwargs)
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
# create_input_security_group method definition
def create_input_security_group(
self,
*,
Tags: Mapping[str, str] = ...,
WhitelistRules: Sequence[InputWhitelistRuleCidrTypeDef] = ..., # (1)
) -> CreateInputSecurityGroupResponseTypeDef: # (2)
...
# create_input_security_group method usage example with argument unpacking
kwargs: CreateInputSecurityGroupRequestRequestTypeDef = { # (1)
"Tags": ...,
}
parent.create_input_security_group(**kwargs)
create_multiplex#
Create a new multiplex.
Type annotations and code completion for boto3.client("medialive").create_multiplex
method.
boto3 documentation
# create_multiplex method definition
def create_multiplex(
self,
*,
AvailabilityZones: Sequence[str],
MultiplexSettings: MultiplexSettingsTypeDef, # (1)
Name: str,
RequestId: str,
Tags: Mapping[str, str] = ...,
) -> CreateMultiplexResponseTypeDef: # (2)
...
# create_multiplex method usage example with argument unpacking
kwargs: CreateMultiplexRequestRequestTypeDef = { # (1)
"AvailabilityZones": ...,
"MultiplexSettings": ...,
"Name": ...,
"RequestId": ...,
}
parent.create_multiplex(**kwargs)
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
# create_multiplex_program method definition
def create_multiplex_program(
self,
*,
MultiplexId: str,
MultiplexProgramSettings: MultiplexProgramSettingsTypeDef, # (1)
ProgramName: str,
RequestId: str,
) -> CreateMultiplexProgramResponseTypeDef: # (2)
...
# create_multiplex_program method usage example with argument unpacking
kwargs: CreateMultiplexProgramRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
"MultiplexProgramSettings": ...,
"ProgramName": ...,
"RequestId": ...,
}
parent.create_multiplex_program(**kwargs)
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
# create_partner_input method definition
def create_partner_input(
self,
*,
InputId: str,
RequestId: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreatePartnerInputResponseTypeDef: # (1)
...
# create_partner_input method usage example with argument unpacking
kwargs: CreatePartnerInputRequestRequestTypeDef = { # (1)
"InputId": ...,
}
parent.create_partner_input(**kwargs)
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
# create_tags method definition
def create_tags(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...
# create_tags method usage example with argument unpacking
kwargs: CreateTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.create_tags(**kwargs)
delete_channel#
Starts deletion of channel.
Type annotations and code completion for boto3.client("medialive").delete_channel
method.
boto3 documentation
# delete_channel method definition
def delete_channel(
self,
*,
ChannelId: str,
) -> DeleteChannelResponseTypeDef: # (1)
...
# delete_channel method usage example with argument unpacking
kwargs: DeleteChannelRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.delete_channel(**kwargs)
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
# delete_input method definition
def delete_input(
self,
*,
InputId: str,
) -> Dict[str, Any]:
...
# delete_input method usage example with argument unpacking
kwargs: DeleteInputRequestRequestTypeDef = { # (1)
"InputId": ...,
}
parent.delete_input(**kwargs)
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
# delete_input_security_group method definition
def delete_input_security_group(
self,
*,
InputSecurityGroupId: str,
) -> Dict[str, Any]:
...
# delete_input_security_group method usage example with argument unpacking
kwargs: DeleteInputSecurityGroupRequestRequestTypeDef = { # (1)
"InputSecurityGroupId": ...,
}
parent.delete_input_security_group(**kwargs)
delete_multiplex#
Delete a multiplex.
Type annotations and code completion for boto3.client("medialive").delete_multiplex
method.
boto3 documentation
# delete_multiplex method definition
def delete_multiplex(
self,
*,
MultiplexId: str,
) -> DeleteMultiplexResponseTypeDef: # (1)
...
# delete_multiplex method usage example with argument unpacking
kwargs: DeleteMultiplexRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.delete_multiplex(**kwargs)
delete_multiplex_program#
Delete a program from a multiplex.
Type annotations and code completion for boto3.client("medialive").delete_multiplex_program
method.
boto3 documentation
# delete_multiplex_program method definition
def delete_multiplex_program(
self,
*,
MultiplexId: str,
ProgramName: str,
) -> DeleteMultiplexProgramResponseTypeDef: # (1)
...
# delete_multiplex_program method usage example with argument unpacking
kwargs: DeleteMultiplexProgramRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
"ProgramName": ...,
}
parent.delete_multiplex_program(**kwargs)
delete_reservation#
Delete an expired reservation.
Type annotations and code completion for boto3.client("medialive").delete_reservation
method.
boto3 documentation
# delete_reservation method definition
def delete_reservation(
self,
*,
ReservationId: str,
) -> DeleteReservationResponseTypeDef: # (1)
...
# delete_reservation method usage example with argument unpacking
kwargs: DeleteReservationRequestRequestTypeDef = { # (1)
"ReservationId": ...,
}
parent.delete_reservation(**kwargs)
delete_schedule#
Delete all schedule actions on a channel.
Type annotations and code completion for boto3.client("medialive").delete_schedule
method.
boto3 documentation
# delete_schedule method definition
def delete_schedule(
self,
*,
ChannelId: str,
) -> Dict[str, Any]:
...
# delete_schedule method usage example with argument unpacking
kwargs: DeleteScheduleRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.delete_schedule(**kwargs)
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
# delete_tags method definition
def delete_tags(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
# delete_tags method usage example with argument unpacking
kwargs: DeleteTagsRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.delete_tags(**kwargs)
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
# describe_channel method definition
def describe_channel(
self,
*,
ChannelId: str,
) -> DescribeChannelResponseTypeDef: # (1)
...
# describe_channel method usage example with argument unpacking
kwargs: DescribeChannelRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.describe_channel(**kwargs)
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
# describe_input method definition
def describe_input(
self,
*,
InputId: str,
) -> DescribeInputResponseTypeDef: # (1)
...
# describe_input method usage example with argument unpacking
kwargs: DescribeInputRequestRequestTypeDef = { # (1)
"InputId": ...,
}
parent.describe_input(**kwargs)
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
# describe_input_device method definition
def describe_input_device(
self,
*,
InputDeviceId: str,
) -> DescribeInputDeviceResponseTypeDef: # (1)
...
# describe_input_device method usage example with argument unpacking
kwargs: DescribeInputDeviceRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.describe_input_device(**kwargs)
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
# describe_input_device_thumbnail method definition
def describe_input_device_thumbnail(
self,
*,
InputDeviceId: str,
Accept: AcceptHeaderType, # (1)
) -> DescribeInputDeviceThumbnailResponseTypeDef: # (2)
...
# describe_input_device_thumbnail method usage example with argument unpacking
kwargs: DescribeInputDeviceThumbnailRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
"Accept": ...,
}
parent.describe_input_device_thumbnail(**kwargs)
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
# describe_input_security_group method definition
def describe_input_security_group(
self,
*,
InputSecurityGroupId: str,
) -> DescribeInputSecurityGroupResponseTypeDef: # (1)
...
# describe_input_security_group method usage example with argument unpacking
kwargs: DescribeInputSecurityGroupRequestRequestTypeDef = { # (1)
"InputSecurityGroupId": ...,
}
parent.describe_input_security_group(**kwargs)
describe_multiplex#
Gets details about a multiplex.
Type annotations and code completion for boto3.client("medialive").describe_multiplex
method.
boto3 documentation
# describe_multiplex method definition
def describe_multiplex(
self,
*,
MultiplexId: str,
) -> DescribeMultiplexResponseTypeDef: # (1)
...
# describe_multiplex method usage example with argument unpacking
kwargs: DescribeMultiplexRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.describe_multiplex(**kwargs)
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
# describe_multiplex_program method definition
def describe_multiplex_program(
self,
*,
MultiplexId: str,
ProgramName: str,
) -> DescribeMultiplexProgramResponseTypeDef: # (1)
...
# describe_multiplex_program method usage example with argument unpacking
kwargs: DescribeMultiplexProgramRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
"ProgramName": ...,
}
parent.describe_multiplex_program(**kwargs)
describe_offering#
Get details for an offering.
Type annotations and code completion for boto3.client("medialive").describe_offering
method.
boto3 documentation
# describe_offering method definition
def describe_offering(
self,
*,
OfferingId: str,
) -> DescribeOfferingResponseTypeDef: # (1)
...
# describe_offering method usage example with argument unpacking
kwargs: DescribeOfferingRequestRequestTypeDef = { # (1)
"OfferingId": ...,
}
parent.describe_offering(**kwargs)
describe_reservation#
Get details for a reservation.
Type annotations and code completion for boto3.client("medialive").describe_reservation
method.
boto3 documentation
# describe_reservation method definition
def describe_reservation(
self,
*,
ReservationId: str,
) -> DescribeReservationResponseTypeDef: # (1)
...
# describe_reservation method usage example with argument unpacking
kwargs: DescribeReservationRequestRequestTypeDef = { # (1)
"ReservationId": ...,
}
parent.describe_reservation(**kwargs)
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
# describe_schedule method definition
def describe_schedule(
self,
*,
ChannelId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> DescribeScheduleResponseTypeDef: # (1)
...
# describe_schedule method usage example with argument unpacking
kwargs: DescribeScheduleRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.describe_schedule(**kwargs)
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
# generate_presigned_url 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
# list_channels method definition
def list_channels(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListChannelsResponseTypeDef: # (1)
...
# list_channels method usage example with argument unpacking
kwargs: ListChannelsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_channels(**kwargs)
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
# list_input_device_transfers method definition
def list_input_device_transfers(
self,
*,
TransferType: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInputDeviceTransfersResponseTypeDef: # (1)
...
# list_input_device_transfers method usage example with argument unpacking
kwargs: ListInputDeviceTransfersRequestRequestTypeDef = { # (1)
"TransferType": ...,
}
parent.list_input_device_transfers(**kwargs)
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
# list_input_devices method definition
def list_input_devices(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInputDevicesResponseTypeDef: # (1)
...
# list_input_devices method usage example with argument unpacking
kwargs: ListInputDevicesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_input_devices(**kwargs)
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
# list_input_security_groups method definition
def list_input_security_groups(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInputSecurityGroupsResponseTypeDef: # (1)
...
# list_input_security_groups method usage example with argument unpacking
kwargs: ListInputSecurityGroupsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_input_security_groups(**kwargs)
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
# list_inputs method definition
def list_inputs(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListInputsResponseTypeDef: # (1)
...
# list_inputs method usage example with argument unpacking
kwargs: ListInputsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_inputs(**kwargs)
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
# list_multiplex_programs method definition
def list_multiplex_programs(
self,
*,
MultiplexId: str,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMultiplexProgramsResponseTypeDef: # (1)
...
# list_multiplex_programs method usage example with argument unpacking
kwargs: ListMultiplexProgramsRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.list_multiplex_programs(**kwargs)
list_multiplexes#
Retrieve a list of the existing multiplexes.
Type annotations and code completion for boto3.client("medialive").list_multiplexes
method.
boto3 documentation
# list_multiplexes method definition
def list_multiplexes(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListMultiplexesResponseTypeDef: # (1)
...
# list_multiplexes method usage example with argument unpacking
kwargs: ListMultiplexesRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_multiplexes(**kwargs)
list_offerings#
List offerings available for purchase.
Type annotations and code completion for boto3.client("medialive").list_offerings
method.
boto3 documentation
# list_offerings 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)
...
# list_offerings method usage example with argument unpacking
kwargs: ListOfferingsRequestRequestTypeDef = { # (1)
"ChannelClass": ...,
}
parent.list_offerings(**kwargs)
list_reservations#
List purchased reservations.
Type annotations and code completion for boto3.client("medialive").list_reservations
method.
boto3 documentation
# list_reservations 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)
...
# list_reservations method usage example with argument unpacking
kwargs: ListReservationsRequestRequestTypeDef = { # (1)
"ChannelClass": ...,
}
parent.list_reservations(**kwargs)
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
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
purchase_offering#
Purchase an offering and create a reservation.
Type annotations and code completion for boto3.client("medialive").purchase_offering
method.
boto3 documentation
# purchase_offering 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)
...
# purchase_offering method usage example with argument unpacking
kwargs: PurchaseOfferingRequestRequestTypeDef = { # (1)
"Count": ...,
"OfferingId": ...,
}
parent.purchase_offering(**kwargs)
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
# reboot_input_device method definition
def reboot_input_device(
self,
*,
InputDeviceId: str,
Force: RebootInputDeviceForceType = ..., # (1)
) -> Dict[str, Any]:
...
# reboot_input_device method usage example with argument unpacking
kwargs: RebootInputDeviceRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.reboot_input_device(**kwargs)
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
# reject_input_device_transfer method definition
def reject_input_device_transfer(
self,
*,
InputDeviceId: str,
) -> Dict[str, Any]:
...
# reject_input_device_transfer method usage example with argument unpacking
kwargs: RejectInputDeviceTransferRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.reject_input_device_transfer(**kwargs)
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
# start_channel method definition
def start_channel(
self,
*,
ChannelId: str,
) -> StartChannelResponseTypeDef: # (1)
...
# start_channel method usage example with argument unpacking
kwargs: StartChannelRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.start_channel(**kwargs)
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
# start_input_device_maintenance_window method definition
def start_input_device_maintenance_window(
self,
*,
InputDeviceId: str,
) -> Dict[str, Any]:
...
# start_input_device_maintenance_window method usage example with argument unpacking
kwargs: StartInputDeviceMaintenanceWindowRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.start_input_device_maintenance_window(**kwargs)
start_multiplex#
Start (run) the multiplex.
Type annotations and code completion for boto3.client("medialive").start_multiplex
method.
boto3 documentation
# start_multiplex method definition
def start_multiplex(
self,
*,
MultiplexId: str,
) -> StartMultiplexResponseTypeDef: # (1)
...
# start_multiplex method usage example with argument unpacking
kwargs: StartMultiplexRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.start_multiplex(**kwargs)
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
# stop_channel method definition
def stop_channel(
self,
*,
ChannelId: str,
) -> StopChannelResponseTypeDef: # (1)
...
# stop_channel method usage example with argument unpacking
kwargs: StopChannelRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.stop_channel(**kwargs)
stop_multiplex#
Stops a running multiplex.
Type annotations and code completion for boto3.client("medialive").stop_multiplex
method.
boto3 documentation
# stop_multiplex method definition
def stop_multiplex(
self,
*,
MultiplexId: str,
) -> StopMultiplexResponseTypeDef: # (1)
...
# stop_multiplex method usage example with argument unpacking
kwargs: StopMultiplexRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.stop_multiplex(**kwargs)
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
# transfer_input_device method definition
def transfer_input_device(
self,
*,
InputDeviceId: str,
TargetCustomerId: str = ...,
TargetRegion: str = ...,
TransferMessage: str = ...,
) -> Dict[str, Any]:
...
# transfer_input_device method usage example with argument unpacking
kwargs: TransferInputDeviceRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.transfer_input_device(**kwargs)
update_channel#
Updates a channel.
Type annotations and code completion for boto3.client("medialive").update_channel
method.
boto3 documentation
# update_channel 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)
...
- See CdiInputSpecificationTypeDef
- See OutputDestinationTypeDef
- See EncoderSettingsTypeDef
- See InputAttachmentTypeDef
- See InputSpecificationTypeDef
- See LogLevelType
- See MaintenanceUpdateSettingsTypeDef
- See UpdateChannelResponseTypeDef
# update_channel method usage example with argument unpacking
kwargs: UpdateChannelRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.update_channel(**kwargs)
update_channel_class#
Changes the class of the channel.
Type annotations and code completion for boto3.client("medialive").update_channel_class
method.
boto3 documentation
# update_channel_class method definition
def update_channel_class(
self,
*,
ChannelClass: ChannelClassType, # (1)
ChannelId: str,
Destinations: Sequence[OutputDestinationTypeDef] = ..., # (2)
) -> UpdateChannelClassResponseTypeDef: # (3)
...
# update_channel_class method usage example with argument unpacking
kwargs: UpdateChannelClassRequestRequestTypeDef = { # (1)
"ChannelClass": ...,
"ChannelId": ...,
}
parent.update_channel_class(**kwargs)
update_input#
Updates an input.
Type annotations and code completion for boto3.client("medialive").update_input
method.
boto3 documentation
# update_input 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)
...
- See InputDestinationRequestTypeDef
- See InputDeviceRequestTypeDef
- See MediaConnectFlowRequestTypeDef
- See InputSourceRequestTypeDef
- See UpdateInputResponseTypeDef
# update_input method usage example with argument unpacking
kwargs: UpdateInputRequestRequestTypeDef = { # (1)
"InputId": ...,
}
parent.update_input(**kwargs)
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
# update_input_device method definition
def update_input_device(
self,
*,
InputDeviceId: str,
HdDeviceSettings: InputDeviceConfigurableSettingsTypeDef = ..., # (1)
Name: str = ...,
UhdDeviceSettings: InputDeviceConfigurableSettingsTypeDef = ..., # (1)
) -> UpdateInputDeviceResponseTypeDef: # (3)
...
- See InputDeviceConfigurableSettingsTypeDef
- See InputDeviceConfigurableSettingsTypeDef
- See UpdateInputDeviceResponseTypeDef
# update_input_device method usage example with argument unpacking
kwargs: UpdateInputDeviceRequestRequestTypeDef = { # (1)
"InputDeviceId": ...,
}
parent.update_input_device(**kwargs)
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
# update_input_security_group method definition
def update_input_security_group(
self,
*,
InputSecurityGroupId: str,
Tags: Mapping[str, str] = ...,
WhitelistRules: Sequence[InputWhitelistRuleCidrTypeDef] = ..., # (1)
) -> UpdateInputSecurityGroupResponseTypeDef: # (2)
...
# update_input_security_group method usage example with argument unpacking
kwargs: UpdateInputSecurityGroupRequestRequestTypeDef = { # (1)
"InputSecurityGroupId": ...,
}
parent.update_input_security_group(**kwargs)
update_multiplex#
Updates a multiplex.
Type annotations and code completion for boto3.client("medialive").update_multiplex
method.
boto3 documentation
# update_multiplex method definition
def update_multiplex(
self,
*,
MultiplexId: str,
MultiplexSettings: MultiplexSettingsTypeDef = ..., # (1)
Name: str = ...,
) -> UpdateMultiplexResponseTypeDef: # (2)
...
# update_multiplex method usage example with argument unpacking
kwargs: UpdateMultiplexRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
}
parent.update_multiplex(**kwargs)
update_multiplex_program#
Update a program in a multiplex.
Type annotations and code completion for boto3.client("medialive").update_multiplex_program
method.
boto3 documentation
# update_multiplex_program method definition
def update_multiplex_program(
self,
*,
MultiplexId: str,
ProgramName: str,
MultiplexProgramSettings: MultiplexProgramSettingsTypeDef = ..., # (1)
) -> UpdateMultiplexProgramResponseTypeDef: # (2)
...
# update_multiplex_program method usage example with argument unpacking
kwargs: UpdateMultiplexProgramRequestRequestTypeDef = { # (1)
"MultiplexId": ...,
"ProgramName": ...,
}
parent.update_multiplex_program(**kwargs)
update_reservation#
Update reservation.
Type annotations and code completion for boto3.client("medialive").update_reservation
method.
boto3 documentation
# update_reservation method definition
def update_reservation(
self,
*,
ReservationId: str,
Name: str = ...,
RenewalSettings: RenewalSettingsTypeDef = ..., # (1)
) -> UpdateReservationResponseTypeDef: # (2)
...
# update_reservation method usage example with argument unpacking
kwargs: UpdateReservationRequestRequestTypeDef = { # (1)
"ReservationId": ...,
}
parent.update_reservation(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("medialive").get_paginator
method with overloads.
client.get_paginator("describe_schedule")
-> DescribeSchedulePaginatorclient.get_paginator("list_channels")
-> ListChannelsPaginatorclient.get_paginator("list_input_device_transfers")
-> ListInputDeviceTransfersPaginatorclient.get_paginator("list_input_devices")
-> ListInputDevicesPaginatorclient.get_paginator("list_input_security_groups")
-> ListInputSecurityGroupsPaginatorclient.get_paginator("list_inputs")
-> ListInputsPaginatorclient.get_paginator("list_multiplex_programs")
-> ListMultiplexProgramsPaginatorclient.get_paginator("list_multiplexes")
-> ListMultiplexesPaginatorclient.get_paginator("list_offerings")
-> ListOfferingsPaginatorclient.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")
-> ChannelCreatedWaiterclient.get_waiter("channel_deleted")
-> ChannelDeletedWaiterclient.get_waiter("channel_running")
-> ChannelRunningWaiterclient.get_waiter("channel_stopped")
-> ChannelStoppedWaiterclient.get_waiter("input_attached")
-> InputAttachedWaiterclient.get_waiter("input_deleted")
-> InputDeletedWaiterclient.get_waiter("input_detached")
-> InputDetachedWaiterclient.get_waiter("multiplex_created")
-> MultiplexCreatedWaiterclient.get_waiter("multiplex_deleted")
-> MultiplexDeletedWaiterclient.get_waiter("multiplex_running")
-> MultiplexRunningWaiterclient.get_waiter("multiplex_stopped")
-> MultiplexStoppedWaiter