describe_game_session_queues async ¶

async def describe_game_session_queues(
    self,
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    names: Optional[
        "capo_gamelift.types.game_session_queue_name_or_arn_list.GameSessionQueueNameOrArnList"
    ] = None,
    limit: Optional["capo_gamelift.types.positive_integer.PositiveInteger"] = None,
    next_token: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
) -> "capo_gamelift.types.describe_game_session_queues_output.DescribeGameSessionQueuesOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>Retrieves the properties for one or more game session queues. When requesting multiple queues, use the pagination parameters to retrieve results as a set of sequential pages. When specifying a list of queues, objects are returned only for queues that currently exist in the Region.</p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html"> View Your Queues</a> </p>

    Args:
        names: <p>A list of queue names to retrieve information for. You can use either the queue ID or ARN value. To request settings for all queues, leave this parameter empty. </p>
        limit: <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages. You can request up to 50 results.</p>
        next_token: <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.not_found_exception.NotFoundException: <p>The requested resource was not found. The resource was either not created yet or deleted.</p>
        capo_gamelift.errors.unauthorized_exception.UnauthorizedException: <p>The client failed authentication. Clients should not retry such requests.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_gamelift.types.describe_game_session_queues_input.DescribeGameSessionQueuesInput]",
    ) -> AsyncOperationResponse[
        "capo_gamelift.types.describe_game_session_queues_output.DescribeGameSessionQueuesOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_game_session_queues

        (
            output,
            http_response,
        ) = await capo_gamelift._operations.game_lift.describe_game_session_queues.async_describe_game_session_queues(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_gamelift.types.describe_game_session_queues_output.DescribeGameSessionQueuesOutput",
    ) -> dict[str, Any]:
        import capo_gamelift.types.describe_game_session_queues_output

        return capo_gamelift.types.describe_game_session_queues_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeGameSessionQueues", redact_output=_redact_output),
    )
    input_: capo_gamelift.types.describe_game_session_queues_input.DescribeGameSessionQueuesInput = {}
    if names is not None:
        input_["names"] = names
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output