Skip to content

MediaPackageClient#

Index > MediaPackage > MediaPackageClient

Auto-generated documentation for MediaPackage type annotations stubs module mypy-boto3-mediapackage.

MediaPackageClient#

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

# MediaPackageClient usage example

from boto3.session import Session
from mypy_boto3_mediapackage.client import MediaPackageClient

def get_mediapackage_client() -> MediaPackageClient:
    return Session().client("mediapackage")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("mediapackage")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.ForbiddenException,
    client.exceptions.InternalServerErrorException,
    client.exceptions.NotFoundException,
    client.exceptions.ServiceUnavailableException,
    client.exceptions.TooManyRequestsException,
    client.exceptions.UnprocessableEntityException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_mediapackage.client import Exceptions

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

Methods#

can_paginate#

Check if an operation can be paginated.

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

# close method definition

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

configure_logs#

Changes the Channel's properities to configure log subscription See also: AWS API Documentation.

Type annotations and code completion for boto3.client("mediapackage").configure_logs method. boto3 documentation

# configure_logs method definition

def configure_logs(
    self,
    *,
    Id: str,
    EgressAccessLogs: EgressAccessLogsTypeDef = ...,  # (1)
    IngressAccessLogs: IngressAccessLogsTypeDef = ...,  # (2)
) -> ConfigureLogsResponseTypeDef:  # (3)
    ...
  1. See EgressAccessLogsTypeDef
  2. See IngressAccessLogsTypeDef
  3. See ConfigureLogsResponseTypeDef 
# configure_logs method usage example with argument unpacking

kwargs: ConfigureLogsRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.configure_logs(**kwargs)
  1. See ConfigureLogsRequestRequestTypeDef

create_channel#

Creates a new Channel.

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

# create_channel method definition

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

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

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

create_harvest_job#

Creates a new HarvestJob record.

Type annotations and code completion for boto3.client("mediapackage").create_harvest_job method. boto3 documentation

# create_harvest_job method definition

def create_harvest_job(
    self,
    *,
    EndTime: str,
    Id: str,
    OriginEndpointId: str,
    S3Destination: S3DestinationTypeDef,  # (1)
    StartTime: str,
) -> CreateHarvestJobResponseTypeDef:  # (2)
    ...
  1. See S3DestinationTypeDef
  2. See CreateHarvestJobResponseTypeDef 
# create_harvest_job method usage example with argument unpacking

kwargs: CreateHarvestJobRequestRequestTypeDef = {  # (1)
    "EndTime": ...,
    "Id": ...,
    "OriginEndpointId": ...,
    "S3Destination": ...,
    "StartTime": ...,
}

parent.create_harvest_job(**kwargs)
  1. See CreateHarvestJobRequestRequestTypeDef

create_origin_endpoint#

Creates a new OriginEndpoint record.

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

# create_origin_endpoint method definition

def create_origin_endpoint(
    self,
    *,
    ChannelId: str,
    Id: str,
    Authorization: AuthorizationTypeDef = ...,  # (1)
    CmafPackage: CmafPackageCreateOrUpdateParametersTypeDef = ...,  # (2)
    DashPackage: DashPackageTypeDef = ...,  # (3)
    Description: str = ...,
    HlsPackage: HlsPackageTypeDef = ...,  # (4)
    ManifestName: str = ...,
    MssPackage: MssPackageTypeDef = ...,  # (5)
    Origination: OriginationType = ...,  # (6)
    StartoverWindowSeconds: int = ...,
    Tags: Mapping[str, str] = ...,
    TimeDelaySeconds: int = ...,
    Whitelist: Sequence[str] = ...,
) -> CreateOriginEndpointResponseTypeDef:  # (7)
    ...
  1. See AuthorizationTypeDef
  2. See CmafPackageCreateOrUpdateParametersTypeDef
  3. See DashPackageTypeDef
  4. See HlsPackageTypeDef
  5. See MssPackageTypeDef
  6. See OriginationType
  7. See CreateOriginEndpointResponseTypeDef 
# create_origin_endpoint method usage example with argument unpacking

kwargs: CreateOriginEndpointRequestRequestTypeDef = {  # (1)
    "ChannelId": ...,
    "Id": ...,
}

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

delete_channel#

Deletes an existing Channel.

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

# delete_channel method definition

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

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

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

delete_origin_endpoint#

Deletes an existing OriginEndpoint.

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

# delete_origin_endpoint method definition

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

kwargs: DeleteOriginEndpointRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

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

describe_channel#

Gets details about a Channel.

Type annotations and code completion for boto3.client("mediapackage").describe_channel method. boto3 documentation

# describe_channel method definition

