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)
    SourceMonitoringConfig: MonitoringConfigTypeDef = ...,  # (9)
) -> CreateFlowResponseTypeDef:  # (10)
    ...

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 MonitoringConfigTypeDef
10. 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. boto3 documentation

# delete_gateway method definition

def delete_gateway(
    self,
    *,
    GatewayArn: str,
) -> DeleteGatewayResponseTypeDef:  # (1)
    ...

1. See DeleteGatewayResponseTypeDef

# delete_gateway method usage example with argument unpacking

kwargs: DeleteGatewayRequestRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.delete_gateway(**kwargs)

1. See DeleteGatewayRequestRequestTypeDef

deregister_gateway_instance

Deregisters an instance.

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

# deregister_gateway_instance method definition

def deregister_gateway_instance(
    self,
    *,
    GatewayInstanceArn: str,
    Force: bool = ...,
) -> DeregisterGatewayInstanceResponseTypeDef:  # (1)
    ...

1. See DeregisterGatewayInstanceResponseTypeDef

# deregister_gateway_instance method usage example with argument unpacking

kwargs: DeregisterGatewayInstanceRequestRequestTypeDef = {  # (1)
    "GatewayInstanceArn": ...,
}

parent.deregister_gateway_instance(**kwargs)

1. See DeregisterGatewayInstanceRequestRequestTypeDef

describe_bridge

Displays the details of a bridge.

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

# describe_bridge method definition

def describe_bridge(
    self,
    *,
    BridgeArn: str,
) -> DescribeBridgeResponseTypeDef:  # (1)
    ...

1. See DescribeBridgeResponseTypeDef

# describe_bridge method usage example with argument unpacking

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

parent.describe_bridge(**kwargs)

1. See DescribeBridgeRequestRequestTypeDef

describe_flow

Displays the details of a flow.

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

# describe_flow method definition

def describe_flow(
    self,
    *,
    FlowArn: str,
) -> DescribeFlowResponseTypeDef:  # (1)
    ...

1. See DescribeFlowResponseTypeDef

# describe_flow method usage example with argument unpacking

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

parent.describe_flow(**kwargs)

1. See DescribeFlowRequestRequestTypeDef

describe_flow_source_metadata

Displays details of the flow's source stream.

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

# describe_flow_source_metadata method definition

def describe_flow_source_metadata(
    self,
    *,
    FlowArn: str,
) -> DescribeFlowSourceMetadataResponseTypeDef:  # (1)
    ...

1. See DescribeFlowSourceMetadataResponseTypeDef

# describe_flow_source_metadata method usage example with argument unpacking

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

parent.describe_flow_source_metadata(**kwargs)

1. See DescribeFlowSourceMetadataRequestRequestTypeDef

describe_flow_source_thumbnail

Displays the thumbnail details of a flow's source stream.

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

# describe_flow_source_thumbnail method definition

def describe_flow_source_thumbnail(
    self,
    *,
    FlowArn: str,
) -> DescribeFlowSourceThumbnailResponseTypeDef:  # (1)
    ...

1. See DescribeFlowSourceThumbnailResponseTypeDef

# describe_flow_source_thumbnail method usage example with argument unpacking

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

parent.describe_flow_source_thumbnail(**kwargs)

1. See DescribeFlowSourceThumbnailRequestRequestTypeDef

describe_gateway

Displays the details of a gateway.

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

# describe_gateway method definition

def describe_gateway(
    self,
    *,
    GatewayArn: str,
) -> DescribeGatewayResponseTypeDef:  # (1)
    ...

1. See DescribeGatewayResponseTypeDef

# describe_gateway method usage example with argument unpacking

kwargs: DescribeGatewayRequestRequestTypeDef = {  # (1)
    "GatewayArn": ...,
}

parent.describe_gateway(**kwargs)

1. See DescribeGatewayRequestRequestTypeDef

describe_gateway_instance

Displays the details of an instance.

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

# describe_gateway_instance method definition

