Skip to content

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

# 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#

can_paginate#

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:
    ...

generate_presigned_url#

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:
    ...

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: AcceptInputDeviceTransferRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.accept_input_device_transfer(**kwargs)
  1. See AcceptInputDeviceTransferRequestTypeDef

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)
    ...
  1. See BatchDeleteResponseTypeDef
# batch_delete method usage example with argument unpacking

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

parent.batch_delete(**kwargs)
  1. See BatchDeleteRequestTypeDef

batch_start#

Starts existing resources.

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)
    ...
  1. See BatchStartResponseTypeDef
# batch_start method usage example with argument unpacking

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

parent.batch_start(**kwargs)
  1. See BatchStartRequestTypeDef

batch_stop#

Stops running resources.

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)
    ...
  1. See BatchStopResponseTypeDef
# batch_stop method usage example with argument unpacking

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

parent.batch_stop(**kwargs)
  1. See BatchStopRequestTypeDef

batch_update_schedule#

Update a channel schedule.

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)
    ...
  1. See BatchScheduleActionCreateRequestTypeDef
  2. See BatchScheduleActionDeleteRequestTypeDef
  3. See BatchUpdateScheduleResponseTypeDef
# batch_update_schedule method usage example with argument unpacking

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

parent.batch_update_schedule(**kwargs)
  1. See BatchUpdateScheduleRequestTypeDef

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: CancelInputDeviceTransferRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.cancel_input_device_transfer(**kwargs)
  1. See CancelInputDeviceTransferRequestTypeDef

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: ClaimDeviceRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.claim_device(**kwargs)
  1. See ClaimDeviceRequestTypeDef

create_channel#

Creates a new channel.

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[OutputDestinationUnionTypeDef] = ...,  # (3)
    EncoderSettings: EncoderSettingsUnionTypeDef = ...,  # (4)
    InputAttachments: Sequence[InputAttachmentUnionTypeDef] = ...,  # (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)
    AnywhereSettings: AnywhereSettingsTypeDef = ...,  # (10)
    ChannelEngineVersion: ChannelEngineVersionRequestTypeDef = ...,  # (11)
    DryRun: bool = ...,
) -> CreateChannelResponseTypeDef:  # (12)
    ...
  1. See CdiInputSpecificationTypeDef
  2. See ChannelClassType
  3. See Sequence[OutputDestinationUnionTypeDef]
  4. See EncoderSettingsUnionTypeDef
  5. See Sequence[InputAttachmentUnionTypeDef]
  6. See InputSpecificationTypeDef
  7. See LogLevelType
  8. See MaintenanceCreateSettingsTypeDef
  9. See VpcOutputSettingsTypeDef
  10. See AnywhereSettingsTypeDef
  11. See ChannelEngineVersionRequestTypeDef
  12. See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking

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

parent.create_channel(**kwargs)
  1. See CreateChannelRequestTypeDef

create_input#

Create an input.

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)
    SrtSettings: SrtSettingsRequestTypeDef = ...,  # (7)
    InputNetworkLocation: InputNetworkLocationType = ...,  # (8)
    MulticastSettings: MulticastSettingsCreateRequestTypeDef = ...,  # (9)
) -> CreateInputResponseTypeDef:  # (10)
    ...
  1. See Sequence[InputDestinationRequestTypeDef]
  2. See Sequence[InputDeviceSettingsTypeDef]
  3. See Sequence[MediaConnectFlowRequestTypeDef]
  4. See Sequence[InputSourceRequestTypeDef]
  5. See InputTypeType
  6. See InputVpcRequestTypeDef
  7. See SrtSettingsRequestTypeDef
  8. See InputNetworkLocationType
  9. See MulticastSettingsCreateRequestTypeDef
  10. See CreateInputResponseTypeDef
# create_input method usage example with argument unpacking

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

parent.create_input(**kwargs)
  1. See CreateInputRequestTypeDef

create_input_security_group#

Creates a Input Security Group.

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)
    ...
  1. See Sequence[InputWhitelistRuleCidrTypeDef]
  2. See CreateInputSecurityGroupResponseTypeDef
# create_input_security_group method usage example with argument unpacking

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

parent.create_input_security_group(**kwargs)
  1. See CreateInputSecurityGroupRequestTypeDef

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)
    ...
  1. See MultiplexSettingsTypeDef
  2. See CreateMultiplexResponseTypeDef
# create_multiplex method usage example with argument unpacking

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

parent.create_multiplex(**kwargs)
  1. See CreateMultiplexRequestTypeDef

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)
    ...
  1. See MultiplexProgramSettingsTypeDef
  2. See CreateMultiplexProgramResponseTypeDef
# create_multiplex_program method usage example with argument unpacking

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

parent.create_multiplex_program(**kwargs)
  1. See CreateMultiplexProgramRequestTypeDef

create_partner_input#

Create a partner input.

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)
    ...
  1. See CreatePartnerInputResponseTypeDef
# create_partner_input method usage example with argument unpacking

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

parent.create_partner_input(**kwargs)
  1. See CreatePartnerInputRequestTypeDef

create_tags#

Create tags for a resource.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# create_tags method usage example with argument unpacking

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

parent.create_tags(**kwargs)
  1. See CreateTagsRequestTypeDef

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)
    ...
  1. See DeleteChannelResponseTypeDef
# delete_channel method usage example with argument unpacking

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

parent.delete_channel(**kwargs)
  1. See DeleteChannelRequestTypeDef

delete_input#

Deletes the input end point.

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: DeleteInputRequestTypeDef = {  # (1)
    "InputId": ...,
}

parent.delete_input(**kwargs)
  1. See DeleteInputRequestTypeDef

delete_input_security_group#

Deletes an Input Security Group.

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: DeleteInputSecurityGroupRequestTypeDef = {  # (1)
    "InputSecurityGroupId": ...,
}

parent.delete_input_security_group(**kwargs)
  1. See DeleteInputSecurityGroupRequestTypeDef

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)
    ...
  1. See DeleteMultiplexResponseTypeDef
# delete_multiplex method usage example with argument unpacking

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

parent.delete_multiplex(**kwargs)
  1. See DeleteMultiplexRequestTypeDef

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)
    ...
  1. See DeleteMultiplexProgramResponseTypeDef
# delete_multiplex_program method usage example with argument unpacking

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

parent.delete_multiplex_program(**kwargs)
  1. See DeleteMultiplexProgramRequestTypeDef

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)
    ...
  1. See DeleteReservationResponseTypeDef
# delete_reservation method usage example with argument unpacking

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

parent.delete_reservation(**kwargs)
  1. See DeleteReservationRequestTypeDef

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: DeleteScheduleRequestTypeDef = {  # (1)
    "ChannelId": ...,
}

parent.delete_schedule(**kwargs)
  1. See DeleteScheduleRequestTypeDef

