MediaPackageClient

Index > MediaPackage > MediaPackageClient

Auto-generated documentation for MediaPackage type annotations stubs module types-aiobotocore-mediapackage.

MediaPackageClient

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

Usage example

from aioboto3.session import Session
from types_aiobotocore_mediapackage.client import MediaPackageClient

session = Session()
async with session.client("mediapackage") as client:
    client: MediaPackageClient

Exceptions

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

Usage example

async with session.client("mediapackage") as client:
    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 types_aiobotocore_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 session.client("mediapackage").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 session.client("mediapackage").close method. boto3 documentation

Method definition

await 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 session.client("mediapackage").configure_logs method. boto3 documentation

Method definition

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

1. See EgressAccessLogsTypeDef
2. See IngressAccessLogsTypeDef
3. See ConfigureLogsResponseTypeDef

Usage example with kwargs

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

parent.configure_logs(**kwargs)

1. See ConfigureLogsRequestRequestTypeDef

create_channel

Creates a new Channel.

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

Method definition

await def create_channel(
    self,
    *,
    Id: str,
    Description: str = ...,
    Tags: Mapping[str, str] = ...,
) -> CreateChannelResponseTypeDef:  # (1)
    ...

1. See CreateChannelResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").create_harvest_job method. boto3 documentation

Method definition

await def create_harvest_job(
    self,
    *,
    EndTime: str,
    Id: str,
    OriginEndpointId: str,
    S3Destination: S3DestinationTypeDef,  # (1)
    StartTime: str,
) -> CreateHarvestJobResponseTypeDef:  # (2)
    ...

1. See S3DestinationTypeDef
2. See CreateHarvestJobResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").create_origin_endpoint method. boto3 documentation

Method definition

await 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

Usage example with kwargs

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 session.client("mediapackage").delete_channel method. boto3 documentation

Method definition

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

Usage example with kwargs

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

parent.delete_channel(**kwargs)

1. See DeleteChannelRequestRequestTypeDef

delete_origin_endpoint

Deletes an existing OriginEndpoint.

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

Method definition

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

Usage example with kwargs

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 session.client("mediapackage").describe_channel method. boto3 documentation

Method definition

await def describe_channel(
    self,
    *,
    Id: str,
) -> DescribeChannelResponseTypeDef:  # (1)
    ...

1. See DescribeChannelResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").describe_harvest_job method. boto3 documentation

Method definition

await def describe_harvest_job(
    self,
    *,
    Id: str,
) -> DescribeHarvestJobResponseTypeDef:  # (1)
    ...

1. See DescribeHarvestJobResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").describe_origin_endpoint method. boto3 documentation

Method definition

await def describe_origin_endpoint(
    self,
    *,
    Id: str,
) -> DescribeOriginEndpointResponseTypeDef:  # (1)
    ...

1. See DescribeOriginEndpointResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").generate_presigned_url method. boto3 documentation

Method definition

await 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 session.client("mediapackage").list_channels method. boto3 documentation

Method definition

await def list_channels(
    self,
    *,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListChannelsResponseTypeDef:  # (1)
    ...

1. See ListChannelsResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").list_harvest_jobs method. boto3 documentation

Method definition

await def list_harvest_jobs(
    self,
    *,
    IncludeChannelId: str = ...,
    IncludeStatus: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListHarvestJobsResponseTypeDef:  # (1)
    ...

1. See ListHarvestJobsResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").list_origin_endpoints method. boto3 documentation

Method definition

await def list_origin_endpoints(
    self,
    *,
    ChannelId: str = ...,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListOriginEndpointsResponseTypeDef:  # (1)
    ...

1. See ListOriginEndpointsResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").list_tags_for_resource method. boto3 documentation

Method definition

await 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

rotate_channel_credentials

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

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

Method definition

await def rotate_channel_credentials(
    self,
    *,
    Id: str,
) -> RotateChannelCredentialsResponseTypeDef:  # (1)
    ...

1. See RotateChannelCredentialsResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").rotate_ingest_endpoint_credentials method. boto3 documentation

Method definition

await def rotate_ingest_endpoint_credentials(
    self,
    *,
    Id: str,
    IngestEndpointId: str,
) -> RotateIngestEndpointCredentialsResponseTypeDef:  # (1)
    ...

1. See RotateIngestEndpointCredentialsResponseTypeDef

Usage example with kwargs

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 session.client("mediapackage").tag_resource method. boto3 documentation

Method definition

await 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

See also: AWS API Documentation.

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

Method definition

await 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_channel

Updates an existing Channel.

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

Method definition

await def update_channel(
    self,
    *,
    Id: str,
    Description: str = ...,
) -> UpdateChannelResponseTypeDef:  # (1)
    ...

1. See UpdateChannelResponseTypeDef

Usage example with kwargs

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

parent.update_channel(**kwargs)

1. See UpdateChannelRequestRequestTypeDef

update_origin_endpoint

Updates an existing OriginEndpoint.

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

Method definition

await 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

Usage example with kwargs

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

parent.update_origin_endpoint(**kwargs)

1. See UpdateOriginEndpointRequestRequestTypeDef

__aenter__

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

Method definition

await def __aenter__(
    self,
) -> MediaPackageClient:
    ...

__aexit__

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

Method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

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

• client.get_paginator("list_channels") -> ListChannelsPaginator
• client.get_paginator("list_harvest_jobs") -> ListHarvestJobsPaginator
• client.get_paginator("list_origin_endpoints") -> ListOriginEndpointsPaginator