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
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.
client = boto3.client("mediapackage")
try:
do_something(client)
except (
client.ClientError,
client.ForbiddenException,
client.InternalServerErrorException,
client.NotFoundException,
client.ServiceUnavailableException,
client.TooManyRequestsException,
client.UnprocessableEntityException,
) as e:
print(e)
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
close
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("mediapackage").close
method.
boto3 documentation
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
def configure_logs(
self,
*,
Id: str,
EgressAccessLogs: EgressAccessLogsTypeDef = ..., # (1)
IngressAccessLogs: IngressAccessLogsTypeDef = ..., # (2)
) -> ConfigureLogsResponseTypeDef: # (3)
...
kwargs: ConfigureLogsRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.configure_logs(**kwargs)
create_channel
Creates a new Channel.
Type annotations and code completion for boto3.client("mediapackage").create_channel
method.
boto3 documentation
def create_channel(
self,
*,
Id: str,
Description: str = ...,
Tags: Mapping[str, str] = ...,
) -> CreateChannelResponseTypeDef: # (1)
...
kwargs: CreateChannelRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.create_channel(**kwargs)
create_harvest_job
Creates a new HarvestJob record.
Type annotations and code completion for boto3.client("mediapackage").create_harvest_job
method.
boto3 documentation
def create_harvest_job(
self,
*,
EndTime: str,
Id: str,
OriginEndpointId: str,
S3Destination: S3DestinationTypeDef, # (1)
StartTime: str,
) -> CreateHarvestJobResponseTypeDef: # (2)
...
kwargs: CreateHarvestJobRequestRequestTypeDef = { # (1)
"EndTime": ...,
"Id": ...,
"OriginEndpointId": ...,
"S3Destination": ...,
"StartTime": ...,
}
parent.create_harvest_job(**kwargs)
create_origin_endpoint
Creates a new OriginEndpoint record.
Type annotations and code completion for boto3.client("mediapackage").create_origin_endpoint
method.
boto3 documentation
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)
...
- See AuthorizationTypeDef
- See CmafPackageCreateOrUpdateParametersTypeDef
- See DashPackageTypeDef
- See HlsPackageTypeDef
- See MssPackageTypeDef
- See OriginationType
- See CreateOriginEndpointResponseTypeDef
kwargs: CreateOriginEndpointRequestRequestTypeDef = { # (1)
"ChannelId": ...,
"Id": ...,
}
parent.create_origin_endpoint(**kwargs)
delete_channel
Deletes an existing Channel.
Type annotations and code completion for boto3.client("mediapackage").delete_channel
method.
boto3 documentation
kwargs: DeleteChannelRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_channel(**kwargs)
delete_origin_endpoint
Deletes an existing OriginEndpoint.
Type annotations and code completion for boto3.client("mediapackage").delete_origin_endpoint
method.
boto3 documentation
kwargs: DeleteOriginEndpointRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.delete_origin_endpoint(**kwargs)
describe_channel
Gets details about a Channel.
Type annotations and code completion for boto3.client("mediapackage").describe_channel
method.
boto3 documentation
def describe_channel(
self,
*,
Id: str,
) -> DescribeChannelResponseTypeDef: # (1)
...
kwargs: DescribeChannelRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_channel(**kwargs)
describe_harvest_job
Gets details about an existing HarvestJob.
Type annotations and code completion for boto3.client("mediapackage").describe_harvest_job
method.
boto3 documentation
def describe_harvest_job(
self,
*,
Id: str,
) -> DescribeHarvestJobResponseTypeDef: # (1)
...
kwargs: DescribeHarvestJobRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_harvest_job(**kwargs)
describe_origin_endpoint
Gets details about an existing OriginEndpoint.
Type annotations and code completion for boto3.client("mediapackage").describe_origin_endpoint
method.
boto3 documentation
def describe_origin_endpoint(
self,
*,
Id: str,
) -> DescribeOriginEndpointResponseTypeDef: # (1)
...
kwargs: DescribeOriginEndpointRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.describe_origin_endpoint(**kwargs)
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
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
def list_channels(
self,
*,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListChannelsResponseTypeDef: # (1)
...
kwargs: ListChannelsRequestRequestTypeDef = { # (1)
"MaxResults": ...,
}
parent.list_channels(**kwargs)
list_harvest_jobs
Returns a collection of HarvestJob records.
Type annotations and code completion for boto3.client("mediapackage").list_harvest_jobs
method.
boto3 documentation
def list_harvest_jobs(
self,
*,
IncludeChannelId: str = ...,
IncludeStatus: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListHarvestJobsResponseTypeDef: # (1)
...
kwargs: ListHarvestJobsRequestRequestTypeDef = { # (1)
"IncludeChannelId": ...,
}
parent.list_harvest_jobs(**kwargs)
list_origin_endpoints
Returns a collection of OriginEndpoint records.
Type annotations and code completion for boto3.client("mediapackage").list_origin_endpoints
method.
boto3 documentation
def list_origin_endpoints(
self,
*,
ChannelId: str = ...,
MaxResults: int = ...,
NextToken: str = ...,
) -> ListOriginEndpointsResponseTypeDef: # (1)
...
kwargs: ListOriginEndpointsRequestRequestTypeDef = { # (1)
"ChannelId": ...,
}
parent.list_origin_endpoints(**kwargs)
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
def list_tags_for_resource(
self,
*,
ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef: # (1)
...
kwargs: ListTagsForResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
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
def rotate_channel_credentials(
self,
*,
Id: str,
) -> RotateChannelCredentialsResponseTypeDef: # (1)
...
kwargs: RotateChannelCredentialsRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.rotate_channel_credentials(**kwargs)
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
def rotate_ingest_endpoint_credentials(
self,
*,
Id: str,
IngestEndpointId: str,
) -> RotateIngestEndpointCredentialsResponseTypeDef: # (1)
...
kwargs: RotateIngestEndpointCredentialsRequestRequestTypeDef = { # (1)
"Id": ...,
"IngestEndpointId": ...,
}
parent.rotate_ingest_endpoint_credentials(**kwargs)
tag_resource
See also: AWS API Documentation.
Type annotations and code completion for boto3.client("mediapackage").tag_resource
method.
boto3 documentation
def tag_resource(
self,
*,
ResourceArn: str,
Tags: Mapping[str, str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: TagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"Tags": ...,
}
parent.tag_resource(**kwargs)
untag_resource
See also: AWS API Documentation.
Type annotations and code completion for boto3.client("mediapackage").untag_resource
method.
boto3 documentation
def untag_resource(
self,
*,
ResourceArn: str,
TagKeys: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...
kwargs: UntagResourceRequestRequestTypeDef = { # (1)
"ResourceArn": ...,
"TagKeys": ...,
}
parent.untag_resource(**kwargs)
update_channel
Updates an existing Channel.
Type annotations and code completion for boto3.client("mediapackage").update_channel
method.
boto3 documentation
def update_channel(
self,
*,
Id: str,
Description: str = ...,
) -> UpdateChannelResponseTypeDef: # (1)
...
kwargs: UpdateChannelRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_channel(**kwargs)
update_origin_endpoint
Updates an existing OriginEndpoint.
Type annotations and code completion for boto3.client("mediapackage").update_origin_endpoint
method.
boto3 documentation
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)
...
- See AuthorizationTypeDef
- See CmafPackageCreateOrUpdateParametersTypeDef
- See DashPackageTypeDef
- See HlsPackageTypeDef
- See MssPackageTypeDef
- See OriginationType
- See UpdateOriginEndpointResponseTypeDef
kwargs: UpdateOriginEndpointRequestRequestTypeDef = { # (1)
"Id": ...,
}
parent.update_origin_endpoint(**kwargs)
get_paginator
Type annotations and code completion for boto3.client("mediapackage").get_paginator
method with overloads.
client.get_paginator("list_channels")
-> ListChannelsPaginatorclient.get_paginator("list_harvest_jobs")
-> ListHarvestJobsPaginatorclient.get_paginator("list_origin_endpoints")
-> ListOriginEndpointsPaginator