delete_tags#

Removes tags for a resource.

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)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_tags method usage example with argument unpacking

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

parent.delete_tags(**kwargs)
  1. See DeleteTagsRequestTypeDef

describe_account_configuration#

Describe account configuration.

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)
    ...
  1. See DescribeAccountConfigurationResponseTypeDef

describe_channel#

Gets details about a channel.

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)
    ...
  1. See DescribeChannelResponseTypeDef
# describe_channel method usage example with argument unpacking

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

parent.describe_channel(**kwargs)
  1. See DescribeChannelRequestTypeDef

describe_input#

Produces details about an input.

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)
    ...
  1. See DescribeInputResponseTypeDef
# describe_input method usage example with argument unpacking

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

parent.describe_input(**kwargs)
  1. See DescribeInputRequestTypeDef

describe_input_device#

Gets the details for the input device.

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)
    ...
  1. See DescribeInputDeviceResponseTypeDef
# describe_input_device method usage example with argument unpacking

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

parent.describe_input_device(**kwargs)
  1. See DescribeInputDeviceRequestTypeDef

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)
    ...
  1. See AcceptHeaderType
  2. See DescribeInputDeviceThumbnailResponseTypeDef
# describe_input_device_thumbnail method usage example with argument unpacking

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

parent.describe_input_device_thumbnail(**kwargs)
  1. See DescribeInputDeviceThumbnailRequestTypeDef

describe_input_security_group#

Produces a summary of an Input Security Group.

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)
    ...
  1. See DescribeInputSecurityGroupResponseTypeDef
# describe_input_security_group method usage example with argument unpacking

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

parent.describe_input_security_group(**kwargs)
  1. See DescribeInputSecurityGroupRequestTypeDef

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)
    ...
  1. See DescribeMultiplexResponseTypeDef
# describe_multiplex method usage example with argument unpacking

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

parent.describe_multiplex(**kwargs)
  1. See DescribeMultiplexRequestTypeDef

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)
    ...
  1. See DescribeMultiplexProgramResponseTypeDef
# describe_multiplex_program method usage example with argument unpacking

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

parent.describe_multiplex_program(**kwargs)
  1. See DescribeMultiplexProgramRequestTypeDef

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)
    ...
  1. See DescribeOfferingResponseTypeDef
# describe_offering method usage example with argument unpacking

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

parent.describe_offering(**kwargs)
  1. See DescribeOfferingRequestTypeDef

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)
    ...
  1. See DescribeReservationResponseTypeDef
# describe_reservation method usage example with argument unpacking

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

parent.describe_reservation(**kwargs)
  1. See DescribeReservationRequestTypeDef

describe_schedule#

Get a channel schedule.

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)
    ...
  1. See DescribeScheduleResponseTypeDef
# describe_schedule method usage example with argument unpacking

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

parent.describe_schedule(**kwargs)
  1. See DescribeScheduleRequestTypeDef

describe_thumbnails#

Describe the latest thumbnails data.

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

# describe_thumbnails method definition

def describe_thumbnails(
    self,
    *,
    ChannelId: str,
    PipelineId: str,
    ThumbnailType: str,
) -> DescribeThumbnailsResponseTypeDef:  # (1)
    ...
  1. See DescribeThumbnailsResponseTypeDef
# describe_thumbnails method usage example with argument unpacking

kwargs: DescribeThumbnailsRequestTypeDef = {  # (1)
    "ChannelId": ...,
    "PipelineId": ...,
    "ThumbnailType": ...,
}

parent.describe_thumbnails(**kwargs)
  1. See DescribeThumbnailsRequestTypeDef

list_channels#

Produces list of channels that have been created.

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)
    ...
  1. See ListChannelsResponseTypeDef
# list_channels method usage example with argument unpacking

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

parent.list_channels(**kwargs)
  1. See ListChannelsRequestTypeDef

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)
    ...
  1. See ListInputDeviceTransfersResponseTypeDef
# list_input_device_transfers method usage example with argument unpacking

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

parent.list_input_device_transfers(**kwargs)
  1. See ListInputDeviceTransfersRequestTypeDef

list_input_devices#

List input devices.

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)
    ...
  1. See ListInputDevicesResponseTypeDef
# list_input_devices method usage example with argument unpacking

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

parent.list_input_devices(**kwargs)
  1. See ListInputDevicesRequestTypeDef

list_input_security_groups#

Produces a list of Input Security Groups for an account.

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)
    ...
  1. See ListInputSecurityGroupsResponseTypeDef
# list_input_security_groups method usage example with argument unpacking

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

parent.list_input_security_groups(**kwargs)
  1. See ListInputSecurityGroupsRequestTypeDef

list_inputs#

Produces list of inputs that have been created.

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)
    ...
  1. See ListInputsResponseTypeDef
# list_inputs method usage example with argument unpacking

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

parent.list_inputs(**kwargs)
  1. See ListInputsRequestTypeDef

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)
    ...
  1. See ListMultiplexProgramsResponseTypeDef
# list_multiplex_programs method usage example with argument unpacking

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

parent.list_multiplex_programs(**kwargs)
  1. See ListMultiplexProgramsRequestTypeDef

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)
    ...
  1. See ListMultiplexesResponseTypeDef
# list_multiplexes method usage example with argument unpacking

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

parent.list_multiplexes(**kwargs)
  1. See ListMultiplexesRequestTypeDef

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)
    ...
  1. See ListOfferingsResponseTypeDef
# list_offerings method usage example with argument unpacking

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

parent.list_offerings(**kwargs)
  1. See ListOfferingsRequestTypeDef

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)
    ...
  1. See ListReservationsResponseTypeDef
# list_reservations method usage example with argument unpacking

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

parent.list_reservations(**kwargs)
  1. See ListReservationsRequestTypeDef

list_tags_for_resource#

Produces list of tags that have been created for a resource.

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)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

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

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

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)
    ...
  1. See RenewalSettingsTypeDef
  2. See PurchaseOfferingResponseTypeDef
# purchase_offering method usage example with argument unpacking

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

parent.purchase_offering(**kwargs)
  1. See PurchaseOfferingRequestTypeDef

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]:
    ...
  1. See RebootInputDeviceForceType
# reboot_input_device method usage example with argument unpacking

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

parent.reboot_input_device(**kwargs)
  1. See RebootInputDeviceRequestTypeDef

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: RejectInputDeviceTransferRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.reject_input_device_transfer(**kwargs)
  1. See RejectInputDeviceTransferRequestTypeDef

start_channel#

Starts an existing channel.

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)
    ...
  1. See StartChannelResponseTypeDef
# start_channel method usage example with argument unpacking

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

parent.start_channel(**kwargs)
  1. See StartChannelRequestTypeDef

start_input_device#

Start an input device that is attached to a MediaConnect flow.

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

# start_input_device method definition

