update_firewall_description async ¶

async def update_firewall_description(
    self,
    *,
    config_overrides: Optional[AsyncNetworkFirewallClientConfig] = None,
    update_token: Optional[
        "capo_network_firewall.types.update_token.UpdateToken"
    ] = None,
    firewall_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    firewall_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    description: Optional[
        "capo_network_firewall.types.description.Description"
    ] = None,
) -> "capo_network_firewall.types.update_firewall_description_response.UpdateFirewallDescriptionResponse":
    """<p>Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it. </p>

    Args:
        update_token: <p>An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request. </p> <p>To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.</p> <p>To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token. </p>
        firewall_arn: <p>The Amazon Resource Name (ARN) of the firewall.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        firewall_name: <p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
        description: <p>The new description for the firewall. If you omit this setting, Network Firewall removes the description for the firewall.</p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.invalid_token_exception.InvalidTokenException: <p>The token you provided is stale or isn't valid for the operation. </p>
        capo_network_firewall.errors.resource_not_found_exception.ResourceNotFoundException: <p>Unable to locate a resource using the parameters that you provided.</p>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_network_firewall.types.update_firewall_description_request.UpdateFirewallDescriptionRequest]",
    ) -> AsyncOperationResponse[
        "capo_network_firewall.types.update_firewall_description_response.UpdateFirewallDescriptionResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_firewall_description

        (
            output,
            http_response,
        ) = await capo_network_firewall._operations.network_firewall_20201112.update_firewall_description.async_update_firewall_description(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateFirewallDescription")
    )
    input_: capo_network_firewall.types.update_firewall_description_request.UpdateFirewallDescriptionRequest = {}
    if update_token is not None:
        input_["update_token"] = update_token
    if firewall_arn is not None:
        input_["firewall_arn"] = firewall_arn
    if firewall_name is not None:
        input_["firewall_name"] = firewall_name
    if description is not None:
        input_["description"] = description

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