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

Amazonka.FinSpaceData.GetExternalDataViewAccessDetails

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 Methods toJSON :: GetExternalDataViewAccessDetails -> Value # toEncoding :: GetExternalDataViewAccessDetails -> Encoding # toJSONList :: [GetExternalDataViewAccessDetails] -> Value # toEncodingList :: [GetExternalDataViewAccessDetails] -> Encoding #
ToHeaders GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods toHeaders :: GetExternalDataViewAccessDetails -> [Header] #
ToPath GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods toPath :: GetExternalDataViewAccessDetails -> ByteString #
ToQuery GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods toQuery :: GetExternalDataViewAccessDetails -> QueryString #
AWSRequest GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Associated Types type AWSResponse GetExternalDataViewAccessDetails # Methods request :: (Service -> Service) -> GetExternalDataViewAccessDetails -> Request GetExternalDataViewAccessDetails # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetExternalDataViewAccessDetails -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetExternalDataViewAccessDetails))) #
Generic GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Associated Types type Rep GetExternalDataViewAccessDetails :: Type -> Type # Methods from :: GetExternalDataViewAccessDetails -> Rep GetExternalDataViewAccessDetails x # to :: Rep GetExternalDataViewAccessDetails x -> GetExternalDataViewAccessDetails #
Read GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods readsPrec :: Int -> ReadS GetExternalDataViewAccessDetails # readList :: ReadS [GetExternalDataViewAccessDetails] # readPrec :: ReadPrec GetExternalDataViewAccessDetails # readListPrec :: ReadPrec [GetExternalDataViewAccessDetails] #
Show GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods showsPrec :: Int -> GetExternalDataViewAccessDetails -> ShowS # show :: GetExternalDataViewAccessDetails -> String # showList :: [GetExternalDataViewAccessDetails] -> ShowS #
NFData GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods rnf :: GetExternalDataViewAccessDetails -> () #
Eq GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods (==) :: GetExternalDataViewAccessDetails -> GetExternalDataViewAccessDetails -> Bool # (/=) :: GetExternalDataViewAccessDetails -> GetExternalDataViewAccessDetails -> Bool #
Hashable GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods hashWithSalt :: Int -> GetExternalDataViewAccessDetails -> Int # hash :: GetExternalDataViewAccessDetails -> Int #
type AWSResponse GetExternalDataViewAccessDetails Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails type AWSResponse GetExternalDataViewAccessDetails = GetExternalDataViewAccessDetailsResponse
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 #

Arguments

:: Text	`GetExternalDataViewAccessDetails`
-> Text	`GetExternalDataViewAccessDetails`
-> GetExternalDataViewAccessDetails

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.

Constructors

GetExternalDataViewAccessDetailsResponse'
Fields credentials :: Maybe AwsCredentials The credentials required to access the external Dataview from the S3 location. s3Location :: Maybe S3Location The location where the external Dataview is stored. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetExternalDataViewAccessDetailsResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Associated Types type Rep GetExternalDataViewAccessDetailsResponse :: Type -> Type # Methods from :: GetExternalDataViewAccessDetailsResponse -> Rep GetExternalDataViewAccessDetailsResponse x # to :: Rep GetExternalDataViewAccessDetailsResponse x -> GetExternalDataViewAccessDetailsResponse #
Show GetExternalDataViewAccessDetailsResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods showsPrec :: Int -> GetExternalDataViewAccessDetailsResponse -> ShowS # show :: GetExternalDataViewAccessDetailsResponse -> String # showList :: [GetExternalDataViewAccessDetailsResponse] -> ShowS #
NFData GetExternalDataViewAccessDetailsResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods rnf :: GetExternalDataViewAccessDetailsResponse -> () #
Eq GetExternalDataViewAccessDetailsResponse Source #
Instance details Defined in Amazonka.FinSpaceData.GetExternalDataViewAccessDetails Methods (==) :: GetExternalDataViewAccessDetailsResponse -> GetExternalDataViewAccessDetailsResponse -> Bool # (/=) :: GetExternalDataViewAccessDetailsResponse -> GetExternalDataViewAccessDetailsResponse -> Bool #
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 #

Arguments

:: Int	`$sel:httpStatus:GetExternalDataViewAccessDetailsResponse'`
-> GetExternalDataViewAccessDetailsResponse

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.