Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- data GetExternalDataViewAccessDetails = GetExternalDataViewAccessDetails' {
- dataViewId :: Text
- datasetId :: Text
- newGetExternalDataViewAccessDetails :: Text -> Text -> GetExternalDataViewAccessDetails
- getExternalDataViewAccessDetails_dataViewId :: Lens' GetExternalDataViewAccessDetails Text
- getExternalDataViewAccessDetails_datasetId :: Lens' GetExternalDataViewAccessDetails Text
- data GetExternalDataViewAccessDetailsResponse = GetExternalDataViewAccessDetailsResponse' {}
- newGetExternalDataViewAccessDetailsResponse :: Int -> GetExternalDataViewAccessDetailsResponse
- getExternalDataViewAccessDetailsResponse_credentials :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe AwsCredentials)
- getExternalDataViewAccessDetailsResponse_s3Location :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe S3Location)
- getExternalDataViewAccessDetailsResponse_httpStatus :: Lens' GetExternalDataViewAccessDetailsResponse Int
Creating a Request
data GetExternalDataViewAccessDetails Source #
See: newGetExternalDataViewAccessDetails
smart constructor.
GetExternalDataViewAccessDetails' | |
|
Instances
newGetExternalDataViewAccessDetails Source #
Create a value of GetExternalDataViewAccessDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetExternalDataViewAccessDetails
, getExternalDataViewAccessDetails_dataViewId
- The unique identifier for the Dataview that you want to access.
GetExternalDataViewAccessDetails
, getExternalDataViewAccessDetails_datasetId
- The unique identifier for the Dataset.
Request Lenses
getExternalDataViewAccessDetails_dataViewId :: Lens' GetExternalDataViewAccessDetails Text Source #
The unique identifier for the Dataview that you want to access.
getExternalDataViewAccessDetails_datasetId :: Lens' GetExternalDataViewAccessDetails Text Source #
The unique identifier for the Dataset.
Destructuring the Response
data GetExternalDataViewAccessDetailsResponse Source #
See: newGetExternalDataViewAccessDetailsResponse
smart constructor.
GetExternalDataViewAccessDetailsResponse' | |
|
Instances
newGetExternalDataViewAccessDetailsResponse Source #
Create a value of GetExternalDataViewAccessDetailsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentials:GetExternalDataViewAccessDetailsResponse'
, getExternalDataViewAccessDetailsResponse_credentials
- The credentials required to access the external Dataview from the S3
location.
$sel:s3Location:GetExternalDataViewAccessDetailsResponse'
, getExternalDataViewAccessDetailsResponse_s3Location
- The location where the external Dataview is stored.
$sel:httpStatus:GetExternalDataViewAccessDetailsResponse'
, getExternalDataViewAccessDetailsResponse_httpStatus
- The response's http status code.
Response Lenses
getExternalDataViewAccessDetailsResponse_credentials :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe AwsCredentials) Source #
The credentials required to access the external Dataview from the S3 location.
getExternalDataViewAccessDetailsResponse_s3Location :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe S3Location) Source #
The location where the external Dataview is stored.
getExternalDataViewAccessDetailsResponse_httpStatus :: Lens' GetExternalDataViewAccessDetailsResponse Int Source #
The response's http status code.