delete_game_session_queue `async` ¶

delete_game_session_queue(
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    name: Optional[GameSessionQueueNameOrArn] = None,
) -> DeleteGameSessionQueueOutput

This API works with the following fleet types: EC2, Anywhere, Container

Deletes a game session queue. Once a queue is successfully deleted, unfulfilled StartGameSessionPlacement requests that reference the queue will fail. To delete a queue, specify the queue name.

Parameters:

name (Optional[GameSessionQueueNameOrArn], default: None ) –

A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN value.

Raises:

InternalServiceException –

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
InvalidRequestException –

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
NotFoundException –

The requested resource was not found. The resource was either not created yet or deleted.
TaggingFailedException –

The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.
UnauthorizedException –

The client failed authentication. Clients should not retry such requests.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_gamelift/_services/async_game_lift.py

async def delete_game_session_queue(
    self,
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    name: Optional[
        "capo_gamelift.types.game_session_queue_name_or_arn.GameSessionQueueNameOrArn"
    ] = None,
) -> "capo_gamelift.types.delete_game_session_queue_output.DeleteGameSessionQueueOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To delete a queue, specify the queue name.</p>

    Args:
        name: <p>A descriptive label that is associated with game session queue. Queue names must be unique within each Region. You can use either the queue ID or ARN 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.tagging_failed_exception.TaggingFailedException: <p>The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue before retrying.</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.delete_game_session_queue_input.DeleteGameSessionQueueInput]",
    ) -> AsyncOperationResponse[
        "capo_gamelift.types.delete_game_session_queue_output.DeleteGameSessionQueueOutput"
    ]:
        import capo_gamelift._operations.game_lift.delete_game_session_queue

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteGameSessionQueue")
    )
    input_: capo_gamelift.types.delete_game_session_queue_input.DeleteGameSessionQueueInput = {}
    if name is not None:
        input_["name"] = name

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

delete_game_session_queue async ¶

delete_game_session_queue `async` ¶