MediaPackageVodClient

Index > MediaPackageVod > MediaPackageVodClient

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

MediaPackageVodClient

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

Usage example

from boto3.session import Session
from mypy_boto3_mediapackage_vod.client import MediaPackageVodClient

def get_mediapackage-vod_client() -> MediaPackageVodClient:
    return Session().client("mediapackage-vod")

Exceptions

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

Usage example

client = boto3.client("mediapackage-vod")

try:
    do_something(client)
except (
    client.ClientError,
    client.ForbiddenException,
    client.InternalServerErrorException,
    client.NotFoundException,
    client.ServiceUnavailableException,
    client.TooManyRequestsException,
    client.UnprocessableEntityException,
) as e:
    print(e)

Type checking example

from mypy_boto3_mediapackage_vod.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-vod").can_paginate method. boto3 documentation

Method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("mediapackage-vod").close method. boto3 documentation

Method definition

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

configure_logs

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

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

Method definition

def configure_logs(
    self,
    *,
    Id: str,
    EgressAccessLogs: EgressAccessLogsTypeDef = ...,  # (1)
) -> ConfigureLogsResponseTypeDef:  # (2)
    ...

1. See EgressAccessLogsTypeDef
2. See ConfigureLogsResponseTypeDef

Usage example with kwargs

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

parent.configure_logs(**kwargs)

1. See ConfigureLogsRequestRequestTypeDef

create_asset

Creates a new MediaPackage VOD Asset resource.

Type annotations and code completion for boto3.client("mediapackage-vod").create_asset method. boto3 documentation

Method definition

