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
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.
client = boto3.client("mediaconnect")
try:
do_something(client)
except (
client.AddFlowOutputs420Exception,
client.BadRequestException,
client.ClientError,
client.CreateFlow420Exception,
client.ForbiddenException,
client.GrantFlowEntitlements420Exception,
client.InternalServerErrorException,
client.NotFoundException,
client.ServiceUnavailableException,
client.TooManyRequestsException,
) as e:
print(e)
from mypy_boto3_mediaconnect.client import Exceptions
def handle_error(exc: Exceptions.AddFlowOutputs420Exception) -> None:
...
Methods
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
def add_flow_media_streams(
self,
*,
FlowArn: str,
MediaStreams: Sequence[AddMediaStreamRequestTypeDef], # (1)
) -> AddFlowMediaStreamsResponseTypeDef: # (2)
...
kwargs: AddFlowMediaStreamsRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"MediaStreams": ...,
}
parent.add_flow_media_streams(**kwargs)
add_flow_outputs
Adds outputs to an existing flow.
Type annotations and code completion for boto3.client("mediaconnect").add_flow_outputs
method.
boto3 documentation
def add_flow_outputs(
self,
*,
FlowArn: str,
Outputs: Sequence[AddOutputRequestTypeDef], # (1)
) -> AddFlowOutputsResponseTypeDef: # (2)
...
kwargs: AddFlowOutputsRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"Outputs": ...,
}
parent.add_flow_outputs(**kwargs)
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
def add_flow_sources(
self,
*,
FlowArn: str,
Sources: Sequence[SetSourceRequestTypeDef], # (1)
) -> AddFlowSourcesResponseTypeDef: # (2)
...
kwargs: AddFlowSourcesRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"Sources": ...,
}
parent.add_flow_sources(**kwargs)
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
def add_flow_vpc_interfaces(
self,
*,
FlowArn: str,
VpcInterfaces: Sequence[VpcInterfaceRequestTypeDef], # (1)
) -> AddFlowVpcInterfacesResponseTypeDef: # (2)
...
kwargs: AddFlowVpcInterfacesRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"VpcInterfaces": ...,
}
parent.add_flow_vpc_interfaces(**kwargs)
can_paginate
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("mediaconnect").can_paginate
method.
boto3 documentation
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("mediaconnect").close
method.
boto3 documentation
create_flow
Creates a new flow.
Type annotations and code completion for boto3.client("mediaconnect").create_flow
method.
boto3 documentation
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)
...
- See GrantEntitlementRequestTypeDef
- See AddMediaStreamRequestTypeDef
- See AddOutputRequestTypeDef
- See SetSourceRequestTypeDef
- See FailoverConfigTypeDef
- See SetSourceRequestTypeDef
- See VpcInterfaceRequestTypeDef
- See AddMaintenanceTypeDef
- See CreateFlowResponseTypeDef
kwargs: CreateFlowRequestRequestTypeDef = { # (1)
"Name": ...,
}
parent.create_flow(**kwargs)
delete_flow
Deletes a flow.
Type annotations and code completion for boto3.client("mediaconnect").delete_flow
method.
boto3 documentation
kwargs: DeleteFlowRequestRequestTypeDef = { # (1)
"FlowArn": ...,
}
parent.delete_flow(**kwargs)
describe_flow
Displays the details of a flow.
Type annotations and code completion for boto3.client("mediaconnect").describe_flow
method.
boto3 documentation
def describe_flow(
self,
*,
FlowArn: str,
) -> DescribeFlowResponseTypeDef: # (1)
...
kwargs: DescribeFlowRequestRequestTypeDef = { # (1)
"FlowArn": ...,
}
parent.describe_flow(**kwargs)
describe_offering
Displays the details of an offering.
Type annotations and code completion for boto3.client("mediaconnect").describe_offering
method.
boto3 documentation
def describe_offering(
self,
*,
OfferingArn: str,
) -> DescribeOfferingResponseTypeDef: # (1)
...
kwargs: DescribeOfferingRequestRequestTypeDef = { # (1)
"OfferingArn": ...,
}
parent.describe_offering(**kwargs)
describe_reservation
Displays the details of a reservation.
Type annotations and code completion for boto3.client("mediaconnect").describe_reservation
method.
boto3 documentation
def describe_reservation(
self,
*,
ReservationArn: str,
) -> DescribeReservationResponseTypeDef: # (1)
...
kwargs: DescribeReservationRequestRequestTypeDef = { # (1)
"ReservationArn": ...,
}
parent.describe_reservation(**kwargs)
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
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
def grant_flow_entitlements(
self,
*,
Entitlements: Sequence[GrantEntitlementRequestTypeDef], # (1)
FlowArn: str,
) -> GrantFlowEntitlementsResponseTypeDef: # (2)
...
kwargs: GrantFlowEntitlementsRequestRequestTypeDef = { # (1)
"Entitlements": ...,
"FlowArn": ...,
}
parent.grant_flow_entitlements(**kwargs)
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
def list_entitlements(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListEntitlementsResponseTypeDef: # (1)
...
kwargs: ListEntitlementsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_entitlements(**kwargs)
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
def list_flows(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListFlowsResponseTypeDef: # (1)
...
kwargs: ListFlowsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_flows(**kwargs)
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
def list_offerings(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOfferingsResponseTypeDef: # (1)
...
kwargs: ListOfferingsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_offerings(**kwargs)
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
def list_reservations(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListReservationsResponseTypeDef: # (1)
...
kwargs: ListReservationsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_reservations(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
purchase_offering
Submits a request to purchase an offering.
Type annotations and code completion for boto3.client("mediaconnect").purchase_offering
method.
boto3 documentation
def purchase_offering(
self,
*,
OfferingArn: str,
ReservationName: str,
Start: str,
) -> PurchaseOfferingResponseTypeDef: # (1)
...
kwargs: PurchaseOfferingRequestRequestTypeDef = { # (1)
"OfferingArn": ...,
"ReservationName": ...,
"Start": ...,
}
parent.purchase_offering(**kwargs)
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
def remove_flow_media_stream(
self,
*,
FlowArn: str,
MediaStreamName: str,
) -> RemoveFlowMediaStreamResponseTypeDef: # (1)
...
kwargs: RemoveFlowMediaStreamRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"MediaStreamName": ...,
}
parent.remove_flow_media_stream(**kwargs)
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
def remove_flow_output(
self,
*,
FlowArn: str,
OutputArn: str,
) -> RemoveFlowOutputResponseTypeDef: # (1)
...
kwargs: RemoveFlowOutputRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"OutputArn": ...,
}
parent.remove_flow_output(**kwargs)
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
def remove_flow_source(
self,
*,
FlowArn: str,
SourceArn: str,
) -> RemoveFlowSourceResponseTypeDef: # (1)
...
kwargs: RemoveFlowSourceRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"SourceArn": ...,
}
parent.remove_flow_source(**kwargs)
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
def remove_flow_vpc_interface(
self,
*,
FlowArn: str,
VpcInterfaceName: str,
) -> RemoveFlowVpcInterfaceResponseTypeDef: # (1)
...
kwargs: RemoveFlowVpcInterfaceRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"VpcInterfaceName": ...,
}
parent.remove_flow_vpc_interface(**kwargs)
revoke_flow_entitlement
Revokes an entitlement from a flow.
Type annotations and code completion for boto3.client("mediaconnect").revoke_flow_entitlement
method.
boto3 documentation
def revoke_flow_entitlement(
self,
*,
EntitlementArn: str,
FlowArn: str,
) -> RevokeFlowEntitlementResponseTypeDef: # (1)
...
kwargs: RevokeFlowEntitlementRequestRequestTypeDef = { # (1)
"EntitlementArn": ...,
"FlowArn": ...,
}
parent.revoke_flow_entitlement(**kwargs)
start_flow
Starts a flow.
Type annotations and code completion for boto3.client("mediaconnect").start_flow
method.
boto3 documentation
kwargs: StartFlowRequestRequestTypeDef = { # (1)
"FlowArn": ...,
}
parent.start_flow(**kwargs)
stop_flow
Stops a flow.
Type annotations and code completion for boto3.client("mediaconnect").stop_flow
method.
boto3 documentation
kwargs: StopFlowRequestRequestTypeDef = { # (1)
"FlowArn": ...,
}
parent.stop_flow(**kwargs)
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
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
Deletes specified tags from a resource.
Type annotations and code completion for boto3.client("mediaconnect").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_flow
Updates flow See also: AWS API Documentation.
Type annotations and code completion for boto3.client("mediaconnect").update_flow
method.
boto3 documentation
def update_flow(
self,
*,
FlowArn: str,
SourceFailoverConfig: UpdateFailoverConfigTypeDef = ..., # (1)
Maintenance: UpdateMaintenanceTypeDef = ..., # (2)
) -> UpdateFlowResponseTypeDef: # (3)
...
kwargs: UpdateFlowRequestRequestTypeDef = { # (1)
"FlowArn": ...,
}
parent.update_flow(**kwargs)
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
def update_flow_entitlement(
self,
*,
EntitlementArn: str,
FlowArn: str,
Description: str = ...,
Encryption: UpdateEncryptionTypeDef = ..., # (1)
EntitlementStatus: EntitlementStatusType = ..., # (2)
Subscribers: Sequence[str] = ...,
) -> UpdateFlowEntitlementResponseTypeDef: # (3)
...
kwargs: UpdateFlowEntitlementRequestRequestTypeDef = { # (1)
"EntitlementArn": ...,
"FlowArn": ...,
}
parent.update_flow_entitlement(**kwargs)
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
def update_flow_media_stream(
self,
*,
FlowArn: str,
MediaStreamName: str,
Attributes: MediaStreamAttributesRequestTypeDef = ..., # (1)
ClockRate: int = ...,
Description: str = ...,
MediaStreamType: MediaStreamTypeType = ..., # (2)
VideoFormat: str = ...,
) -> UpdateFlowMediaStreamResponseTypeDef: # (3)
...
- See MediaStreamAttributesRequestTypeDef
- See MediaStreamTypeType
- See UpdateFlowMediaStreamResponseTypeDef
kwargs: UpdateFlowMediaStreamRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"MediaStreamName": ...,
}
parent.update_flow_media_stream(**kwargs)
update_flow_output
Updates an existing flow output.
Type annotations and code completion for boto3.client("mediaconnect").update_flow_output
method.
boto3 documentation
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)
) -> UpdateFlowOutputResponseTypeDef: # (5)
...
- See UpdateEncryptionTypeDef
- See MediaStreamOutputConfigurationRequestTypeDef
- See ProtocolType
- See VpcInterfaceAttachmentTypeDef
- See UpdateFlowOutputResponseTypeDef
kwargs: UpdateFlowOutputRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"OutputArn": ...,
}
parent.update_flow_output(**kwargs)
update_flow_source
Updates the source of a flow.
Type annotations and code completion for boto3.client("mediaconnect").update_flow_source
method.
boto3 documentation
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 = ...,
) -> UpdateFlowSourceResponseTypeDef: # (4)
...
- See UpdateEncryptionTypeDef
- See MediaStreamSourceConfigurationRequestTypeDef
- See ProtocolType
- See UpdateFlowSourceResponseTypeDef
kwargs: UpdateFlowSourceRequestRequestTypeDef = { # (1)
"FlowArn": ...,
"SourceArn": ...,
}
parent.update_flow_source(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("mediaconnect").get_paginator
method with overloads.
client.get_paginator("list_entitlements")
-> ListEntitlementsPaginatorclient.get_paginator("list_flows")
-> ListFlowsPaginatorclient.get_paginator("list_offerings")
-> ListOfferingsPaginatorclient.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")
-> FlowActiveWaiterclient.get_waiter("flow_deleted")
-> FlowDeletedWaiterclient.get_waiter("flow_standby")
-> FlowStandbyWaiter