delete_alias `async` ¶

delete_alias(
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    alias_id: Optional[AliasIdOrArn] = None,
) -> None

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

Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.

Related actions

All APIs by task

Parameters:

alias_id (Optional[AliasIdOrArn], default: None ) –

A unique identifier of the alias that you want to delete. You can use either the alias 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_alias(
    self,
    *,
    config_overrides: Optional[AsyncGameLiftClientConfig] = None,
    alias_id: Optional["capo_gamelift.types.alias_id_or_arn.AliasIdOrArn"] = None,
) -> None:
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>Deletes an alias. This operation removes all record of the alias. Game clients attempting to access a server process using the deleted alias receive an error. To delete an alias, specify the alias ID to be deleted.</p> <p> <b>Related actions</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a> </p>

    Args:
        alias_id: <p>A unique identifier of the alias that you want to delete. You can use either the alias 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_alias_input.DeleteAliasInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_gamelift._operations.game_lift.delete_alias

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteAlias")
    )
    input_: capo_gamelift.types.delete_alias_input.DeleteAliasInput = {}
    if alias_id is not None:
        input_["alias_id"] = alias_id

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

delete_alias async ¶

delete_alias `async` ¶