Skip to content

describe_workspace_snapshots

describe_workspace_snapshots(
    workspace_id: WorkspaceId,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> DescribeWorkspaceSnapshotsResult

Describes the snapshots for the specified WorkSpace.

Parameters:

  • workspace_id (WorkspaceId) –

    The identifier of the WorkSpace.

Raises:

Source code in docs_src/capo_workspaces/_services/work_spaces.py
def describe_workspace_snapshots(
    self,
    workspace_id: "capo_workspaces.types.workspace_id.WorkspaceId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
) -> "capo_workspaces.types.describe_workspace_snapshots_result.DescribeWorkspaceSnapshotsResult":
    """<p>Describes the snapshots for the specified WorkSpace.</p>

    Args:
        workspace_id: <p>The identifier of the WorkSpace.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.describe_workspace_snapshots_request.DescribeWorkspaceSnapshotsRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.describe_workspace_snapshots_result.DescribeWorkspaceSnapshotsResult"
    ]:
        import capo_workspaces._operations.workspaces_service.describe_workspace_snapshots

        output, http_response = (
            capo_workspaces._operations.workspaces_service.describe_workspace_snapshots.describe_workspace_snapshots(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeWorkspaceSnapshots")
    )
    input_: capo_workspaces.types.describe_workspace_snapshots_request.DescribeWorkspaceSnapshotsRequest = {
        "workspace_id": workspace_id
    }

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