Mediapackagev2Client#
Index > Mediapackagev2 > Mediapackagev2Client
Auto-generated documentation for Mediapackagev2 type annotations stubs module types-boto3-mediapackagev2.
Mediapackagev2Client#
Type annotations and code completion for boto3.client("mediapackagev2")
.
boto3 documentation
# Mediapackagev2Client usage example
from boto3.session import Session
from types_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 types_boto3_mediapackagev2.client import Exceptions
def handle_error(exc: Exceptions.AccessDeniedException) -> None:
...
Methods#
can_paginate#
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:
...
generate_presigned_url#
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:
...
cancel_harvest_job#
Cancels an in-progress harvest job.
Type annotations and code completion for boto3.client("mediapackagev2").cancel_harvest_job
method.
boto3 documentation
# cancel_harvest_job method definition
def cancel_harvest_job(
self,
*,
ChannelGroupName: str,
ChannelName: str,
OriginEndpointName: str,
HarvestJobName: str,
ETag: str = ...,
) -> dict[str, Any]:
...
# cancel_harvest_job method usage example with argument unpacking
kwargs: CancelHarvestJobRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
"HarvestJobName": ...,
}
parent.cancel_harvest_job(**kwargs)
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 = ...,
InputSwitchConfiguration: InputSwitchConfigurationTypeDef = ..., # (2)
OutputHeaderConfiguration: OutputHeaderConfigurationTypeDef = ..., # (3)
Tags: Mapping[str, str] = ...,
) -> CreateChannelResponseTypeDef: # (4)
...
- See InputTypeType
- See InputSwitchConfigurationTypeDef
- See OutputHeaderConfigurationTypeDef
- See CreateChannelResponseTypeDef
# create_channel method usage example with argument unpacking
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
}
parent.create_channel(**kwargs)
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)
...
# create_channel_group method usage example with argument unpacking
kwargs: CreateChannelGroupRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
}
parent.create_channel_group(**kwargs)
create_harvest_job#
Creates a new harvest job to export content from a MediaPackage v2 channel to an S3 bucket.
Type annotations and code completion for boto3.client("mediapackagev2").create_harvest_job
method.
boto3 documentation
# create_harvest_job method definition
def create_harvest_job(
self,
*,
ChannelGroupName: str,
ChannelName: str,
OriginEndpointName: str,
HarvestedManifests: HarvestedManifestsTypeDef, # (1)
ScheduleConfiguration: HarvesterScheduleConfigurationTypeDef, # (2)
Destination: DestinationTypeDef, # (3)
Description: str = ...,
ClientToken: str = ...,
HarvestJobName: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateHarvestJobResponseTypeDef: # (4)
...
- See HarvestedManifestsTypeDef
- See HarvesterScheduleConfigurationTypeDef
- See DestinationTypeDef
- See CreateHarvestJobResponseTypeDef
# create_harvest_job method usage example with argument unpacking
kwargs: CreateHarvestJobRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
"HarvestedManifests": ...,
"ScheduleConfiguration": ...,
"Destination": ...,
}
parent.create_harvest_job(**kwargs)
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: SegmentTypeDef = ..., # (2)
ClientToken: str = ...,
Description: str = ...,
StartoverWindowSeconds: int = ...,
HlsManifests: Sequence[CreateHlsManifestConfigurationTypeDef] = ..., # (3)
LowLatencyHlsManifests: Sequence[CreateLowLatencyHlsManifestConfigurationTypeDef] = ..., # (4)
DashManifests: Sequence[CreateDashManifestConfigurationTypeDef] = ..., # (5)
ForceEndpointErrorConfiguration: ForceEndpointErrorConfigurationTypeDef = ..., # (6)
Tags: Mapping[str, str] = ...,
) -> CreateOriginEndpointResponseTypeDef: # (7)
...
- See ContainerTypeType
- See SegmentTypeDef
- See CreateHlsManifestConfigurationTypeDef
- See CreateLowLatencyHlsManifestConfigurationTypeDef
- See CreateDashManifestConfigurationTypeDef
- See ForceEndpointErrorConfigurationTypeDef
- See CreateOriginEndpointResponseTypeDef
# create_origin_endpoint method usage example with argument unpacking
kwargs: CreateOriginEndpointRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
"ContainerType": ...,
}
parent.create_origin_endpoint(**kwargs)
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)
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)
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)
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)
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)
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)
...
# get_channel method usage example with argument unpacking
kwargs: GetChannelRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
}
parent.get_channel(**kwargs)
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)
...
# get_channel_group method usage example with argument unpacking
kwargs: GetChannelGroupRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
}
parent.get_channel_group(**kwargs)
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)
...
# get_channel_policy method usage example with argument unpacking
kwargs: GetChannelPolicyRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
}
parent.get_channel_policy(**kwargs)
get_harvest_job#
Retrieves the details of a specific harvest job.
Type annotations and code completion for boto3.client("mediapackagev2").get_harvest_job
method.
boto3 documentation
# get_harvest_job method definition
def get_harvest_job(
self,
*,
ChannelGroupName: str,
ChannelName: str,
OriginEndpointName: str,
HarvestJobName: str,
) -> GetHarvestJobResponseTypeDef: # (1)
...
# get_harvest_job method usage example with argument unpacking
kwargs: GetHarvestJobRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
"HarvestJobName": ...,
}
parent.get_harvest_job(**kwargs)
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)
...
# get_origin_endpoint method usage example with argument unpacking
kwargs: GetOriginEndpointRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
}
parent.get_origin_endpoint(**kwargs)
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)
...
# get_origin_endpoint_policy method usage example with argument unpacking
kwargs: GetOriginEndpointPolicyRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
}
parent.get_origin_endpoint_policy(**kwargs)
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)
...
# list_channel_groups method usage example with argument unpacking
kwargs: ListChannelGroupsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_channel_groups(**kwargs)
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)
...
# list_channels method usage example with argument unpacking
kwargs: ListChannelsRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
}
parent.list_channels(**kwargs)
list_harvest_jobs#
Retrieves a list of harvest jobs that match the specified criteria.
Type annotations and code completion for boto3.client("mediapackagev2").list_harvest_jobs
method.
boto3 documentation
# list_harvest_jobs method definition
def list_harvest_jobs(
self,
*,
ChannelGroupName: str,
ChannelName: str = ...,
OriginEndpointName: str = ...,
Status: HarvestJobStatusType = ..., # (1)
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHarvestJobsResponseTypeDef: # (2)
...
# list_harvest_jobs method usage example with argument unpacking
kwargs: ListHarvestJobsRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
}
parent.list_harvest_jobs(**kwargs)
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)
...
# list_origin_endpoints method usage example with argument unpacking
kwargs: ListOriginEndpointsRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
}
parent.list_origin_endpoints(**kwargs)
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)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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)
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)
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)
...
# tag_resource method usage example with argument unpacking
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
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)
...
# untag_resource method usage example with argument unpacking
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
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 = ...,
InputSwitchConfiguration: InputSwitchConfigurationTypeDef = ..., # (1)
OutputHeaderConfiguration: OutputHeaderConfigurationTypeDef = ..., # (2)
) -> UpdateChannelResponseTypeDef: # (3)
...
- See InputSwitchConfigurationTypeDef
- See OutputHeaderConfigurationTypeDef
- See UpdateChannelResponseTypeDef
# update_channel method usage example with argument unpacking
kwargs: UpdateChannelRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
}
parent.update_channel(**kwargs)
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)
...
# update_channel_group method usage example with argument unpacking
kwargs: UpdateChannelGroupRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
}
parent.update_channel_group(**kwargs)
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: SegmentTypeDef = ..., # (2)
Description: str = ...,
StartoverWindowSeconds: int = ...,
HlsManifests: Sequence[CreateHlsManifestConfigurationTypeDef] = ..., # (3)
LowLatencyHlsManifests: Sequence[CreateLowLatencyHlsManifestConfigurationTypeDef] = ..., # (4)
DashManifests: Sequence[CreateDashManifestConfigurationTypeDef] = ..., # (5)
ForceEndpointErrorConfiguration: ForceEndpointErrorConfigurationTypeDef = ..., # (6)
ETag: str = ...,
) -> UpdateOriginEndpointResponseTypeDef: # (7)
...
- See ContainerTypeType
- See SegmentTypeDef
- See CreateHlsManifestConfigurationTypeDef
- See CreateLowLatencyHlsManifestConfigurationTypeDef
- See CreateDashManifestConfigurationTypeDef
- See ForceEndpointErrorConfigurationTypeDef
- See UpdateOriginEndpointResponseTypeDef
# update_origin_endpoint method usage example with argument unpacking
kwargs: UpdateOriginEndpointRequestRequestTypeDef = { # (1)
"ChannelGroupName": ...,
"ChannelName": ...,
"OriginEndpointName": ...,
"ContainerType": ...,
}
parent.update_origin_endpoint(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("mediapackagev2").get_paginator
method with overloads.
client.get_paginator("list_channel_groups")
-> ListChannelGroupsPaginatorclient.get_paginator("list_channels")
-> ListChannelsPaginatorclient.get_paginator("list_harvest_jobs")
-> ListHarvestJobsPaginatorclient.get_paginator("list_origin_endpoints")
-> ListOriginEndpointsPaginator
get_waiter#
Type annotations and code completion for boto3.client("mediapackagev2").get_waiter
method with overloads.
client.get_waiter("harvest_job_finished")
-> HarvestJobFinishedWaiter