Skip to content

list_snapshots

list_snapshots(
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    namespace_name: Optional[str] = None,
    namespace_arn: Optional[str] = None,
    owner_account: Optional[str] = None,
    start_time: Optional[datetime] = None,
    end_time: Optional[datetime] = None,
) -> ListSnapshotsResponse

Returns a list of snapshots.

Parameters:

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

    If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

  • max_results (Optional[int], default: None ) –

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.

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

    The namespace from which to list all snapshots.

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

    The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.

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

    The owner Amazon Web Services account of the snapshot.

  • start_time (Optional[datetime], default: None ) –

    The time when the creation of the snapshot was initiated.

  • end_time (Optional[datetime], default: None ) –

    The timestamp showing when the snapshot creation finished.

Raises:

Source code in docs_src/capo_redshift_serverless/_services/redshift_serverless.py
def list_snapshots(
    self,
    *,
    config_overrides: Optional[RedshiftServerlessClientConfig] = None,
    next_token: Optional[str] = None,
    max_results: Optional[int] = None,
    namespace_name: Optional[str] = None,
    namespace_arn: Optional[str] = None,
    owner_account: Optional[str] = None,
    start_time: Optional[datetime.datetime] = None,
    end_time: Optional[datetime.datetime] = None,
) -> "capo_redshift_serverless.types.list_snapshots_response.ListSnapshotsResponse":
    """<p>Returns a list of snapshots.</p>

    Args:
        next_token: <p>If <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.</p>
        max_results: <p>An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to display the next page of results.</p>
        namespace_name: <p>The namespace from which to list all snapshots.</p>
        namespace_arn: <p>The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.</p>
        owner_account: <p>The owner Amazon Web Services account of the snapshot.</p>
        start_time: <p>The time when the creation of the snapshot was initiated.</p>
        end_time: <p>The timestamp showing when the snapshot creation finished.</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.list_snapshots_request.ListSnapshotsRequest]",
    ) -> OperationResponse[
        "capo_redshift_serverless.types.list_snapshots_response.ListSnapshotsResponse"
    ]:
        import capo_redshift_serverless._operations.redshift_serverless.list_snapshots

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSnapshots")
    )
    input_: capo_redshift_serverless.types.list_snapshots_request.ListSnapshotsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if namespace_name is not None:
        input_["namespace_name"] = namespace_name
    if namespace_arn is not None:
        input_["namespace_arn"] = namespace_arn
    if owner_account is not None:
        input_["owner_account"] = owner_account
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time

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