Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.
Parameters:
-
filter_by
(Optional[StreamFilters], default:
None
)
–
Filters the stream list to match the specified criterion.
-
next_token
(Optional[PaginationToken], default:
None
)
–
The first stream to retrieve. This is used for pagination; see the nextToken response field.
-
max_results
(Optional[MaxStreamResults], default:
None
)
–
Maximum number of streams to return. Default: 100.
Raises:
Source code in docs_src/capo_ivs/_services/ivs.py
| def list_streams(
self,
*,
config_overrides: Optional[ivsClientConfig] = None,
filter_by: Optional["capo_ivs.types.stream_filters.StreamFilters"] = None,
next_token: Optional["capo_ivs.types.pagination_token.PaginationToken"] = None,
max_results: Optional[
"capo_ivs.types.max_stream_results.MaxStreamResults"
] = None,
) -> "capo_ivs.types.list_streams_response.ListStreamsResponse":
"""<p>Gets summary information about live streams in your account, in the Amazon Web Services region where the API request is processed.</p>
Args:
filter_by: <p>Filters the stream list to match the specified criterion.</p>
next_token: <p>The first stream to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
max_results: <p>Maximum number of streams to return. Default: 100.</p>
Raises:
capo_ivs.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
capo_ivs.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
capo_ivs.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_ivs.types.list_streams_request.ListStreamsRequest]",
) -> OperationResponse[
"capo_ivs.types.list_streams_response.ListStreamsResponse"
]:
import capo_ivs._operations.amazon_interactive_video_service.list_streams
output, http_response = (
capo_ivs._operations.amazon_interactive_video_service.list_streams.list_streams(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("ListStreams")
)
input_: capo_ivs.types.list_streams_request.ListStreamsRequest = {}
if filter_by is not None:
input_["filter_by"] = filter_by
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
|