Returns a list of media pipelines.
Parameters:
-
next_token
(Optional[String], default:
None
)
–
The token used to retrieve the next page of results.
-
max_results
(Optional[ResultMax], default:
None
)
–
The maximum number of results to return in a single call. Valid Range: 1 - 99.
Raises:
Source code in docs_src/capo_chime_sdk_media_pipelines/_services/chime_sdk_media_pipelines.py
| def list_media_pipelines(
self,
*,
config_overrides: Optional[ChimeSDKMediaPipelinesClientConfig] = None,
next_token: Optional[
"capo_chime_sdk_media_pipelines.types.string.String"
] = None,
max_results: Optional[
"capo_chime_sdk_media_pipelines.types.result_max.ResultMax"
] = None,
) -> "capo_chime_sdk_media_pipelines.types.list_media_pipelines_response.ListMediaPipelinesResponse":
"""<p>Returns a list of media pipelines.</p>
Args:
next_token: <p>The token used to retrieve the next page of results.</p>
max_results: <p>The maximum number of results to return in a single call. Valid Range: 1 - 99.</p>
Raises:
capo_chime_sdk_media_pipelines.errors.bad_request_exception.BadRequestException: <p>The input parameters don't match the service's restrictions.</p>
capo_chime_sdk_media_pipelines.errors.forbidden_exception.ForbiddenException: <p>The client is permanently forbidden from making the request.</p>
capo_chime_sdk_media_pipelines.errors.resource_limit_exceeded_exception.ResourceLimitExceededException: <p>The request exceeds the resource limit.</p>
capo_chime_sdk_media_pipelines.errors.service_failure_exception.ServiceFailureException: <p>The service encountered an unexpected error.</p>
capo_chime_sdk_media_pipelines.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
capo_chime_sdk_media_pipelines.errors.throttled_client_exception.ThrottledClientException: <p>The client exceeded its request rate limit.</p>
capo_chime_sdk_media_pipelines.errors.unauthorized_client_exception.UnauthorizedClientException: <p>The client is not currently authorized to make the request.</p>
capo_chime_sdk_media_pipelines.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_chime_sdk_media_pipelines.types.list_media_pipelines_request.ListMediaPipelinesRequest]",
) -> OperationResponse[
"capo_chime_sdk_media_pipelines.types.list_media_pipelines_response.ListMediaPipelinesResponse"
]:
import capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.list_media_pipelines
output, http_response = (
capo_chime_sdk_media_pipelines._operations.chime_sdk_media_pipelines_service.list_media_pipelines.list_media_pipelines(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListMediaPipelines")
)
input_: capo_chime_sdk_media_pipelines.types.list_media_pipelines_request.ListMediaPipelinesRequest = {}
if next_token is not None:
input_["next_token"] = next_token
if max_results is not None:
input_["max_results"] = max_results
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|