def describe_channel(
    self,
    *,
    Id: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...
  1. See DescribeChannelResponseTypeDef 
# describe_channel method usage example with argument unpacking

kwargs: DescribeChannelRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_channel(**kwargs)
  1. See DescribeChannelRequestRequestTypeDef

describe_harvest_job#

Gets details about an existing HarvestJob.

Type annotations and code completion for boto3.client("mediapackage").describe_harvest_job method. boto3 documentation

# describe_harvest_job method definition

def describe_harvest_job(
    self,
    *,
    Id: str,
) -> DescribeHarvestJobResponseTypeDef:  # (1)
    ...
  1. See DescribeHarvestJobResponseTypeDef 
# describe_harvest_job method usage example with argument unpacking

kwargs: DescribeHarvestJobRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_harvest_job(**kwargs)
  1. See DescribeHarvestJobRequestRequestTypeDef

describe_origin_endpoint#

Gets details about an existing OriginEndpoint.

Type annotations and code completion for boto3.client("mediapackage").describe_origin_endpoint method. boto3 documentation

# describe_origin_endpoint method definition

def describe_origin_endpoint(
    self,
    *,
    Id: str,
) -> DescribeOriginEndpointResponseTypeDef:  # (1)
    ...
  1. See DescribeOriginEndpointResponseTypeDef 
# describe_origin_endpoint method usage example with argument unpacking

kwargs: DescribeOriginEndpointRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.describe_origin_endpoint(**kwargs)
  1. See DescribeOriginEndpointRequestRequestTypeDef

generate_presigned_url#

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

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

list_channels#

Returns a collection of Channels.

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

# list_channels method definition

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

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

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

list_harvest_jobs#

Returns a collection of HarvestJob records.

Type annotations and code completion for boto3.client("mediapackage").list_harvest_jobs method. boto3 documentation

# list_harvest_jobs method definition

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

kwargs: ListHarvestJobsRequestRequestTypeDef = {  # (1)
    "IncludeChannelId": ...,
}

parent.list_harvest_jobs(**kwargs)
  1. See ListHarvestJobsRequestRequestTypeDef

list_origin_endpoints#

Returns a collection of OriginEndpoint records.

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

# list_origin_endpoints method definition

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

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

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

list_tags_for_resource#

See also: AWS API Documentation.

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

rotate_channel_credentials#

Changes the Channel's first IngestEndpoint's username and password.

Type annotations and code completion for boto3.client("mediapackage").rotate_channel_credentials method. boto3 documentation

# rotate_channel_credentials method definition

def rotate_channel_credentials(
    self,
    *,
    Id: str,
) -> RotateChannelCredentialsResponseTypeDef:  # (1)
    ...
  1. See RotateChannelCredentialsResponseTypeDef 
# rotate_channel_credentials method usage example with argument unpacking

kwargs: RotateChannelCredentialsRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.rotate_channel_credentials(**kwargs)
  1. See RotateChannelCredentialsRequestRequestTypeDef

rotate_ingest_endpoint_credentials#

Rotate the IngestEndpoint's username and password, as specified by the IngestEndpoint's id.

Type annotations and code completion for boto3.client("mediapackage").rotate_ingest_endpoint_credentials method. boto3 documentation

# rotate_ingest_endpoint_credentials method definition

def rotate_ingest_endpoint_credentials(
    self,
    *,
    Id: str,
    IngestEndpointId: str,
) -> RotateIngestEndpointCredentialsResponseTypeDef:  # (1)
    ...
  1. See RotateIngestEndpointCredentialsResponseTypeDef 
# rotate_ingest_endpoint_credentials method usage example with argument unpacking

kwargs: RotateIngestEndpointCredentialsRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "IngestEndpointId": ...,
}

parent.rotate_ingest_endpoint_credentials(**kwargs)
  1. See RotateIngestEndpointCredentialsRequestRequestTypeDef

tag_resource#

See also: AWS API Documentation.

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

See also: AWS API Documentation.

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

Updates an existing Channel.

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

# update_channel method definition

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

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

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

update_origin_endpoint#

Updates an existing OriginEndpoint.

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

# update_origin_endpoint method definition

def update_origin_endpoint(
    self,
    *,
    Id: str,
    Authorization: AuthorizationTypeDef = ...,  # (1)
    CmafPackage: CmafPackageCreateOrUpdateParametersTypeDef = ...,  # (2)
    DashPackage: DashPackageTypeDef = ...,  # (3)
    Description: str = ...,
    HlsPackage: HlsPackageTypeDef = ...,  # (4)
    ManifestName: str = ...,
    MssPackage: MssPackageTypeDef = ...,  # (5)
    Origination: OriginationType = ...,  # (6)
    StartoverWindowSeconds: int = ...,
    TimeDelaySeconds: int = ...,
    Whitelist: Sequence[str] = ...,
) -> UpdateOriginEndpointResponseTypeDef:  # (7)
    ...
  1. See AuthorizationTypeDef
  2. See CmafPackageCreateOrUpdateParametersTypeDef
  3. See DashPackageTypeDef
  4. See HlsPackageTypeDef
  5. See MssPackageTypeDef
  6. See OriginationType
  7. See UpdateOriginEndpointResponseTypeDef 
# update_origin_endpoint method usage example with argument unpacking

kwargs: UpdateOriginEndpointRequestRequestTypeDef = {  # (1)
    "Id": ...,
}

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

get_paginator#

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