Skip to content

get_working_location async

get_working_location(
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    location_type: Optional[locationType] = None,
) -> GetWorkingLocationResponse

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.

Parameters:

  • location_type (Optional[locationType], default: None ) –

    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.

Raises:

Source code in docs_src/capo_finspace_data/_services/async_finspacedata.py
async def get_working_location(
    self,
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
    location_type: Optional[
        "capo_finspace_data.types.location_type.locationType"
    ] = None,
) -> "capo_finspace_data.types.get_working_location_response.GetWorkingLocationResponse":
    """<p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.</p>

    Args:
        location_type: <p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</p> </li> </ul>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_finspace_data.types.get_working_location_request.GetWorkingLocationRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace_data.types.get_working_location_response.GetWorkingLocationResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.get_working_location

        (
            output,
            http_response,
        ) = await capo_finspace_data._operations.aws_habanero_public_api.get_working_location.async_get_working_location(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetWorkingLocation")
    )
    input_: capo_finspace_data.types.get_working_location_request.GetWorkingLocationRequest = {}
    if location_type is not None:
        input_["location_type"] = location_type

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