def describe_gateway_instance(
    self,
    *,
    GatewayInstanceArn: str,
) -> DescribeGatewayInstanceResponseTypeDef:  # (1)
    ...

1. See DescribeGatewayInstanceResponseTypeDef

# describe_gateway_instance method usage example with argument unpacking

kwargs: DescribeGatewayInstanceRequestRequestTypeDef = {  # (1)
    "GatewayInstanceArn": ...,
}

parent.describe_gateway_instance(**kwargs)

1. See DescribeGatewayInstanceRequestRequestTypeDef

describe_offering

Displays the details of an offering.

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

# describe_offering method definition

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

1. See DescribeOfferingResponseTypeDef

# describe_offering method usage example with argument unpacking

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

parent.describe_offering(**kwargs)

1. See DescribeOfferingRequestRequestTypeDef

describe_reservation

Displays the details of a reservation.

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

# describe_reservation method definition

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

1. See DescribeReservationResponseTypeDef

# describe_reservation method usage example with argument unpacking

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

parent.describe_reservation(**kwargs)

1. See DescribeReservationRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("mediaconnect").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:
    ...

grant_flow_entitlements

Grants entitlements to an existing flow.

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

# grant_flow_entitlements method definition

def grant_flow_entitlements(
    self,
    *,
    Entitlements: Sequence[GrantEntitlementRequestTypeDef],  # (1)
    FlowArn: str,
) -> GrantFlowEntitlementsResponseTypeDef:  # (2)
    ...

1. See GrantEntitlementRequestTypeDef
2. See GrantFlowEntitlementsResponseTypeDef

# grant_flow_entitlements method usage example with argument unpacking

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

parent.grant_flow_entitlements(**kwargs)

1. See GrantFlowEntitlementsRequestRequestTypeDef

list_bridges

Displays a list of bridges that are associated with this account and an optionally specified Arn.

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

# list_bridges method definition

def list_bridges(
    self,
    *,
    FilterArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListBridgesResponseTypeDef:  # (1)
    ...

1. See ListBridgesResponseTypeDef

# list_bridges method usage example with argument unpacking

kwargs: ListBridgesRequestRequestTypeDef = {  # (1)
    "FilterArn": ...,
}

parent.list_bridges(**kwargs)

1. See ListBridgesRequestRequestTypeDef

list_entitlements

Displays a list of all entitlements that have been granted to this account.

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

# list_entitlements method definition

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

1. See ListEntitlementsResponseTypeDef

# list_entitlements method usage example with argument unpacking

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

parent.list_entitlements(**kwargs)

1. See ListEntitlementsRequestRequestTypeDef

list_flows

Displays a list of flows that are associated with this account.

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

# list_flows method definition

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

1. See ListFlowsResponseTypeDef

# list_flows method usage example with argument unpacking

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

parent.list_flows(**kwargs)

1. See ListFlowsRequestRequestTypeDef

list_gateway_instances

Displays a list of instances associated with the AWS account.

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

# list_gateway_instances method definition

def list_gateway_instances(
    self,
    *,
    FilterArn: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListGatewayInstancesResponseTypeDef:  # (1)
    ...

1. See ListGatewayInstancesResponseTypeDef

# list_gateway_instances method usage example with argument unpacking

kwargs: ListGatewayInstancesRequestRequestTypeDef = {  # (1)
    "FilterArn": ...,
}

parent.list_gateway_instances(**kwargs)

1. See ListGatewayInstancesRequestRequestTypeDef

list_gateways

Displays a list of gateways that are associated with this account.

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

# list_gateways method definition

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

1. See ListGatewaysResponseTypeDef

# list_gateways method usage example with argument unpacking

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

parent.list_gateways(**kwargs)

1. See ListGatewaysRequestRequestTypeDef

list_offerings

Displays a list of all offerings that are available to this account in the current AWS Region.

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

# list_offerings method definition

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

1. See ListOfferingsResponseTypeDef

# list_offerings method usage example with argument unpacking

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

parent.list_offerings(**kwargs)

1. See ListOfferingsRequestRequestTypeDef

list_reservations

Displays a list of all reservations that have been purchased by this account in the current AWS Region.

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

# list_reservations method definition

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

1. See ListReservationsResponseTypeDef

# list_reservations method usage example with argument unpacking

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

parent.list_reservations(**kwargs)

1. See ListReservationsRequestRequestTypeDef

list_tags_for_resource

List all tags on an AWS Elemental MediaConnect resource See also: AWS API Documentation.

Type annotations and code completion for boto3.client("mediaconnect").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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

purchase_offering

Submits a request to purchase an offering.

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

# purchase_offering method definition

def purchase_offering(
    self,
    *,
    OfferingArn: str,
    ReservationName: str,
    Start: str,
) -> PurchaseOfferingResponseTypeDef:  # (1)
    ...

1. See PurchaseOfferingResponseTypeDef

# purchase_offering method usage example with argument unpacking

kwargs: PurchaseOfferingRequestRequestTypeDef = {  # (1)
    "OfferingArn": ...,
    "ReservationName": ...,
    "Start": ...,
}

parent.purchase_offering(**kwargs)

1. See PurchaseOfferingRequestRequestTypeDef

remove_bridge_output

Removes an output from a bridge.

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

# remove_bridge_output method definition

def remove_bridge_output(
    self,
    *,
    BridgeArn: str,
    OutputName: str,
) -> RemoveBridgeOutputResponseTypeDef:  # (1)
    ...

1. See RemoveBridgeOutputResponseTypeDef

# remove_bridge_output method usage example with argument unpacking

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

parent.remove_bridge_output(**kwargs)

1. See RemoveBridgeOutputRequestRequestTypeDef

remove_bridge_source

Removes a source from a bridge.

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

# remove_bridge_source method definition

def remove_bridge_source(
    self,
    *,
    BridgeArn: str,
    SourceName: str,
) -> RemoveBridgeSourceResponseTypeDef:  # (1)
    ...

1. See RemoveBridgeSourceResponseTypeDef

# remove_bridge_source method usage example with argument unpacking

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

parent.remove_bridge_source(**kwargs)

1. See RemoveBridgeSourceRequestRequestTypeDef

remove_flow_media_stream

Removes a media stream from a flow.

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

# remove_flow_media_stream method definition

def remove_flow_media_stream(
    self,
    *,
    FlowArn: str,
    MediaStreamName: str,
) -> RemoveFlowMediaStreamResponseTypeDef:  # (1)
    ...

1. See RemoveFlowMediaStreamResponseTypeDef

# remove_flow_media_stream method usage example with argument unpacking

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

parent.remove_flow_media_stream(**kwargs)

1. See RemoveFlowMediaStreamRequestRequestTypeDef

remove_flow_output

Removes an output from an existing flow.

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

# remove_flow_output method definition

def remove_flow_output(
    self,
    *,
    FlowArn: str,
    OutputArn: str,
) -> RemoveFlowOutputResponseTypeDef:  # (1)
    ...

1. See RemoveFlowOutputResponseTypeDef

# remove_flow_output method usage example with argument unpacking

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

parent.remove_flow_output(**kwargs)

1. See RemoveFlowOutputRequestRequestTypeDef

remove_flow_source

Removes a source from an existing flow.

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

# remove_flow_source method definition

def remove_flow_source(
    self,
    *,
    FlowArn: str,
    SourceArn: str,
) -> RemoveFlowSourceResponseTypeDef:  # (1)
    ...

1. See RemoveFlowSourceResponseTypeDef

# remove_flow_source method usage example with argument unpacking

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

parent.remove_flow_source(**kwargs)

1. See RemoveFlowSourceRequestRequestTypeDef

remove_flow_vpc_interface

Removes a VPC Interface from an existing flow.

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

# remove_flow_vpc_interface method definition

def remove_flow_vpc_interface(
    self,
    *,
    FlowArn: str,
    VpcInterfaceName: str,
) -> RemoveFlowVpcInterfaceResponseTypeDef:  # (1)
    ...

1. See RemoveFlowVpcInterfaceResponseTypeDef

# remove_flow_vpc_interface method usage example with argument unpacking

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

parent.remove_flow_vpc_interface(**kwargs)

1. See RemoveFlowVpcInterfaceRequestRequestTypeDef

revoke_flow_entitlement

Revokes an entitlement from a flow.

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

# revoke_flow_entitlement method definition

def revoke_flow_entitlement(
    self,
    *,
    EntitlementArn: str,
    FlowArn: str,
) -> RevokeFlowEntitlementResponseTypeDef:  # (1)
    ...

1. See RevokeFlowEntitlementResponseTypeDef

# revoke_flow_entitlement method usage example with argument unpacking

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

parent.revoke_flow_entitlement(**kwargs)

1. See RevokeFlowEntitlementRequestRequestTypeDef

start_flow

Starts a flow.

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

# start_flow method definition

def start_flow(
    self,
    *,
    FlowArn: str,
) -> StartFlowResponseTypeDef:  # (1)
    ...

1. See StartFlowResponseTypeDef

# start_flow method usage example with argument unpacking

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

parent.start_flow(**kwargs)

1. See StartFlowRequestRequestTypeDef

stop_flow

Stops a flow.

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

# stop_flow method definition

def stop_flow(
    self,
    *,
    FlowArn: str,
) -> StopFlowResponseTypeDef:  # (1)
    ...

1. See StopFlowResponseTypeDef

# stop_flow method usage example with argument unpacking

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

parent.stop_flow(**kwargs)

1. See StopFlowRequestRequestTypeDef

tag_resource

Associates the specified tags to a resource with the specified resourceArn.

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

# tag_resource method definition

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

1. See EmptyResponseMetadataTypeDef

# tag_resource method usage example with argument unpacking

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

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Deletes specified tags from a resource.

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

# untag_resource method definition

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

1. See EmptyResponseMetadataTypeDef

# untag_resource method usage example with argument unpacking

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

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_bridge

Updates the bridge See also: AWS API Documentation.

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

# update_bridge method definition

def update_bridge(
    self,
    *,
    BridgeArn: str,
    EgressGatewayBridge: UpdateEgressGatewayBridgeRequestTypeDef = ...,  # (1)
    IngressGatewayBridge: UpdateIngressGatewayBridgeRequestTypeDef = ...,  # (2)
    SourceFailoverConfig: UpdateFailoverConfigTypeDef = ...,  # (3)
) -> UpdateBridgeResponseTypeDef:  # (4)
    ...

1. See UpdateEgressGatewayBridgeRequestTypeDef
2. See UpdateIngressGatewayBridgeRequestTypeDef
3. See UpdateFailoverConfigTypeDef
4. See UpdateBridgeResponseTypeDef

# update_bridge method usage example with argument unpacking

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

parent.update_bridge(**kwargs)

1. See UpdateBridgeRequestRequestTypeDef

update_bridge_output

Updates an existing bridge output.

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

# update_bridge_output method definition

def update_bridge_output(
    self,
    *,
    BridgeArn: str,
    OutputName: str,
    NetworkOutput: UpdateBridgeNetworkOutputRequestTypeDef = ...,  # (1)
) -> UpdateBridgeOutputResponseTypeDef:  # (2)
    ...

1. See UpdateBridgeNetworkOutputRequestTypeDef
2. See UpdateBridgeOutputResponseTypeDef

# update_bridge_output method usage example with argument unpacking

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

parent.update_bridge_output(**kwargs)

1. See UpdateBridgeOutputRequestRequestTypeDef

update_bridge_source

Updates an existing bridge source.

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

# update_bridge_source method definition

def update_bridge_source(
    self,
    *,
    BridgeArn: str,
    SourceName: str,
    FlowSource: UpdateBridgeFlowSourceRequestTypeDef = ...,  # (1)
    NetworkSource: UpdateBridgeNetworkSourceRequestTypeDef = ...,  # (2)
) -> UpdateBridgeSourceResponseTypeDef:  # (3)
    ...

1. See UpdateBridgeFlowSourceRequestTypeDef
2. See UpdateBridgeNetworkSourceRequestTypeDef
3. See UpdateBridgeSourceResponseTypeDef

# update_bridge_source method usage example with argument unpacking

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

parent.update_bridge_source(**kwargs)

1. See UpdateBridgeSourceRequestRequestTypeDef

update_bridge_state

Updates the bridge state See also: AWS API Documentation.

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

# update_bridge_state method definition

def update_bridge_state(
    self,
    *,
    BridgeArn: str,
    DesiredState: DesiredStateType,  # (1)
) -> UpdateBridgeStateResponseTypeDef:  # (2)
    ...

1. See DesiredStateType
2. See UpdateBridgeStateResponseTypeDef

# update_bridge_state method usage example with argument unpacking

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

parent.update_bridge_state(**kwargs)

1. See UpdateBridgeStateRequestRequestTypeDef

update_flow

Updates flow See also: AWS API Documentation.

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

# update_flow method definition

def update_flow(
    self,
    *,
    FlowArn: str,
    SourceFailoverConfig: UpdateFailoverConfigTypeDef = ...,  # (1)
    Maintenance: UpdateMaintenanceTypeDef = ...,  # (2)
    SourceMonitoringConfig: MonitoringConfigTypeDef = ...,  # (3)
) -> UpdateFlowResponseTypeDef:  # (4)
    ...

1. See UpdateFailoverConfigTypeDef
2. See UpdateMaintenanceTypeDef
3. See MonitoringConfigTypeDef
4. See UpdateFlowResponseTypeDef

# update_flow method usage example with argument unpacking

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

parent.update_flow(**kwargs)

1. See UpdateFlowRequestRequestTypeDef

update_flow_entitlement

You can change an entitlement's description, subscribers, and encryption.

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

# update_flow_entitlement method definition

def update_flow_entitlement(
    self,
    *,
    EntitlementArn: str,
    FlowArn: str,
    Description: str = ...,
    Encryption: UpdateEncryptionTypeDef = ...,  # (1)
    EntitlementStatus: EntitlementStatusType = ...,  # (2)
    Subscribers: Sequence[str] = ...,
) -> UpdateFlowEntitlementResponseTypeDef:  # (3)
    ...

1. See UpdateEncryptionTypeDef
2. See EntitlementStatusType
3. See UpdateFlowEntitlementResponseTypeDef

# update_flow_entitlement method usage example with argument unpacking

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

parent.update_flow_entitlement(**kwargs)

1. See UpdateFlowEntitlementRequestRequestTypeDef

update_flow_media_stream

Updates an existing media stream.

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

# update_flow_media_stream method definition

def update_flow_media_stream(
    self,
    *,
    FlowArn: str,
    MediaStreamName: str,
    Attributes: MediaStreamAttributesRequestTypeDef = ...,  # (1)
    ClockRate: int = ...,
    Description: str = ...,
    MediaStreamType: MediaStreamTypeType = ...,  # (2)
    VideoFormat: str = ...,
) -> UpdateFlowMediaStreamResponseTypeDef:  # (3)
    ...

1. See MediaStreamAttributesRequestTypeDef
2. See MediaStreamTypeType
3. See UpdateFlowMediaStreamResponseTypeDef

# update_flow_media_stream method usage example with argument unpacking

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

parent.update_flow_media_stream(**kwargs)

1. See UpdateFlowMediaStreamRequestRequestTypeDef

update_flow_output

Updates an existing flow output.

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

# update_flow_output method definition

def update_flow_output(
    self,
    *,
    FlowArn: str,
    OutputArn: str,
    CidrAllowList: Sequence[str] = ...,
    Description: str = ...,
    Destination: str = ...,
    Encryption: UpdateEncryptionTypeDef = ...,  # (1)
    MaxLatency: int = ...,
    MediaStreamOutputConfigurations: Sequence[MediaStreamOutputConfigurationRequestTypeDef] = ...,  # (2)
    MinLatency: int = ...,
    Port: int = ...,
    Protocol: ProtocolType = ...,  # (3)
    RemoteId: str = ...,
    SenderControlPort: int = ...,
    SenderIpAddress: str = ...,
    SmoothingLatency: int = ...,
    StreamId: str = ...,
    VpcInterfaceAttachment: VpcInterfaceAttachmentTypeDef = ...,  # (4)
    OutputStatus: OutputStatusType = ...,  # (5)
) -> UpdateFlowOutputResponseTypeDef:  # (6)
    ...

1. See UpdateEncryptionTypeDef
2. See MediaStreamOutputConfigurationRequestTypeDef
3. See ProtocolType
4. See VpcInterfaceAttachmentTypeDef
5. See OutputStatusType
6. See UpdateFlowOutputResponseTypeDef

# update_flow_output method usage example with argument unpacking

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

parent.update_flow_output(**kwargs)

1. See UpdateFlowOutputRequestRequestTypeDef

update_flow_source

Updates the source of a flow.

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

# update_flow_source method definition

def update_flow_source(
    self,
    *,
    FlowArn: str,
    SourceArn: str,
    Decryption: UpdateEncryptionTypeDef = ...,  # (1)
    Description: str = ...,
    EntitlementArn: str = ...,
    IngestPort: int = ...,
    MaxBitrate: int = ...,
    MaxLatency: int = ...,
    MaxSyncBuffer: int = ...,
    MediaStreamSourceConfigurations: Sequence[MediaStreamSourceConfigurationRequestTypeDef] = ...,  # (2)
    MinLatency: int = ...,
    Protocol: ProtocolType = ...,  # (3)
    SenderControlPort: int = ...,
    SenderIpAddress: str = ...,
    SourceListenerAddress: str = ...,
    SourceListenerPort: int = ...,
    StreamId: str = ...,
    VpcInterfaceName: str = ...,
    WhitelistCidr: str = ...,
    GatewayBridgeSource: UpdateGatewayBridgeSourceRequestTypeDef = ...,  # (4)
) -> UpdateFlowSourceResponseTypeDef:  # (5)
    ...

1. See UpdateEncryptionTypeDef
2. See MediaStreamSourceConfigurationRequestTypeDef
3. See ProtocolType
4. See UpdateGatewayBridgeSourceRequestTypeDef
5. See UpdateFlowSourceResponseTypeDef

# update_flow_source method usage example with argument unpacking

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

parent.update_flow_source(**kwargs)

1. See UpdateFlowSourceRequestRequestTypeDef

update_gateway_instance

Updates the configuration of an existing Gateway Instance.

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

# update_gateway_instance method definition

def update_gateway_instance(
    self,
    *,
    GatewayInstanceArn: str,
    BridgePlacement: BridgePlacementType = ...,  # (1)
) -> UpdateGatewayInstanceResponseTypeDef:  # (2)
    ...

1. See BridgePlacementType
2. See UpdateGatewayInstanceResponseTypeDef

# update_gateway_instance method usage example with argument unpacking

kwargs: UpdateGatewayInstanceRequestRequestTypeDef = {  # (1)
    "GatewayInstanceArn": ...,
}

parent.update_gateway_instance(**kwargs)

1. See UpdateGatewayInstanceRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_bridges") -> ListBridgesPaginator
• client.get_paginator("list_entitlements") -> ListEntitlementsPaginator
• client.get_paginator("list_flows") -> ListFlowsPaginator
• client.get_paginator("list_gateway_instances") -> ListGatewayInstancesPaginator
• client.get_paginator("list_gateways") -> ListGatewaysPaginator
• client.get_paginator("list_offerings") -> ListOfferingsPaginator
• client.get_paginator("list_reservations") -> ListReservationsPaginator

get_waiter

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

• client.get_waiter("flow_active") -> FlowActiveWaiter
• client.get_waiter("flow_deleted") -> FlowDeletedWaiter
• client.get_waiter("flow_standby") -> FlowStandbyWaiter