Skip to content

Mediapackagev2Client#

Index > Mediapackagev2 > Mediapackagev2Client

Auto-generated documentation for Mediapackagev2 type annotations stubs module mypy-boto3-mediapackagev2.

Mediapackagev2Client#

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

# Mediapackagev2Client usage example

from boto3.session import Session
from mypy_boto3_mediapackagev2.client import Mediapackagev2Client

def get_mediapackagev2_client() -> Mediapackagev2Client:
    return Session().client("mediapackagev2")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mediapackagev2")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediapackagev2.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("mediapackagev2").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("mediapackagev2").close method. boto3 documentation

# close method definition

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

create_channel#

Create a channel to start receiving content streams.

Type annotations and code completion for boto3.client("mediapackagev2").create_channel method. boto3 documentation

# create_channel method definition

def create_channel(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    ClientToken: str = ...,
    InputType: InputTypeType = ...,  # (1)
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateChannelResponseTypeDef:  # (2)
    ...
  1. See InputTypeType
  2. See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking

kwargs: CreateChannelRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
}

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

create_channel_group#

Create a channel group to group your channels and origin endpoints.

Type annotations and code completion for boto3.client("mediapackagev2").create_channel_group method. boto3 documentation

# create_channel_group method definition

def create_channel_group(
    self,
    *,
    ChannelGroupName: str,
    ClientToken: str = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateChannelGroupResponseTypeDef:  # (1)
    ...
  1. See CreateChannelGroupResponseTypeDef
# create_channel_group method usage example with argument unpacking

kwargs: CreateChannelGroupRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
}

parent.create_channel_group(**kwargs)
  1. See CreateChannelGroupRequestRequestTypeDef

create_origin_endpoint#

The endpoint is attached to a channel, and represents the output of the live content.

Type annotations and code completion for boto3.client("mediapackagev2").create_origin_endpoint method. boto3 documentation

# create_origin_endpoint method definition

def create_origin_endpoint(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    OriginEndpointName: str,
    ContainerType: ContainerTypeType,  # (1)
    Segment: Union[SegmentTypeDef, SegmentOutputTypeDef] = ...,  # (2)
    ClientToken: str = ...,
    Description: str = ...,
    StartoverWindowSeconds: int = ...,
    HlsManifests: Sequence[CreateHlsManifestConfigurationTypeDef] = ...,  # (3)
    LowLatencyHlsManifests: Sequence[CreateLowLatencyHlsManifestConfigurationTypeDef] = ...,  # (4)
    DashManifests: Sequence[CreateDashManifestConfigurationTypeDef] = ...,  # (5)
    ForceEndpointErrorConfiguration: Union[ForceEndpointErrorConfigurationTypeDef, ForceEndpointErrorConfigurationExtraOutputTypeDef] = ...,  # (6)
    Tags: Mapping[str, str] = ...,
) -> CreateOriginEndpointResponseTypeDef:  # (7)
    ...
  1. See ContainerTypeType
  2. See SegmentTypeDef SegmentOutputTypeDef
  3. See CreateHlsManifestConfigurationTypeDef
  4. See CreateLowLatencyHlsManifestConfigurationTypeDef
  5. See CreateDashManifestConfigurationTypeDef
  6. See ForceEndpointErrorConfigurationTypeDef ForceEndpointErrorConfigurationExtraOutputTypeDef
  7. See CreateOriginEndpointResponseTypeDef
# create_origin_endpoint method usage example with argument unpacking

kwargs: CreateOriginEndpointRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
    "OriginEndpointName": ...,
    "ContainerType": ...,
}

parent.create_origin_endpoint(**kwargs)
  1. See CreateOriginEndpointRequestRequestTypeDef

delete_channel#

Delete a channel to stop AWS Elemental MediaPackage from receiving further content.

Type annotations and code completion for boto3.client("mediapackagev2").delete_channel method. boto3 documentation

# delete_channel method definition

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

kwargs: DeleteChannelRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
}

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

delete_channel_group#

Delete a channel group.

Type annotations and code completion for boto3.client("mediapackagev2").delete_channel_group method. boto3 documentation

# delete_channel_group method definition

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

kwargs: DeleteChannelGroupRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
}

parent.delete_channel_group(**kwargs)
  1. See DeleteChannelGroupRequestRequestTypeDef

delete_channel_policy#

Delete a channel policy.

Type annotations and code completion for boto3.client("mediapackagev2").delete_channel_policy method. boto3 documentation

# delete_channel_policy method definition

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

kwargs: DeleteChannelPolicyRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
}

parent.delete_channel_policy(**kwargs)
  1. See DeleteChannelPolicyRequestRequestTypeDef

delete_origin_endpoint#

Origin endpoints can serve content until they're deleted.

Type annotations and code completion for boto3.client("mediapackagev2").delete_origin_endpoint method. boto3 documentation

# delete_origin_endpoint method definition

def delete_origin_endpoint(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    OriginEndpointName: str,
) -> Dict[str, Any]:
    ...
# delete_origin_endpoint method usage example with argument unpacking

kwargs: DeleteOriginEndpointRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
    "OriginEndpointName": ...,
}

parent.delete_origin_endpoint(**kwargs)
  1. See DeleteOriginEndpointRequestRequestTypeDef

delete_origin_endpoint_policy#

Delete an origin endpoint policy.

Type annotations and code completion for boto3.client("mediapackagev2").delete_origin_endpoint_policy method. boto3 documentation

# delete_origin_endpoint_policy method definition

def delete_origin_endpoint_policy(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    OriginEndpointName: str,
) -> Dict[str, Any]:
    ...
# delete_origin_endpoint_policy method usage example with argument unpacking

kwargs: DeleteOriginEndpointPolicyRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
    "OriginEndpointName": ...,
}

parent.delete_origin_endpoint_policy(**kwargs)
  1. See DeleteOriginEndpointPolicyRequestRequestTypeDef

generate_presigned_url#

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

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

get_channel#

Retrieves the specified channel that's configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

Type annotations and code completion for boto3.client("mediapackagev2").get_channel method. boto3 documentation

# get_channel method definition

def get_channel(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
) -> GetChannelResponseTypeDef:  # (1)
    ...
  1. See GetChannelResponseTypeDef
# get_channel method usage example with argument unpacking

kwargs: GetChannelRequestRequestTypeDef = {  # (1)
    "ChannelGroupName": ...,
    "ChannelName": ...,
}

parent.get_channel(**kwargs)
  1. See GetChannelRequestRequestTypeDef

get_channel_group#

Retrieves the specified channel group that's configured in AWS Elemental MediaPackag