def create_asset(
    self,
    *,
    Id: str,
    PackagingGroupId: str,
    SourceArn: str,
    SourceRoleArn: str,
    ResourceId: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateAssetResponseTypeDef:  # (1)
    ...

1. See CreateAssetResponseTypeDef

Usage example with kwargs

kwargs: CreateAssetRequestRequestTypeDef = {  # (1)
    "Id": ...,
    "PackagingGroupId": ...,
    "SourceArn": ...,
    "SourceRoleArn": ...,
}

parent.create_asset(**kwargs)

1. See CreateAssetRequestRequestTypeDef

create_packaging_configuration

Creates a new MediaPackage VOD PackagingConfiguration resource.

Type annotations and code completion for boto3.client("mediapackage-vod").create_packaging_configuration method. boto3 documentation

Method definition

def create_packaging_configuration(
    self,
    *,
    Id: str,
    PackagingGroupId: str,
    CmafPackage: CmafPackageTypeDef = ...,  # (1)
    DashPackage: DashPackageTypeDef = ...,  # (2)
    HlsPackage: HlsPackageTypeDef = ...,  # (3)
    MssPackage: MssPackageTypeDef = ...,  # (4)
    Tags: Mapping[str, str] = ...,
) -> CreatePackagingConfigurationResponseTypeDef:  # (5)
    ...

1. See CmafPackageTypeDef
2. See DashPackageTypeDef
3. See HlsPackageTypeDef
4. See MssPackageTypeDef
5. See CreatePackagingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.create_packaging_configuration(**kwargs)

1. See CreatePackagingConfigurationRequestRequestTypeDef

create_packaging_group

Creates a new MediaPackage VOD PackagingGroup resource.

Type annotations and code completion for boto3.client("mediapackage-vod").create_packaging_group method. boto3 documentation

Method definition

def create_packaging_group(
    self,
    *,
    Id: str,
    Authorization: AuthorizationTypeDef = ...,  # (1)
    EgressAccessLogs: EgressAccessLogsTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreatePackagingGroupResponseTypeDef:  # (3)
    ...

1. See AuthorizationTypeDef
2. See EgressAccessLogsTypeDef
3. See CreatePackagingGroupResponseTypeDef

Usage example with kwargs

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

parent.create_packaging_group(**kwargs)

1. See CreatePackagingGroupRequestRequestTypeDef

delete_asset

Deletes an existing MediaPackage VOD Asset resource.

Type annotations and code completion for boto3.client("mediapackage-vod").delete_asset method. boto3 documentation

Method definition

def delete_asset(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_asset(**kwargs)

1. See DeleteAssetRequestRequestTypeDef

delete_packaging_configuration

Deletes a MediaPackage VOD PackagingConfiguration resource.

Type annotations and code completion for boto3.client("mediapackage-vod").delete_packaging_configuration method. boto3 documentation

Method definition

def delete_packaging_configuration(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_packaging_configuration(**kwargs)

1. See DeletePackagingConfigurationRequestRequestTypeDef

delete_packaging_group

Deletes a MediaPackage VOD PackagingGroup resource.

Type annotations and code completion for boto3.client("mediapackage-vod").delete_packaging_group method. boto3 documentation

Method definition

def delete_packaging_group(
    self,
    *,
    Id: str,
) -> Dict[str, Any]:
    ...

Usage example with kwargs

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

parent.delete_packaging_group(**kwargs)

1. See DeletePackagingGroupRequestRequestTypeDef

describe_asset

Returns a description of a MediaPackage VOD Asset resource.

Type annotations and code completion for boto3.client("mediapackage-vod").describe_asset method. boto3 documentation

Method definition

def describe_asset(
    self,
    *,
    Id: str,
) -> DescribeAssetResponseTypeDef:  # (1)
    ...

1. See DescribeAssetResponseTypeDef

Usage example with kwargs

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

parent.describe_asset(**kwargs)

1. See DescribeAssetRequestRequestTypeDef

describe_packaging_configuration

Returns a description of a MediaPackage VOD PackagingConfiguration resource.

Type annotations and code completion for boto3.client("mediapackage-vod").describe_packaging_configuration method. boto3 documentation

Method definition

def describe_packaging_configuration(
    self,
    *,
    Id: str,
) -> DescribePackagingConfigurationResponseTypeDef:  # (1)
    ...

1. See DescribePackagingConfigurationResponseTypeDef

Usage example with kwargs

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

parent.describe_packaging_configuration(**kwargs)

1. See DescribePackagingConfigurationRequestRequestTypeDef

describe_packaging_group

Returns a description of a MediaPackage VOD PackagingGroup resource.

Type annotations and code completion for boto3.client("mediapackage-vod").describe_packaging_group method. boto3 documentation

Method definition

def describe_packaging_group(
    self,
    *,
    Id: str,
) -> DescribePackagingGroupResponseTypeDef:  # (1)
    ...

1. See DescribePackagingGroupResponseTypeDef

Usage example with kwargs

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

parent.describe_packaging_group(**kwargs)

1. See DescribePackagingGroupRequestRequestTypeDef

generate_presigned_url

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

Type annotations and code completion for boto3.client("mediapackage-vod").generate_presigned_url method. boto3 documentation

Method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

list_assets

Returns a collection of MediaPackage VOD Asset resources.

Type annotations and code completion for boto3.client("mediapackage-vod").list_assets method. boto3 documentation

Method definition

def list_assets(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    PackagingGroupId: str = ...,
) -> ListAssetsResponseTypeDef:  # (1)
    ...

1. See ListAssetsResponseTypeDef

Usage example with kwargs

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

parent.list_assets(**kwargs)

1. See ListAssetsRequestRequestTypeDef

list_packaging_configurations

Returns a collection of MediaPackage VOD PackagingConfiguration resources.

Type annotations and code completion for boto3.client("mediapackage-vod").list_packaging_configurations method. boto3 documentation

Method definition

def list_packaging_configurations(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
    PackagingGroupId: str = ...,
) -> ListPackagingConfigurationsResponseTypeDef:  # (1)
    ...

1. See ListPackagingConfigurationsResponseTypeDef

Usage example with kwargs

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

parent.list_packaging_configurations(**kwargs)

1. See ListPackagingConfigurationsRequestRequestTypeDef

list_packaging_groups

Returns a collection of MediaPackage VOD PackagingGroup resources.

Type annotations and code completion for boto3.client("mediapackage-vod").list_packaging_groups method. boto3 documentation

Method definition

def list_packaging_groups(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListPackagingGroupsResponseTypeDef:  # (1)
    ...

1. See ListPackagingGroupsResponseTypeDef

Usage example with kwargs

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

parent.list_packaging_groups(**kwargs)

1. See ListPackagingGroupsRequestRequestTypeDef

list_tags_for_resource

Returns a list of the tags assigned to the specified resource.

Type annotations and code completion for boto3.client("mediapackage-vod").list_tags_for_resource method. boto3 documentation

Method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

Usage example with kwargs

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

tag_resource

Adds tags to the specified resource.

Type annotations and code completion for boto3.client("mediapackage-vod").tag_resource method. boto3 documentation

Method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: TagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes tags from the specified resource.

Type annotations and code completion for boto3.client("mediapackage-vod").untag_resource method. boto3 documentation

Method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

Usage example with kwargs

kwargs: UntagResourceRequestRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_packaging_group

Updates a specific packaging group.

Type annotations and code completion for boto3.client("mediapackage-vod").update_packaging_group method. boto3 documentation

Method definition

def update_packaging_group(
    self,
    *,
    Id: str,
    Authorization: AuthorizationTypeDef = ...,  # (1)
) -> UpdatePackagingGroupResponseTypeDef:  # (2)
    ...

1. See AuthorizationTypeDef
2. See UpdatePackagingGroupResponseTypeDef

Usage example with kwargs

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

parent.update_packaging_group(**kwargs)

1. See UpdatePackagingGroupRequestRequestTypeDef

get_paginator

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

• client.get_paginator("list_assets") -> ListAssetsPaginator
• client.get_paginator("list_packaging_configurations") -> ListPackagingConfigurationsPaginator
• client.get_paginator("list_packaging_groups") -> ListPackagingGroupsPaginator