Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetExternalDataViewAccessDetails

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.

Request Syntax


POST /datasets/datasetId/dataviewsv2/dataviewId/external-access-details HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

datasetId

The unique identifier for the Dataset.

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

Required: Yes

dataviewId

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "credentials": { 
      "accessKeyId": "string",
      "expiration": number,
      "secretAccessKey": "string",
      "sessionToken": "string"
   },
   "s3Location": { 
      "bucket": "string",
      "key": "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.

credentials

The credentials required to access the external Dataview from the S3 location.

Type: AwsCredentials object

s3Location

The location where the external Dataview is stored.

Type: S3Location object

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

ResourceNotFoundException

One or more resources can't be found.

HTTP Status Code: 404

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