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 = ...,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateChannelResponseTypeDef:  # (1)
    ...
  1. 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)
    Tags: Mapping[str, str] = ...,
) -> CreateOriginEndpointResponseTypeDef:  # (6)
    ...
  1. See ContainerTypeType
  2. See SegmentTypeDef SegmentOutputTypeDef
  3. See CreateHlsManifestConfigurationTypeDef
  4. See CreateLowLatencyHlsManifestConfigurationTypeDef
  5. See CreateDashManifestConfigurationTypeDef
  6. 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 MediaPackage, including the channels and origin endpoints that are associated with it.

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

# get_channel_group method definition

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

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

parent.get_channel_group(**kwargs)
  1. See GetChannelGroupRequestRequestTypeDef

get_channel_policy#

Retrieves the specified channel policy that's configured in AWS Elemental MediaPackage.

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

# get_channel_policy method definition

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

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

parent.get_channel_policy(**kwargs)
  1. See GetChannelPolicyRequestRequestTypeDef

get_origin_endpoint#

Retrieves the specified origin endpoint that's configured in AWS Elemental MediaPackage to obtain its playback URL and to view the packaging settings that it's currently using.

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

# get_origin_endpoint method definition

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

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

parent.get_origin_endpoint(**kwargs)
  1. See GetOriginEndpointRequestRequestTypeDef

get_origin_endpoint_policy#

Retrieves the specified origin endpoint policy that's configured in AWS Elemental MediaPackage.

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

# get_origin_endpoint_policy method definition

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

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

parent.get_origin_endpoint_policy(**kwargs)
  1. See GetOriginEndpointPolicyRequestRequestTypeDef

list_channel_groups#

Retrieves all channel groups that are configured in AWS Elemental MediaPackage, including the channels and origin endpoints that are associated with it.

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

# list_channel_groups method definition

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

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

parent.list_channel_groups(**kwargs)
  1. See ListChannelGroupsRequestRequestTypeDef

list_channels#

Retrieves all channels in a specific channel group that are configured in AWS Elemental MediaPackage, including the origin endpoints that are associated with it.

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

# list_channels method definition

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

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

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

list_origin_endpoints#

Retrieves all origin endpoints in a specific channel that are configured in AWS Elemental MediaPackage.

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

# list_origin_endpoints method definition

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

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

parent.list_origin_endpoints(**kwargs)
  1. See ListOriginEndpointsRequestRequestTypeDef

list_tags_for_resource#

Lists the tags assigned to a resource.

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

put_channel_policy#

Attaches an IAM policy to the specified channel.

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

# put_channel_policy method definition

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

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

parent.put_channel_policy(**kwargs)
  1. See PutChannelPolicyRequestRequestTypeDef

put_origin_endpoint_policy#

Attaches an IAM policy to the specified origin endpoint.

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

# put_origin_endpoint_policy method definition

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

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

parent.put_origin_endpoint_policy(**kwargs)
  1. See PutOriginEndpointPolicyRequestRequestTypeDef

tag_resource#

Assigns one of more tags (key-value pairs) to the specified MediaPackage resource.

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

Removes one or more tags from the specified resource.

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

Update the specified channel.

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

# update_channel method definition

def update_channel(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    ETag: str = ...,
    Description: str = ...,
) -> UpdateChannelResponseTypeDef:  # (1)
    ...
  1. See UpdateChannelResponseTypeDef 
# update_channel method usage example with argument unpacking

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

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

update_channel_group#

Update the specified channel group.

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

# update_channel_group method definition

def update_channel_group(
    self,
    *,
    ChannelGroupName: str,
    ETag: str = ...,
    Description: str = ...,
) -> UpdateChannelGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateChannelGroupResponseTypeDef 
# update_channel_group method usage example with argument unpacking

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

parent.update_channel_group(**kwargs)
  1. See UpdateChannelGroupRequestRequestTypeDef

update_origin_endpoint#

Update the specified origin endpoint.

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

# update_origin_endpoint method definition

def update_origin_endpoint(
    self,
    *,
    ChannelGroupName: str,
    ChannelName: str,
    OriginEndpointName: str,
    ContainerType: ContainerTypeType,  # (1)
    Segment: Union[SegmentTypeDef, SegmentOutputTypeDef] = ...,  # (2)
    Description: str = ...,
    StartoverWindowSeconds: int = ...,
    HlsManifests: Sequence[CreateHlsManifestConfigurationTypeDef] = ...,  # (3)
    LowLatencyHlsManifests: Sequence[CreateLowLatencyHlsManifestConfigurationTypeDef] = ...,  # (4)
    DashManifests: Sequence[CreateDashManifestConfigurationTypeDef] = ...,  # (5)
    ETag: str = ...,
) -> UpdateOriginEndpointResponseTypeDef:  # (6)
    ...
  1. See ContainerTypeType
  2. See SegmentTypeDef SegmentOutputTypeDef
  3. See CreateHlsManifestConfigurationTypeDef
  4. See CreateLowLatencyHlsManifestConfigurationTypeDef
  5. See CreateDashManifestConfigurationTypeDef
  6. See UpdateOriginEndpointResponseTypeDef 
# update_origin_endpoint method usage example with argument unpacking

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

parent.update_origin_endpoint(**kwargs)
  1. See UpdateOriginEndpointRequestRequestTypeDef

get_paginator#

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