amazonka-finspace-data-2.0: Amazon FinSpace Public API SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Description

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

Creating a Request

data GetExternalDataViewAccessDetails Source #

See: newGetExternalDataViewAccessDetails smart constructor.

Constructors

GetExternalDataViewAccessDetails' 

Fields

  • dataViewId :: Text

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

  • datasetId :: Text

    The unique identifier for the Dataset.

Instances

Instances details
ToJSON GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

ToHeaders GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

ToPath GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

ToQuery GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

AWSRequest GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Generic GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Associated Types

type Rep GetExternalDataViewAccessDetails :: Type -> Type #

Read GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Show GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

NFData GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Eq GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Hashable GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

type AWSResponse GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

type Rep GetExternalDataViewAccessDetails Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

type Rep GetExternalDataViewAccessDetails = D1 ('MetaData "GetExternalDataViewAccessDetails" "Amazonka.FinSpaceData.GetExternalDataViewAccessDetails" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetExternalDataViewAccessDetails'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataViewId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "datasetId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

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.

Destructuring the Response

data GetExternalDataViewAccessDetailsResponse Source #

Constructors

GetExternalDataViewAccessDetailsResponse' 

Fields

Instances

Instances details
Generic GetExternalDataViewAccessDetailsResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Show GetExternalDataViewAccessDetailsResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

NFData GetExternalDataViewAccessDetailsResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Eq GetExternalDataViewAccessDetailsResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

type Rep GetExternalDataViewAccessDetailsResponse Source # 
Instance details

Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

type Rep GetExternalDataViewAccessDetailsResponse = D1 ('MetaData "GetExternalDataViewAccessDetailsResponse" "Amazonka.FinSpaceData.GetExternalDataViewAccessDetails" "amazonka-finspace-data-2.0-Io6eLKJnFUxHbvASHvgCzj" 'False) (C1 ('MetaCons "GetExternalDataViewAccessDetailsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AwsCredentials)) :*: (S1 ('MetaSel ('Just "s3Location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe S3Location)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

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.