update_snapshot `async` ¶

update_snapshot(
    *,
    config_overrides: Optional[AsyncFSxClientConfig] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    name: Optional[SnapshotName] = None,
    snapshot_id: Optional[SnapshotId] = None,
) -> UpdateSnapshotResponse

Updates the name of an Amazon FSx for OpenZFS snapshot.

Parameters:

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

The name of the snapshot to update.
snapshot_id (Optional[SnapshotId], default: None ) –

The ID of the snapshot that you want to update, in the format fsvolsnap-0123456789abcdef0.

Raises:

BadRequest –

A generic error indicating a failure with a client request.
InternalServerError –

A generic error indicating a server-side failure.
SnapshotNotFound –

No Amazon FSx snapshots were found based on the supplied parameters.
UnknownServiceError –

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

Source code in docs_src/capo_fsx/_services/async_f_sx.py

async def update_snapshot(
    self,
    *,
    config_overrides: Optional[AsyncFSxClientConfig] = None,
    client_request_token: Optional[
        "capo_fsx.types.client_request_token.ClientRequestToken"
    ] = None,
    name: Optional["capo_fsx.types.snapshot_name.SnapshotName"] = None,
    snapshot_id: Optional["capo_fsx.types.snapshot_id.SnapshotId"] = None,
) -> "capo_fsx.types.update_snapshot_response.UpdateSnapshotResponse":
    """<p>Updates the name of an Amazon FSx for OpenZFS snapshot.</p>

    Args:
        name: <p>The name of the snapshot to update.</p>
        snapshot_id: <p>The ID of the snapshot that you want to update, in the format <code>fsvolsnap-0123456789abcdef0</code>.</p>

    Raises:
        capo_fsx.errors.bad_request.BadRequest: <p>A generic error indicating a failure with a client request.</p>
        capo_fsx.errors.internal_server_error.InternalServerError: <p>A generic error indicating a server-side failure.</p>
        capo_fsx.errors.snapshot_not_found.SnapshotNotFound: <p>No Amazon FSx snapshots were found based on the supplied parameters.</p>
        capo_fsx.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_fsx.types.update_snapshot_request.UpdateSnapshotRequest]",
    ) -> AsyncOperationResponse[
        "capo_fsx.types.update_snapshot_response.UpdateSnapshotResponse"
    ]:
        import capo_fsx._operations.aws_simba_api_service_v20180301.update_snapshot

        (
            output,
            http_response,
        ) = await capo_fsx._operations.aws_simba_api_service_v20180301.update_snapshot.async_update_snapshot(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_fsx.types.update_snapshot_response.UpdateSnapshotResponse",
    ) -> dict[str, Any]:
        import capo_fsx.types.update_snapshot_response

        return capo_fsx.types.update_snapshot_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("UpdateSnapshot", redact_output=_redact_output),
    )
    input_: capo_fsx.types.update_snapshot_request.UpdateSnapshotRequest = {}
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if name is not None:
        input_["name"] = name
    if snapshot_id is not None:
        input_["snapshot_id"] = snapshot_id

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

update_snapshot async ¶

update_snapshot `async` ¶