Retrieve the list of ChannelPlacementGroups in the specified Cluster.
Parameters:
-
cluster_id
(__string)
–
-
max_results
(Optional[MaxResults], default:
None
)
–
The maximum number of items to return.
-
next_token
(Optional[__string], default:
None
)
–
The token to retrieve the next page of results.
Raises:
Source code in docs_src/capo_medialive/_services/media_live.py
| def list_channel_placement_groups(
self,
cluster_id: "capo_medialive.types.__string.__string",
*,
config_overrides: Optional[MediaLiveClientConfig] = None,
max_results: Optional["capo_medialive.types.max_results.MaxResults"] = None,
next_token: Optional["capo_medialive.types.__string.__string"] = None,
) -> "capo_medialive.types.list_channel_placement_groups_response.ListChannelPlacementGroupsResponse":
"""Retrieve the list of ChannelPlacementGroups in the specified Cluster.
Args:
cluster_id: The ID of the cluster
max_results: The maximum number of items to return.
next_token: The token to retrieve the next page of results.
Raises:
capo_medialive.errors.bad_gateway_exception.BadGatewayException: Placeholder documentation for BadGatewayException
capo_medialive.errors.bad_request_exception.BadRequestException: Placeholder documentation for BadRequestException
capo_medialive.errors.forbidden_exception.ForbiddenException: Placeholder documentation for ForbiddenException
capo_medialive.errors.gateway_timeout_exception.GatewayTimeoutException: Placeholder documentation for GatewayTimeoutException
capo_medialive.errors.internal_server_error_exception.InternalServerErrorException: Placeholder documentation for InternalServerErrorException
capo_medialive.errors.too_many_requests_exception.TooManyRequestsException: Placeholder documentation for TooManyRequestsException
capo_medialive.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_medialive.types.list_channel_placement_groups_request.ListChannelPlacementGroupsRequest]",
) -> OperationResponse[
"capo_medialive.types.list_channel_placement_groups_response.ListChannelPlacementGroupsResponse"
]:
import capo_medialive._operations.media_live.list_channel_placement_groups
output, http_response = (
capo_medialive._operations.media_live.list_channel_placement_groups.list_channel_placement_groups(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListChannelPlacementGroups")
)
input_: capo_medialive.types.list_channel_placement_groups_request.ListChannelPlacementGroupsRequest = {
"cluster_id": cluster_id
}
if max_results is not None:
input_["max_results"] = max_results
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|