Skip to content

get_snapshot

get_snapshot(
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    snapshot_name: Optional[str] = None,
    owner_account: Optional[str] = None,
    snapshot_arn: Optional[str] = None,
) -> GetSnapshotResponse

Returns information about a specific snapshot.

Parameters:

  • snapshot_name (Optional[str], default: None ) –

    The name of the snapshot to return.

  • owner_account (Optional[str], default: None ) –

    The owner Amazon Web Services account of a snapshot shared with another user.

  • snapshot_arn (Optional[str], default: None ) –

    The Amazon Resource Name (ARN) of the snapshot to return.

Raises:

Source code in docs_src/capo_redshift_serverless/_services/redshift_serverless.py
def get_snapshot(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    snapshot_name: Optional[str] = None,
    owner_account: Optional[str] = None,
    snapshot_arn: Optional[str] = None,
) -> "capo_redshift_serverless.types.get_snapshot_response.GetSnapshotResponse":
    """<p>Returns information about a specific snapshot.</p>

    Args:
        snapshot_name: <p>The name of the snapshot to return.</p>
        owner_account: <p>The owner Amazon Web Services account of a snapshot shared with another user.</p>
        snapshot_arn: <p>The Amazon Resource Name (ARN) of the snapshot to return.</p>

    Raises:
        capo_redshift_serverless.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_redshift_serverless.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_redshift_serverless.errors.validation_exception.ValidationException: <p>The input failed to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_redshift_serverless.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_redshift_serverless.types.get_snapshot_request.GetSnapshotRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.get_snapshot_response.GetSnapshotResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.get_snapshot

        output, http_response = (
            capo_redshift_serverless._operations.redshift_serverless.get_snapshot.get_snapshot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetSnapshot")
    )
    input_: capo_redshift_serverless.types.get_snapshot_request.GetSnapshotRequest = {}
    if snapshot_name is not None:
        input_["snapshot_name"] = snapshot_name
    if owner_account is not None:
        input_["owner_account"] = owner_account
    if snapshot_arn is not None:
        input_["snapshot_arn"] = snapshot_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output