GetWorkingLocation -

GetWorkingLocation

A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in Habanero notebook.

Request Syntax

POST /workingLocationV1 HTTP/1.1 Content-type: application/json { "locationType": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

locationType

Specify the type of the working location.

  • SAGEMAKER - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.

  • INGESTION - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the changeset creation operation.

Type: String

Valid Values: INGESTION | SAGEMAKER

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "s3Bucket": "string", "s3Path": "string", "s3Uri": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

s3Bucket

Returns the Amazon S3 bucket name for the working location.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: .*\S.*

s3Path

Returns the Amazon S3 Path for the working location.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

s3Uri

Returns the Amazon S3 URI for the working location.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .*\S.*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: