Skip to content

MediaConnectClient#

Index > MediaConnect > MediaConnectClient

Auto-generated documentation for MediaConnect type annotations stubs module mypy-boto3-mediaconnect.

MediaConnectClient#

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

# MediaConnectClient usage example

from boto3.session import Session
from mypy_boto3_mediaconnect.client import MediaConnectClient

def get_mediaconnect_client() -> MediaConnectClient:
    return Session().client("mediaconnect")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mediaconnect")

try:
    do_something(client)
except (
    client.exceptions.AddFlowOutputs420Exception,
    client.exceptions.BadRequestException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.CreateBridge420Exception,
    client.exceptions.CreateFlow420Exception,
    client.exceptions.CreateGateway420Exception,
    client.exceptions.ForbiddenException,
    client.exceptions.GrantFlowEntitlements420Exception,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyRequestsException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediaconnect.client import Exceptions

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

Methods#

add_bridge_outputs#

Adds outputs to an existing bridge.

Type annotations and code completion for boto3.client("mediaconnect").add_bridge_outputs method. boto3 documentation

# add_bridge_outputs method definition

def add_bridge_outputs(
    self,
    *,
    BridgeArn: str,
    Outputs: Sequence[AddBridgeOutputRequestTypeDef],  # (1)
) -> AddBridgeOutputsResponseTypeDef:  # (2)
    ...
  1. See AddBridgeOutputRequestTypeDef
  2. See AddBridgeOutputsResponseTypeDef 
# add_bridge_outputs method usage example with argument unpacking

kwargs: AddBridgeOutputsRequestRequestTypeDef = {  # (1)
    "BridgeArn": ...,
    "Outputs": ...,
}

parent.add_bridge_outputs(**kwargs)
  1. See AddBridgeOutputsRequestRequestTypeDef

add_bridge_sources#

Adds sources to an existing bridge.

Type annotations and code completion for boto3.client("mediaconnect").add_bridge_sources method. boto3 documentation

# add_bridge_sources method definition

def add_bridge_sources(
    self,
    *,
    BridgeArn: str,
    Sources: Sequence[AddBridgeSourceRequestTypeDef],  # (1)
) -> AddBridgeSourcesResponseTypeDef:  # (2)
    ...
  1. See AddBridgeSourceRequestTypeDef
  2. See AddBridgeSourcesResponseTypeDef 
# add_bridge_sources method usage example with argument unpacking

kwargs: AddBridgeSourcesRequestRequestTypeDef = {  # (1)
    "BridgeArn": ...,
    "Sources": ...,
}

parent.add_bridge_sources(**kwargs)
  1. See AddBridgeSourcesRequestRequestTypeDef

add_flow_media_streams#

Adds media streams to an existing flow.

Type annotations and code completion for boto3.client("mediaconnect").add_flow_media_streams method. boto3 documentation

# add_flow_media_streams method definition

def add_flow_media_streams(
    self,
    *,
    FlowArn: str,
    MediaStreams: Sequence[AddMediaStreamRequestTypeDef],  # (1)
) -> AddFlowMediaStreamsResponseTypeDef:  # (2)
    ...
  1. See AddMediaStreamRequestTypeDef
  2. See AddFlowMediaStreamsResponseTypeDef 
# add_flow_media_streams method usage example with argument unpacking

kwargs: AddFlowMediaStreamsRequestRequestTypeDef = {  # (1)
    "FlowArn": ...,
    "MediaStreams": ...,
}

parent.add_flow_media_streams(**kwargs)
  1. See AddFlowMediaStreamsRequestRequestTypeDef

add_flow_outputs#

Adds outputs to an existing flow.

Type annotations and code completion for boto3.client("mediaconnect").add_flow_outputs method. boto3 documentation

# add_flow_outputs method definition

def add_flow_outputs(
    self,
    *,
    FlowArn: str,
    Outputs: Sequence[AddOutputRequestTypeDef],  # (1)
) -> AddFlowOutputsResponseTypeDef:  # (2)
    ...
  1. See AddOutputRequestTypeDef
  2. See AddFlowOutputsResponseTypeDef 
# add_flow_outputs method usage example with argument unpacking

kwargs: AddFlowOutputsRequestRequestTypeDef = {  # (1)
    "FlowArn": ...,
    "Outputs": ...,
}

parent.add_flow_outputs(**kwargs)
  1. See AddFlowOutputsRequestRequestTypeDef

add_flow_sources#

Adds Sources to flow See also: AWS API Documentation.

Type annotations and code completion for boto3.client("mediaconnect").add_flow_sources method. boto3 documentation

# add_flow_sources method definition

def add_flow_sources(
    self,
    *,
    FlowArn: str,
    Sources: Sequence[SetSourceRequestTypeDef],  # (1)
) -> AddFlowSourcesResponseTypeDef:  # (2)
    ...
  1. See SetSourceRequestTypeDef
  2. See AddFlowSourcesResponseTypeDef 
# add_flow_sources method usage example with argument unpacking

kwargs: AddFlowSourcesRequestRequestTypeDef = {  # (1)
    "FlowArn": ...,
    "Sources": ...,
}

parent.add_flow_sources(**kwargs)
  1. See AddFlowSourcesRequestRequestTypeDef

add_flow_vpc_interfaces#

Adds VPC interfaces to flow See also: AWS API Documentation.

Type annotations and code completion for boto3.client("mediaconnect").add_flow_vpc_interfaces method. boto3 documentation

# add_flow_vpc_interfaces method definition

def add_flow_vpc_interfaces(
    self,
    *,
    FlowArn: str,
    VpcInterfaces: Sequence[VpcInterfaceRequestTypeDef],  # (1)
) -> AddFlowVpcInterfacesResponseTypeDef:  # (2)
    ...
  1. See VpcInterfaceRequestTypeDef
  2. See AddFlowVpcInterfacesResponseTypeDef 
# add_flow_vpc_interfaces method usage example with argument unpacking

kwargs: AddFlowVpcInterfacesRequestRequestTypeDef = {  # (1)
    "FlowArn": ...,
    "VpcInterfaces": ...,
}

parent.add_flow_vpc_interfaces(**kwargs)
  1. See AddFlowVpcInterfacesRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

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

# close method definition

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

create_bridge#

Creates a new bridge.

Type annotations and code completion for boto3.client("mediaconnect").create_bridge method. boto3 documentation

# create_bridge method definition

def create_bridge(
    self,
    *,
    Name: str,
    PlacementArn: str,
    Sources: Sequence[AddBridgeSourceRequestTypeDef],  # (1)
    EgressGatewayBridge: AddEgressGatewayBridgeRequestTypeDef = ...,  # (2)
    IngressGatewayBridge: AddIngressGatewayBridgeRequestTypeDef = ...,  # (3)
    Outputs: Sequence[AddBridgeOutputRequestTypeDef] = ...,  # (4)
    SourceFailoverConfig: FailoverConfigTypeDef = ...,  # (5)
) -> CreateBridgeResponseTypeDef:  # (6)
    ...
  1. See AddBridgeSourceRequestTypeDef
  2. See AddEgressGatewayBridgeRequestTypeDef
  3. See AddIngressGatewayBridgeRequestTypeDef
  4. See AddBridgeOutputRequestTypeDef
  5. See FailoverConfigTypeDef
  6. See CreateBridgeResponseTypeDef 
# create_bridge method usage example with argument unpacking

kwargs: CreateBridgeRequestRequestTypeDef = {  # (1)
    "Name": ...,
    "PlacementArn": ...,
    "Sources": ...,
}

parent.create_bridge(**kwargs)
  1. See CreateBridgeRequestRequestTypeDef

create_flow#

Creates a new flow.

Type annotations and code completion for boto3.client("mediaconnect").create_flow method. boto3 documentation

# create_flow method definition

def create_flow(
    self,
    *,
    Name: str,
    AvailabilityZone: str = ...,
    Entitlements: Sequence[GrantEntitlementRequestTypeDef] = ...,  # (1)
    MediaStreams: Sequence[AddMediaStreamRequestTypeDef] = ...,  # (2)
    Outputs: Sequence[AddOutputRequestTypeDef] = ...,  # (3)
    Source: SetSourceRequestTypeDef = ...,  # (4)
    SourceFailoverConfig: FailoverConfigTypeDef = ...,  # (5)
    Sources: Sequence[SetSourceRequestTypeDef] = ...,  # (6)
    VpcInterfaces: Sequence[VpcInterfaceRequestTypeDef] = ...,  # (7)
    Maintenance: AddMaintenanceTypeDef = ...,  # (8)
) -> CreateFlowResponseTypeDef:  # (9)
    ...
  1. See GrantEntitlementRequestTypeDef
  2. See AddMediaStreamRequestTypeDef
  3. See AddOutputRequestTypeDef
  4. See SetSourceRequestTypeDef
  5. See FailoverConfigTypeDef
  6. See SetSourceRequestTypeDef
  7. See VpcInterfaceRequestTypeDef
  8. See AddMaintenanceTypeDef
  9. See CreateFlowResponseTypeDef 
# create_flow method usage example with argument unpacking

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

parent.create_flow(**kwargs)
  1. See CreateFlowRequestRequestTypeDef

create_gateway#

Creates a new gateway.

Type annotations and code completion for boto3.client("mediaconnect").create_gateway method. boto3 documentation

# create_gateway method definition

def create_gateway(
    self,
    *,
    EgressCidrBlocks: Sequence[str],
    Name: str,
    Networks: Sequence[GatewayNetworkTypeDef],  # (1)
) -> CreateGatewayResponseTypeDef:  # (2)
    ...
  1. See GatewayNetworkTypeDef
  2. See CreateGatewayResponseTypeDef 
# create_gateway method usage example with argument unpacking

kwargs: CreateGatewayRequestRequestTypeDef = {  # (1)
    "EgressCidrBlocks": ...,
    "Name": ...,
    "Networks": ...,
}

parent.create_gateway(**kwargs)
  1. See CreateGatewayRequestRequestTypeDef

delete_bridge#

Deletes a bridge.

Type annotations and code completion for boto3.client("mediaconnect").delete_bridge method. boto3 documentation

# delete_bridge method definition

def delete_bridge(
    self,
    *,
    BridgeArn: str,
) -> DeleteBridgeResponseTypeDef:  # (1)
    ...
  1. See DeleteBridgeResponseTypeDef 
# delete_bridge method usage example with argument unpacking

kwargs: DeleteBridgeRequestRequestTypeDef = {  # (1)
    "BridgeArn": ...,
}

parent.delete_bridge(**kwargs)
  1. See DeleteBridgeRequestRequestTypeDef

delete_flow#

Deletes a flow.

Type annotations and code completion for boto3.client("mediaconnect").delete_flow method. boto3 documentation

# delete_flow method definition

def delete_flow(
    self,
    *,
    FlowArn: str,
) -> DeleteFlowResponseTypeDef:  # (1)
    ...
  1. See DeleteFlowResponseTypeDef 
# delete_flow method usage example with argument unpacking

kwargs: DeleteFlowRequestRequestTypeDef = {  # (1)
    "FlowArn": ...,
}

parent.delete_flow(**kwargs)
  1. See DeleteFlowRequestRequestTypeDef

delete_gateway#

Deletes a gateway.

Type annotations and code completion for boto3.client("mediaconnect").delete_gateway method.