list_stream_groups ¶

def list_stream_groups(
    self,
    *,
    config_overrides: Optional[GameLiftStreamsClientConfig] = None,
    next_token: Optional["capo_gameliftstreams.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_gameliftstreams.types.max_results.MaxResults"
    ] = None,
) -> "capo_gameliftstreams.types.list_stream_groups_output.ListStreamGroupsOutput":
    """<p>Retrieves a list of all Amazon GameLift Streams stream groups that are associated with the Amazon Web Services account in use. This operation returns stream groups in all statuses, in no particular order. You can paginate the results as needed.</p>

    Args:
        next_token: <p>A token that marks the start of the next set of results. Use this token when you retrieve results as sequential pages. To get the first page of results, omit a token value. To get the remaining pages, provide the token returned with the previous result set. </p>
        max_results: <p>The number of results to return. Use this parameter with <code>NextToken</code> to return results in sequential pages. Default value is <code>25</code>.</p>

    Raises:
        capo_gameliftstreams.errors.access_denied_exception.AccessDeniedException: <p>You don't have the required permissions to access this Amazon GameLift Streams resource. Correct the permissions before you try again.</p>
        capo_gameliftstreams.errors.internal_server_exception.InternalServerException: <p>The service encountered an internal error and is unable to complete the request.</p>
        capo_gameliftstreams.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling. Retry the request after the suggested wait time.</p>
        capo_gameliftstreams.errors.validation_exception.ValidationException: <p>One or more parameter values in the request fail to satisfy the specified constraints. Correct the invalid parameter values before retrying the request.</p>
        capo_gameliftstreams.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_gameliftstreams.types.list_stream_groups_input.ListStreamGroupsInput]",
    ) -> OperationResponse[
        "capo_gameliftstreams.types.list_stream_groups_output.ListStreamGroupsOutput"
    ]:
        import capo_gameliftstreams._operations.game_lift_streams.list_stream_groups

        output, http_response = (
            capo_gameliftstreams._operations.game_lift_streams.list_stream_groups.list_stream_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListStreamGroups")
    )
    input_: capo_gameliftstreams.types.list_stream_groups_input.ListStreamGroupsInput = {}
    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