def start_input_device(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...
# start_input_device method usage example with argument unpacking

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

parent.start_input_device(**kwargs)
  1. See StartInputDeviceRequestTypeDef

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: StartInputDeviceMaintenanceWindowRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.start_input_device_maintenance_window(**kwargs)
  1. See StartInputDeviceMaintenanceWindowRequestTypeDef

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)
    ...
  1. See StartMultiplexResponseTypeDef
# start_multiplex method usage example with argument unpacking

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

parent.start_multiplex(**kwargs)
  1. See StartMultiplexRequestTypeDef

stop_channel#

Stops a running channel.

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)
    ...
  1. See StopChannelResponseTypeDef
# stop_channel method usage example with argument unpacking

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

parent.stop_channel(**kwargs)
  1. See StopChannelRequestTypeDef

stop_input_device#

Stop an input device that is attached to a MediaConnect flow.

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

# stop_input_device method definition

def stop_input_device(
    self,
    *,
    InputDeviceId: str,
) -> Dict[str, Any]:
    ...
# stop_input_device method usage example with argument unpacking

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

parent.stop_input_device(**kwargs)
  1. See StopInputDeviceRequestTypeDef

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)
    ...
  1. See StopMultiplexResponseTypeDef
# stop_multiplex method usage example with argument unpacking

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

parent.stop_multiplex(**kwargs)
  1. See StopMultiplexRequestTypeDef

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: TransferInputDeviceRequestTypeDef = {  # (1)
    "InputDeviceId": ...,
}

parent.transfer_input_device(**kwargs)
  1. See TransferInputDeviceRequestTypeDef

update_account_configuration#

Update account configuration.

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

# update_account_configuration method definition

def update_account_configuration(
    self,
    *,
    AccountConfiguration: AccountConfigurationTypeDef = ...,  # (1)
) -> UpdateAccountConfigurationResponseTypeDef:  # (2)
    ...
  1. See AccountConfigurationTypeDef
  2. See UpdateAccountConfigurationResponseTypeDef
# update_account_configuration method usage example with argument unpacking

kwargs: UpdateAccountConfigurationRequestTypeDef = {  # (1)
    "AccountConfiguration": ...,
}

parent.update_account_configuration(**kwargs)
  1. See UpdateAccountConfigurationRequestTypeDef

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[OutputDestinationUnionTypeDef] = ...,  # (2)
    EncoderSettings: EncoderSettingsUnionTypeDef = ...,  # (3)
    InputAttachments: Sequence[InputAttachmentUnionTypeDef] = ...,  # (4)
    InputSpecification: InputSpecificationTypeDef = ...,  # (5)
    LogLevel: LogLevelType = ...,  # (6)
    Maintenance: MaintenanceUpdateSettingsTypeDef = ...,  # (7)
    Name: str = ...,
    RoleArn: str = ...,
    ChannelEngineVersion: ChannelEngineVersionRequestTypeDef = ...,  # (8)
    DryRun: bool = ...,
) -> UpdateChannelResponseTypeDef:  # (9)
    ...
  1. See CdiInputSpecificationTypeDef
  2. See Sequence[OutputDestinationUnionTypeDef]
  3. See EncoderSettingsUnionTypeDef
  4. See Sequence[InputAttachmentUnionTypeDef]
  5. See InputSpecificationTypeDef
  6. See LogLevelType
  7. See MaintenanceUpdateSettingsTypeDef
  8. See ChannelEngineVersionRequestTypeDef
  9. See UpdateChannelResponseTypeDef
# update_channel method usage example with argument unpacking

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

parent.update_channel(**kwargs)
  1. See UpdateChannelRequestTypeDef

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[OutputDestinationUnionTypeDef] = ...,  # (2)
) -> UpdateChannelClassResponseTypeDef:  # (3)
    ...
  1. See ChannelClassType
  2. See Sequence[OutputDestinationUnionTypeDef]
  3. See UpdateChannelClassResponseTypeDef
# update_channel_class method usage example with argument unpacking

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

parent.update_channel_class(**kwargs)
  1. See UpdateChannelClassRequestTypeDef

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)
    SrtSettings: SrtSettingsRequestTypeDef = ...,  # (5)
    MulticastSettings: MulticastSettingsUpdateRequestTypeDef = ...,  # (6)
) -> UpdateInputResponseTypeDef:  # (7)
    ...
  1. See Sequence[InputDestinationRequestTypeDef]
  2. See Sequence[InputDeviceRequestTypeDef]
  3. See Sequence[MediaConnectFlowRequestTypeDef]
  4. See Sequence[InputSourceRequestTypeDef]
  5. See SrtSettingsRequestTypeDef
  6. See MulticastSettingsUpdateRequestTypeDef
  7. See UpdateInputResponseTypeDef
# update_input method usage example with argument unpacking

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

parent.update_input(**kwargs)
  1. See UpdateInputRequestTypeDef

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)
    AvailabilityZone: str = ...,
) -> UpdateInputDeviceResponseTypeDef:  # (3)
    ...
  1. See InputDeviceConfigurableSettingsTypeDef
  2. See InputDeviceConfigurableSettingsTypeDef
  3. See UpdateInputDeviceResponseTypeDef
# update_input_device method usage example with argument unpacking

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

parent.update_input_device(**kwargs)
  1. See UpdateInputDeviceRequestTypeDef

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)
    ...
  1. See Sequence[InputWhitelistRuleCidrTypeDef]
  2. See UpdateInputSecurityGroupResponseTypeDef
# update_input_security_group method usage example with argument unpacking

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

parent.update_input_security_group(**kwargs)
  1. See UpdateInputSecurityGroupRequestTypeDef

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 = ...,
    PacketIdentifiersMapping: Mapping[str, MultiplexProgramPacketIdentifiersMapUnionTypeDef] = ...,  # (2)
) -> UpdateMultiplexResponseTypeDef:  # (3)
    ...
  1. See MultiplexSettingsTypeDef
  2. See Mapping[str, MultiplexProgramPacketIdentifiersMapUnionTypeDef]
  3. See UpdateMultiplexResponseTypeDef
# update_multiplex method usage example with argument unpacking

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

parent.update_multiplex(**kwargs)
  1. See UpdateMultiplexRequestTypeDef

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)
    ...
  1. See MultiplexProgramSettingsTypeDef
  2. See UpdateMultiplexProgramResponseTypeDef
# update_multiplex_program method usage example with argument unpacking

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

parent.update_multiplex_program(**kwargs)
  1. See UpdateMultiplexProgramRequestTypeDef

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)
    ...
  1. See RenewalSettingsTypeDef
  2. See UpdateReservationResponseTypeDef
# update_reservation method usage example with argument unpacking

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

parent.update_reservation(**kwargs)
  1. See UpdateReservationRequestTypeDef

restart_channel_pipelines#

