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_account_configuration#
Get account configuration See also: AWS API Documentation.
Type annotations and code completion for boto3.client("medialive").describe_account_configuration
method.
boto3 documentation
# describe_account_configuration method definition
def describe_account_configuration(
self,
) -> DescribeAccountConfigurationResponseTypeDef: # (1)
...
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.