Skip to content

get_external_data_view_access_details async

get_external_data_view_access_details(
    data_view_id: DataViewId,
    dataset_id: DatasetId,
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
) -> GetExternalDataViewAccessDetailsResponse

Returns the credentials to access the external Dataview from an S3 location. To call this API:

  • You must retrieve the programmatic credentials.

  • You must be a member of a FinSpace user group, where the dataset that you want to access has Read Dataset Data permissions.

Parameters:

  • data_view_id (DataViewId) –

    The unique identifier for the Dataview that you want to access.

  • dataset_id (DatasetId) –

    The unique identifier for the Dataset.

Raises:

Source code in docs_src/capo_finspace_data/_services/async_finspacedata.py
async def get_external_data_view_access_details(
    self,
    data_view_id: "capo_finspace_data.types.data_view_id.DataViewId",
    dataset_id: "capo_finspace_data.types.dataset_id.DatasetId",
    *,
    config_overrides: Optional[AsyncfinspacedataClientConfig] = None,
) -> "capo_finspace_data.types.get_external_data_view_access_details_response.GetExternalDataViewAccessDetailsResponse":
    """<p>Returns the credentials to access the external Dataview from an S3 location. To call this API:</p> <ul> <li> <p>You must retrieve the programmatic credentials.</p> </li> <li> <p>You must be a member of a FinSpace user group, where the dataset that you want to access has <code>Read Dataset Data</code> permissions.</p> </li> </ul>

    Args:
        data_view_id: <p>The unique identifier for the Dataview that you want to access.</p>
        dataset_id: <p>The unique identifier for the Dataset.</p>

    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.resource_not_found_exception.ResourceNotFoundException: <p>One or more resources can't be found.</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_external_data_view_access_details_request.GetExternalDataViewAccessDetailsRequest]",
    ) -> AsyncOperationResponse[
        "capo_finspace_data.types.get_external_data_view_access_details_response.GetExternalDataViewAccessDetailsResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.get_external_data_view_access_details

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

    def _redact_output(
        output: "capo_finspace_data.types.get_external_data_view_access_details_response.GetExternalDataViewAccessDetailsResponse",
    ) -> dict[str, Any]:
        import capo_finspace_data.types.get_external_data_view_access_details_response

        return capo_finspace_data.types.get_external_data_view_access_details_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetExternalDataViewAccessDetails", redact_output=_redact_output
        ),
    )
    input_: capo_finspace_data.types.get_external_data_view_access_details_request.GetExternalDataViewAccessDetailsRequest = {
        "data_view_id": data_view_id,
        "dataset_id": dataset_id,
    }

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