Restart pipelines in one channel that is currently running.

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

# restart_channel_pipelines method definition

def restart_channel_pipelines(
    self,
    *,
    ChannelId: str,
    PipelineIds: Sequence[ChannelPipelineIdToRestartType] = ...,  # (1)
) -> RestartChannelPipelinesResponseTypeDef:  # (2)
    ...
  1. See Sequence[ChannelPipelineIdToRestartType]
  2. See RestartChannelPipelinesResponseTypeDef
# restart_channel_pipelines method usage example with argument unpacking

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

parent.restart_channel_pipelines(**kwargs)
  1. See RestartChannelPipelinesRequestTypeDef

create_cloud_watch_alarm_template#

Creates a cloudwatch alarm template to dynamically generate cloudwatch metric alarms on targeted resource types.

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

# create_cloud_watch_alarm_template method definition

def create_cloud_watch_alarm_template(
    self,
    *,
    ComparisonOperator: CloudWatchAlarmTemplateComparisonOperatorType,  # (1)
    EvaluationPeriods: int,
    GroupIdentifier: str,
    MetricName: str,
    Name: str,
    Period: int,
    Statistic: CloudWatchAlarmTemplateStatisticType,  # (2)
    TargetResourceType: CloudWatchAlarmTemplateTargetResourceTypeType,  # (3)
    Threshold: float,
    TreatMissingData: CloudWatchAlarmTemplateTreatMissingDataType,  # (4)
    DatapointsToAlarm: int = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    RequestId: str = ...,
) -> CreateCloudWatchAlarmTemplateResponseTypeDef:  # (5)
    ...
  1. See CloudWatchAlarmTemplateComparisonOperatorType
  2. See CloudWatchAlarmTemplateStatisticType
  3. See CloudWatchAlarmTemplateTargetResourceTypeType
  4. See CloudWatchAlarmTemplateTreatMissingDataType
  5. See CreateCloudWatchAlarmTemplateResponseTypeDef
# create_cloud_watch_alarm_template method usage example with argument unpacking

kwargs: CreateCloudWatchAlarmTemplateRequestTypeDef = {  # (1)
    "ComparisonOperator": ...,
    "EvaluationPeriods": ...,
    "GroupIdentifier": ...,
    "MetricName": ...,
    "Name": ...,
    "Period": ...,
    "Statistic": ...,
    "TargetResourceType": ...,
    "Threshold": ...,
    "TreatMissingData": ...,
}

parent.create_cloud_watch_alarm_template(**kwargs)
  1. See CreateCloudWatchAlarmTemplateRequestTypeDef

create_cloud_watch_alarm_template_group#

Creates a cloudwatch alarm template group to group your cloudwatch alarm templates and to attach to signal maps for dynamically creating alarms.

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

# create_cloud_watch_alarm_template_group method definition

def create_cloud_watch_alarm_template_group(
    self,
    *,
    Name: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    RequestId: str = ...,
) -> CreateCloudWatchAlarmTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateCloudWatchAlarmTemplateGroupResponseTypeDef
# create_cloud_watch_alarm_template_group method usage example with argument unpacking

kwargs: CreateCloudWatchAlarmTemplateGroupRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_cloud_watch_alarm_template_group(**kwargs)
  1. See CreateCloudWatchAlarmTemplateGroupRequestTypeDef

create_event_bridge_rule_template#

Creates an eventbridge rule template to monitor events and send notifications to your targeted resources.

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

# create_event_bridge_rule_template method definition

def create_event_bridge_rule_template(
    self,
    *,
    EventType: EventBridgeRuleTemplateEventTypeType,  # (1)
    GroupIdentifier: str,
    Name: str,
    Description: str = ...,
    EventTargets: Sequence[EventBridgeRuleTemplateTargetTypeDef] = ...,  # (2)
    Tags: Mapping[str, str] = ...,
    RequestId: str = ...,
) -> CreateEventBridgeRuleTemplateResponseTypeDef:  # (3)
    ...
  1. See EventBridgeRuleTemplateEventTypeType
  2. See Sequence[EventBridgeRuleTemplateTargetTypeDef]
  3. See CreateEventBridgeRuleTemplateResponseTypeDef
# create_event_bridge_rule_template method usage example with argument unpacking

kwargs: CreateEventBridgeRuleTemplateRequestTypeDef = {  # (1)
    "EventType": ...,
    "GroupIdentifier": ...,
    "Name": ...,
}

parent.create_event_bridge_rule_template(**kwargs)
  1. See CreateEventBridgeRuleTemplateRequestTypeDef

create_event_bridge_rule_template_group#

Creates an eventbridge rule template group to group your eventbridge rule templates and to attach to signal maps for dynamically creating notification rules.

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

# create_event_bridge_rule_template_group method definition

def create_event_bridge_rule_template_group(
    self,
    *,
    Name: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
    RequestId: str = ...,
) -> CreateEventBridgeRuleTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See CreateEventBridgeRuleTemplateGroupResponseTypeDef
# create_event_bridge_rule_template_group method usage example with argument unpacking

kwargs: CreateEventBridgeRuleTemplateGroupRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.create_event_bridge_rule_template_group(**kwargs)
  1. See CreateEventBridgeRuleTemplateGroupRequestTypeDef

create_signal_map#

Initiates the creation of a new signal map.

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

# create_signal_map method definition

def create_signal_map(
    self,
    *,
    DiscoveryEntryPointArn: str,
    Name: str,
    CloudWatchAlarmTemplateGroupIdentifiers: Sequence[str] = ...,
    Description: str = ...,
    EventBridgeRuleTemplateGroupIdentifiers: Sequence[str] = ...,
    Tags: Mapping[str, str] = ...,
    RequestId: str = ...,
) -> CreateSignalMapResponseTypeDef:  # (1)
    ...
  1. See CreateSignalMapResponseTypeDef
# create_signal_map method usage example with argument unpacking

kwargs: CreateSignalMapRequestTypeDef = {  # (1)
    "DiscoveryEntryPointArn": ...,
    "Name": ...,
}

parent.create_signal_map(**kwargs)
  1. See CreateSignalMapRequestTypeDef

delete_cloud_watch_alarm_template#

Deletes a cloudwatch alarm template.

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

# delete_cloud_watch_alarm_template method definition

def delete_cloud_watch_alarm_template(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_cloud_watch_alarm_template method usage example with argument unpacking

kwargs: DeleteCloudWatchAlarmTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_cloud_watch_alarm_template(**kwargs)
  1. See DeleteCloudWatchAlarmTemplateRequestTypeDef

delete_cloud_watch_alarm_template_group#

Deletes a cloudwatch alarm template group.

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

# delete_cloud_watch_alarm_template_group method definition

def delete_cloud_watch_alarm_template_group(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_cloud_watch_alarm_template_group method usage example with argument unpacking

kwargs: DeleteCloudWatchAlarmTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_cloud_watch_alarm_template_group(**kwargs)
  1. See DeleteCloudWatchAlarmTemplateGroupRequestTypeDef

delete_event_bridge_rule_template#

Deletes an eventbridge rule template.

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

# delete_event_bridge_rule_template method definition

def delete_event_bridge_rule_template(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_event_bridge_rule_template method usage example with argument unpacking

kwargs: DeleteEventBridgeRuleTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_event_bridge_rule_template(**kwargs)
  1. See DeleteEventBridgeRuleTemplateRequestTypeDef

delete_event_bridge_rule_template_group#

Deletes an eventbridge rule template group.

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

# delete_event_bridge_rule_template_group method definition

def delete_event_bridge_rule_template_group(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_event_bridge_rule_template_group method usage example with argument unpacking

kwargs: DeleteEventBridgeRuleTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_event_bridge_rule_template_group(**kwargs)
  1. See DeleteEventBridgeRuleTemplateGroupRequestTypeDef

delete_signal_map#

Deletes the specified signal map.

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

# delete_signal_map method definition

def delete_signal_map(
    self,
    *,
    Identifier: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...
  1. See EmptyResponseMetadataTypeDef
# delete_signal_map method usage example with argument unpacking

kwargs: DeleteSignalMapRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.delete_signal_map(**kwargs)
  1. See DeleteSignalMapRequestTypeDef

get_cloud_watch_alarm_template#

Retrieves the specified cloudwatch alarm template.

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

# get_cloud_watch_alarm_template method definition

def get_cloud_watch_alarm_template(
    self,
    *,
    Identifier: str,
) -> GetCloudWatchAlarmTemplateResponseTypeDef:  # (1)
    ...
  1. See GetCloudWatchAlarmTemplateResponseTypeDef
# get_cloud_watch_alarm_template method usage example with argument unpacking

kwargs: GetCloudWatchAlarmTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_cloud_watch_alarm_template(**kwargs)
  1. See GetCloudWatchAlarmTemplateRequestTypeDef

get_cloud_watch_alarm_template_group#

Retrieves the specified cloudwatch alarm template group.

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

# get_cloud_watch_alarm_template_group method definition

def get_cloud_watch_alarm_template_group(
    self,
    *,
    Identifier: str,
) -> GetCloudWatchAlarmTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See GetCloudWatchAlarmTemplateGroupResponseTypeDef
# get_cloud_watch_alarm_template_group method usage example with argument unpacking

kwargs: GetCloudWatchAlarmTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_cloud_watch_alarm_template_group(**kwargs)
  1. See GetCloudWatchAlarmTemplateGroupRequestTypeDef

get_event_bridge_rule_template#

Retrieves the specified eventbridge rule template.

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

# get_event_bridge_rule_template method definition

def get_event_bridge_rule_template(
    self,
    *,
    Identifier: str,
) -> GetEventBridgeRuleTemplateResponseTypeDef:  # (1)
    ...
  1. See GetEventBridgeRuleTemplateResponseTypeDef
# get_event_bridge_rule_template method usage example with argument unpacking

kwargs: GetEventBridgeRuleTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_event_bridge_rule_template(**kwargs)
  1. See GetEventBridgeRuleTemplateRequestTypeDef

get_event_bridge_rule_template_group#

Retrieves the specified eventbridge rule template group.

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

# get_event_bridge_rule_template_group method definition

def get_event_bridge_rule_template_group(
    self,
    *,
    Identifier: str,
) -> GetEventBridgeRuleTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See GetEventBridgeRuleTemplateGroupResponseTypeDef
# get_event_bridge_rule_template_group method usage example with argument unpacking

kwargs: GetEventBridgeRuleTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_event_bridge_rule_template_group(**kwargs)
  1. See GetEventBridgeRuleTemplateGroupRequestTypeDef

get_signal_map#

Retrieves the specified signal map.

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

# get_signal_map method definition

def get_signal_map(
    self,
    *,
    Identifier: str,
) -> GetSignalMapResponseTypeDef:  # (1)
    ...
  1. See GetSignalMapResponseTypeDef
# get_signal_map method usage example with argument unpacking

kwargs: GetSignalMapRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.get_signal_map(**kwargs)
  1. See GetSignalMapRequestTypeDef

list_cloud_watch_alarm_template_groups#

Lists cloudwatch alarm template groups.

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

# list_cloud_watch_alarm_template_groups method definition

def list_cloud_watch_alarm_template_groups(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    Scope: str = ...,
    SignalMapIdentifier: str = ...,
) -> ListCloudWatchAlarmTemplateGroupsResponseTypeDef:  # (1)
    ...
  1. See ListCloudWatchAlarmTemplateGroupsResponseTypeDef
# list_cloud_watch_alarm_template_groups method usage example with argument unpacking

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

parent.list_cloud_watch_alarm_template_groups(**kwargs)
  1. See ListCloudWatchAlarmTemplateGroupsRequestTypeDef

list_cloud_watch_alarm_templates#

Lists cloudwatch alarm templates.

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

# list_cloud_watch_alarm_templates method definition

def list_cloud_watch_alarm_templates(
    self,
    *,
    GroupIdentifier: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    Scope: str = ...,
    SignalMapIdentifier: str = ...,
) -> ListCloudWatchAlarmTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListCloudWatchAlarmTemplatesResponseTypeDef
# list_cloud_watch_alarm_templates method usage example with argument unpacking

kwargs: ListCloudWatchAlarmTemplatesRequestTypeDef = {  # (1)
    "GroupIdentifier": ...,
}

parent.list_cloud_watch_alarm_templates(**kwargs)
  1. See ListCloudWatchAlarmTemplatesRequestTypeDef

list_event_bridge_rule_template_groups#

Lists eventbridge rule template groups.

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

# list_event_bridge_rule_template_groups method definition

def list_event_bridge_rule_template_groups(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    SignalMapIdentifier: str = ...,
) -> ListEventBridgeRuleTemplateGroupsResponseTypeDef:  # (1)
    ...
  1. See ListEventBridgeRuleTemplateGroupsResponseTypeDef
# list_event_bridge_rule_template_groups method usage example with argument unpacking

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

parent.list_event_bridge_rule_template_groups(**kwargs)
  1. See ListEventBridgeRuleTemplateGroupsRequestTypeDef

list_event_bridge_rule_templates#

Lists eventbridge rule templates.

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

# list_event_bridge_rule_templates method definition

def list_event_bridge_rule_templates(
    self,
    *,
    GroupIdentifier: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
    SignalMapIdentifier: str = ...,
) -> ListEventBridgeRuleTemplatesResponseTypeDef:  # (1)
    ...
  1. See ListEventBridgeRuleTemplatesResponseTypeDef
# list_event_bridge_rule_templates method usage example with argument unpacking

kwargs: ListEventBridgeRuleTemplatesRequestTypeDef = {  # (1)
    "GroupIdentifier": ...,
}

parent.list_event_bridge_rule_templates(**kwargs)
  1. See ListEventBridgeRuleTemplatesRequestTypeDef

list_signal_maps#

Lists signal maps.

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

# list_signal_maps method definition

def list_signal_maps(
    self,
    *,
    CloudWatchAlarmTemplateGroupIdentifier: str = ...,
    EventBridgeRuleTemplateGroupIdentifier: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListSignalMapsResponseTypeDef:  # (1)
    ...
  1. See ListSignalMapsResponseTypeDef
# list_signal_maps method usage example with argument unpacking

kwargs: ListSignalMapsRequestTypeDef = {  # (1)
    "CloudWatchAlarmTemplateGroupIdentifier": ...,
}

parent.list_signal_maps(**kwargs)
  1. See ListSignalMapsRequestTypeDef

start_delete_monitor_deployment#

Initiates a deployment to delete the monitor of the specified signal map.

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

# start_delete_monitor_deployment method definition

def start_delete_monitor_deployment(
    self,
    *,
    Identifier: str,
) -> StartDeleteMonitorDeploymentResponseTypeDef:  # (1)
    ...
  1. See StartDeleteMonitorDeploymentResponseTypeDef
# start_delete_monitor_deployment method usage example with argument unpacking

kwargs: StartDeleteMonitorDeploymentRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.start_delete_monitor_deployment(**kwargs)
  1. See StartDeleteMonitorDeploymentRequestTypeDef

start_monitor_deployment#

Initiates a deployment to deploy the latest monitor of the specified signal map.

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

# start_monitor_deployment method definition

def start_monitor_deployment(
    self,
    *,
    Identifier: str,
    DryRun: bool = ...,
) -> StartMonitorDeploymentResponseTypeDef:  # (1)
    ...
  1. See StartMonitorDeploymentResponseTypeDef
# start_monitor_deployment method usage example with argument unpacking

kwargs: StartMonitorDeploymentRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.start_monitor_deployment(**kwargs)
  1. See StartMonitorDeploymentRequestTypeDef

start_update_signal_map#

Initiates an update for the specified signal map.

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

# start_update_signal_map method definition

def start_update_signal_map(
    self,
    *,
    Identifier: str,
    CloudWatchAlarmTemplateGroupIdentifiers: Sequence[str] = ...,
    Description: str = ...,
    DiscoveryEntryPointArn: str = ...,
    EventBridgeRuleTemplateGroupIdentifiers: Sequence[str] = ...,
    ForceRediscovery: bool = ...,
    Name: str = ...,
) -> StartUpdateSignalMapResponseTypeDef:  # (1)
    ...
  1. See StartUpdateSignalMapResponseTypeDef
# start_update_signal_map method usage example with argument unpacking

kwargs: StartUpdateSignalMapRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.start_update_signal_map(**kwargs)
  1. See StartUpdateSignalMapRequestTypeDef

update_cloud_watch_alarm_template#

Updates the specified cloudwatch alarm template.

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

# update_cloud_watch_alarm_template method definition

def update_cloud_watch_alarm_template(
    self,
    *,
    Identifier: str,
    ComparisonOperator: CloudWatchAlarmTemplateComparisonOperatorType = ...,  # (1)
    DatapointsToAlarm: int = ...,
    Description: str = ...,
    EvaluationPeriods: int = ...,
    GroupIdentifier: str = ...,
    MetricName: str = ...,
    Name: str = ...,
    Period: int = ...,
    Statistic: CloudWatchAlarmTemplateStatisticType = ...,  # (2)
    TargetResourceType: CloudWatchAlarmTemplateTargetResourceTypeType = ...,  # (3)
    Threshold: float = ...,
    TreatMissingData: CloudWatchAlarmTemplateTreatMissingDataType = ...,  # (4)
) -> UpdateCloudWatchAlarmTemplateResponseTypeDef:  # (5)
    ...
  1. See CloudWatchAlarmTemplateComparisonOperatorType
  2. See CloudWatchAlarmTemplateStatisticType
  3. See CloudWatchAlarmTemplateTargetResourceTypeType
  4. See CloudWatchAlarmTemplateTreatMissingDataType
  5. See UpdateCloudWatchAlarmTemplateResponseTypeDef
# update_cloud_watch_alarm_template method usage example with argument unpacking

kwargs: UpdateCloudWatchAlarmTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_cloud_watch_alarm_template(**kwargs)
  1. See UpdateCloudWatchAlarmTemplateRequestTypeDef

update_cloud_watch_alarm_template_group#

Updates the specified cloudwatch alarm template group.

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

# update_cloud_watch_alarm_template_group method definition

def update_cloud_watch_alarm_template_group(
    self,
    *,
    Identifier: str,
    Description: str = ...,
) -> UpdateCloudWatchAlarmTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateCloudWatchAlarmTemplateGroupResponseTypeDef
# update_cloud_watch_alarm_template_group method usage example with argument unpacking

kwargs: UpdateCloudWatchAlarmTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_cloud_watch_alarm_template_group(**kwargs)
  1. See UpdateCloudWatchAlarmTemplateGroupRequestTypeDef

update_event_bridge_rule_template#

Updates the specified eventbridge rule template.

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

# update_event_bridge_rule_template method definition

def update_event_bridge_rule_template(
    self,
    *,
    Identifier: str,
    Description: str = ...,
    EventTargets: Sequence[EventBridgeRuleTemplateTargetTypeDef] = ...,  # (1)
    EventType: EventBridgeRuleTemplateEventTypeType = ...,  # (2)
    GroupIdentifier: str = ...,
    Name: str = ...,
) -> UpdateEventBridgeRuleTemplateResponseTypeDef:  # (3)
    ...
  1. See Sequence[EventBridgeRuleTemplateTargetTypeDef]
  2. See EventBridgeRuleTemplateEventTypeType
  3. See UpdateEventBridgeRuleTemplateResponseTypeDef
# update_event_bridge_rule_template method usage example with argument unpacking

kwargs: UpdateEventBridgeRuleTemplateRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_event_bridge_rule_template(**kwargs)
  1. See UpdateEventBridgeRuleTemplateRequestTypeDef

update_event_bridge_rule_template_group#

Updates the specified eventbridge rule template group.

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

# update_event_bridge_rule_template_group method definition

def update_event_bridge_rule_template_group(
    self,
    *,
    Identifier: str,
    Description: str = ...,
) -> UpdateEventBridgeRuleTemplateGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateEventBridgeRuleTemplateGroupResponseTypeDef
# update_event_bridge_rule_template_group method usage example with argument unpacking

kwargs: UpdateEventBridgeRuleTemplateGroupRequestTypeDef = {  # (1)
    "Identifier": ...,
}

parent.update_event_bridge_rule_template_group(**kwargs)
  1. See UpdateEventBridgeRuleTemplateGroupRequestTypeDef

create_channel_placement_group#

Create a ChannelPlacementGroup in the specified Cluster.

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

# create_channel_placement_group method definition

def create_channel_placement_group(
    self,
    *,
    ClusterId: str,
    Name: str = ...,
    Nodes: Sequence[str] = ...,
    RequestId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateChannelPlacementGroupResponseTypeDef:  # (1)
    ...
  1. See CreateChannelPlacementGroupResponseTypeDef
# create_channel_placement_group method usage example with argument unpacking

kwargs: CreateChannelPlacementGroupRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.create_channel_placement_group(**kwargs)
  1. See CreateChannelPlacementGroupRequestTypeDef

create_cluster#

Create a new Cluster.

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

# create_cluster method definition

def create_cluster(
    self,
    *,
    ClusterType: ClusterTypeType = ...,  # (1)
    InstanceRoleArn: str = ...,
    Name: str = ...,
    NetworkSettings: ClusterNetworkSettingsCreateRequestTypeDef = ...,  # (2)
    RequestId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateClusterResponseTypeDef:  # (3)
    ...
  1. See ClusterTypeType
  2. See ClusterNetworkSettingsCreateRequestTypeDef
  3. See CreateClusterResponseTypeDef
# create_cluster method usage example with argument unpacking

kwargs: CreateClusterRequestTypeDef = {  # (1)
    "ClusterType": ...,
}

parent.create_cluster(**kwargs)
  1. See CreateClusterRequestTypeDef

create_network#

Create as many Networks as you need.

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

# create_network method definition

def create_network(
    self,
    *,
    IpPools: Sequence[IpPoolCreateRequestTypeDef] = ...,  # (1)
    Name: str = ...,
    RequestId: str = ...,
    Routes: Sequence[RouteCreateRequestTypeDef] = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateNetworkResponseTypeDef:  # (3)
    ...
  1. See Sequence[IpPoolCreateRequestTypeDef]
  2. See Sequence[RouteCreateRequestTypeDef]
  3. See CreateNetworkResponseTypeDef
# create_network method usage example with argument unpacking

kwargs: CreateNetworkRequestTypeDef = {  # (1)
    "IpPools": ...,
}

parent.create_network(**kwargs)
  1. See CreateNetworkRequestTypeDef

create_node#

Create a Node in the specified Cluster.

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

# create_node method definition

def create_node(
    self,
    *,
    ClusterId: str,
    Name: str = ...,
    NodeInterfaceMappings: Sequence[NodeInterfaceMappingCreateRequestTypeDef] = ...,  # (1)
    RequestId: str = ...,
    Role: NodeRoleType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateNodeResponseTypeDef:  # (3)
    ...
  1. See Sequence[NodeInterfaceMappingCreateRequestTypeDef]
  2. See NodeRoleType
  3. See CreateNodeResponseTypeDef
# create_node method usage example with argument unpacking

kwargs: CreateNodeRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.create_node(**kwargs)
  1. See CreateNodeRequestTypeDef

create_node_registration_script#

Create the Register Node script for all the nodes intended for a specific Cluster.

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

# create_node_registration_script method definition

def create_node_registration_script(
    self,
    *,
    ClusterId: str,
    Id: str = ...,
    Name: str = ...,
    NodeInterfaceMappings: Sequence[NodeInterfaceMappingTypeDef] = ...,  # (1)
    RequestId: str = ...,
    Role: NodeRoleType = ...,  # (2)
) -> CreateNodeRegistrationScriptResponseTypeDef:  # (3)
    ...
  1. See Sequence[NodeInterfaceMappingTypeDef]
  2. See NodeRoleType
  3. See CreateNodeRegistrationScriptResponseTypeDef
# create_node_registration_script method usage example with argument unpacking

kwargs: CreateNodeRegistrationScriptRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.create_node_registration_script(**kwargs)
  1. See CreateNodeRegistrationScriptRequestTypeDef

delete_channel_placement_group#

Delete the specified ChannelPlacementGroup that exists in the specified Cluster.

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

# delete_channel_placement_group method definition

def delete_channel_placement_group(
    self,
    *,
    ChannelPlacementGroupId: str,
    ClusterId: str,
) -> DeleteChannelPlacementGroupResponseTypeDef:  # (1)
    ...
  1. See DeleteChannelPlacementGroupResponseTypeDef
# delete_channel_placement_group method usage example with argument unpacking

kwargs: DeleteChannelPlacementGroupRequestTypeDef = {  # (1)
    "ChannelPlacementGroupId": ...,
    "ClusterId": ...,
}

parent.delete_channel_placement_group(**kwargs)
  1. See DeleteChannelPlacementGroupRequestTypeDef

delete_cluster#

Delete a Cluster.

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

# delete_cluster method definition

def delete_cluster(
    self,
    *,
    ClusterId: str,
) -> DeleteClusterResponseTypeDef:  # (1)
    ...
  1. See DeleteClusterResponseTypeDef
# delete_cluster method usage example with argument unpacking

kwargs: DeleteClusterRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.delete_cluster(**kwargs)
  1. See DeleteClusterRequestTypeDef

delete_network#

Delete a Network.

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

# delete_network method definition

def delete_network(
    self,
    *,
    NetworkId: str,
) -> DeleteNetworkResponseTypeDef:  # (1)
    ...
  1. See DeleteNetworkResponseTypeDef
# delete_network method usage example with argument unpacking

kwargs: DeleteNetworkRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.delete_network(**kwargs)
  1. See DeleteNetworkRequestTypeDef

delete_node#

Delete a Node.

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

# delete_node method definition

def delete_node(
    self,
    *,
    ClusterId: str,
    NodeId: str,
) -> DeleteNodeResponseTypeDef:  # (1)
    ...
  1. See DeleteNodeResponseTypeDef
# delete_node method usage example with argument unpacking

kwargs: DeleteNodeRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "NodeId": ...,
}

parent.delete_node(**kwargs)
  1. See DeleteNodeRequestTypeDef

describe_channel_placement_group#

Get details about a ChannelPlacementGroup.

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

# describe_channel_placement_group method definition

def describe_channel_placement_group(
    self,
    *,
    ChannelPlacementGroupId: str,
    ClusterId: str,
) -> DescribeChannelPlacementGroupResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelPlacementGroupResponseTypeDef
# describe_channel_placement_group method usage example with argument unpacking

kwargs: DescribeChannelPlacementGroupRequestTypeDef = {  # (1)
    "ChannelPlacementGroupId": ...,
    "ClusterId": ...,
}

parent.describe_channel_placement_group(**kwargs)
  1. See DescribeChannelPlacementGroupRequestTypeDef

describe_cluster#

Get details about a Cluster.

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

# describe_cluster method definition

def describe_cluster(
    self,
    *,
    ClusterId: str,
) -> DescribeClusterResponseTypeDef:  # (1)
    ...
  1. See DescribeClusterResponseTypeDef
# describe_cluster method usage example with argument unpacking

kwargs: DescribeClusterRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.describe_cluster(**kwargs)
  1. See DescribeClusterRequestTypeDef

describe_network#

Get details about a Network.

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

# describe_network method definition

def describe_network(
    self,
    *,
    NetworkId: str,
) -> DescribeNetworkResponseTypeDef:  # (1)
    ...
  1. See DescribeNetworkResponseTypeDef
# describe_network method usage example with argument unpacking

kwargs: DescribeNetworkRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.describe_network(**kwargs)
  1. See DescribeNetworkRequestTypeDef

describe_node#

Get details about a Node in the specified Cluster.

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

# describe_node method definition

def describe_node(
    self,
    *,
    ClusterId: str,
    NodeId: str,
) -> DescribeNodeResponseTypeDef:  # (1)
    ...
  1. See DescribeNodeResponseTypeDef
# describe_node method usage example with argument unpacking

kwargs: DescribeNodeRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "NodeId": ...,
}

parent.describe_node(**kwargs)
  1. See DescribeNodeRequestTypeDef

list_channel_placement_groups#

Retrieve the list of ChannelPlacementGroups in the specified Cluster.

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

# list_channel_placement_groups method definition

def list_channel_placement_groups(
    self,
    *,
    ClusterId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelPlacementGroupsResponseTypeDef:  # (1)
    ...
  1. See ListChannelPlacementGroupsResponseTypeDef
# list_channel_placement_groups method usage example with argument unpacking

kwargs: ListChannelPlacementGroupsRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_channel_placement_groups(**kwargs)
  1. See ListChannelPlacementGroupsRequestTypeDef

list_clusters#

Retrieve the list of Clusters.

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

# list_clusters method definition

def list_clusters(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListClustersResponseTypeDef:  # (1)
    ...
  1. See ListClustersResponseTypeDef
# list_clusters method usage example with argument unpacking

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

parent.list_clusters(**kwargs)
  1. See ListClustersRequestTypeDef

list_networks#

Retrieve the list of Networks.

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

# list_networks method definition

def list_networks(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNetworksResponseTypeDef:  # (1)
    ...
  1. See ListNetworksResponseTypeDef
# list_networks method usage example with argument unpacking

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

parent.list_networks(**kwargs)
  1. See ListNetworksRequestTypeDef

list_nodes#

Retrieve the list of Nodes.

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

# list_nodes method definition

def list_nodes(
    self,
    *,
    ClusterId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListNodesResponseTypeDef:  # (1)
    ...
  1. See ListNodesResponseTypeDef
# list_nodes method usage example with argument unpacking

kwargs: ListNodesRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.list_nodes(**kwargs)
  1. See ListNodesRequestTypeDef

update_channel_placement_group#

Change the settings for a ChannelPlacementGroup.

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

# update_channel_placement_group method definition

def update_channel_placement_group(
    self,
    *,
    ChannelPlacementGroupId: str,
    ClusterId: str,
    Name: str = ...,
    Nodes: Sequence[str] = ...,
) -> UpdateChannelPlacementGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateChannelPlacementGroupResponseTypeDef
# update_channel_placement_group method usage example with argument unpacking

kwargs: UpdateChannelPlacementGroupRequestTypeDef = {  # (1)
    "ChannelPlacementGroupId": ...,
    "ClusterId": ...,
}

parent.update_channel_placement_group(**kwargs)
  1. See UpdateChannelPlacementGroupRequestTypeDef

update_cluster#

Change the settings for a Cluster.

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

# update_cluster method definition

def update_cluster(
    self,
    *,
    ClusterId: str,
    Name: str = ...,
    NetworkSettings: ClusterNetworkSettingsUpdateRequestTypeDef = ...,  # (1)
) -> UpdateClusterResponseTypeDef:  # (2)
    ...
  1. See ClusterNetworkSettingsUpdateRequestTypeDef
  2. See UpdateClusterResponseTypeDef
# update_cluster method usage example with argument unpacking

kwargs: UpdateClusterRequestTypeDef = {  # (1)
    "ClusterId": ...,
}

parent.update_cluster(**kwargs)
  1. See UpdateClusterRequestTypeDef

update_network#

Change the settings for a Network.

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

# update_network method definition

def update_network(
    self,
    *,
    NetworkId: str,
    IpPools: Sequence[IpPoolUpdateRequestTypeDef] = ...,  # (1)
    Name: str = ...,
    Routes: Sequence[RouteUpdateRequestTypeDef] = ...,  # (2)
) -> UpdateNetworkResponseTypeDef:  # (3)
    ...
  1. See Sequence[IpPoolUpdateRequestTypeDef]
  2. See Sequence[RouteUpdateRequestTypeDef]
  3. See UpdateNetworkResponseTypeDef
# update_network method usage example with argument unpacking

kwargs: UpdateNetworkRequestTypeDef = {  # (1)
    "NetworkId": ...,
}

parent.update_network(**kwargs)
  1. See UpdateNetworkRequestTypeDef

update_node#

Change the settings for a Node.

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

# update_node method definition

def update_node(
    self,
    *,
    ClusterId: str,
    NodeId: str,
    Name: str = ...,
    Role: NodeRoleType = ...,  # (1)
) -> UpdateNodeResponseTypeDef:  # (2)
    ...
  1. See NodeRoleType
  2. See UpdateNodeResponseTypeDef
# update_node method usage example with argument unpacking

kwargs: UpdateNodeRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "NodeId": ...,
}

parent.update_node(**kwargs)
  1. See UpdateNodeRequestTypeDef

update_node_state#

Update the state of a node.

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

# update_node_state method definition

def update_node_state(
    self,
    *,
    ClusterId: str,
    NodeId: str,
    State: UpdateNodeStateType = ...,  # (1)
) -> UpdateNodeStateResponseTypeDef:  # (2)
    ...
  1. See UpdateNodeStateType
  2. See UpdateNodeStateResponseTypeDef
# update_node_state method usage example with argument unpacking

kwargs: UpdateNodeStateRequestTypeDef = {  # (1)
    "ClusterId": ...,
    "NodeId": ...,
}

parent.update_node_state(**kwargs)
  1. See UpdateNodeStateRequestTypeDef

list_versions#

Retrieves an array of all the encoder engine versions that are available in this AWS account.

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

# list_versions method definition

def list_versions(
    self,
) -> ListVersionsResponseTypeDef:  # (1)
    ...
  1. See ListVersionsResponseTypeDef

get_paginator#

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

get_waiter#

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