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.QuickSight.CreateDataSource

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a data source.

Synopsis

data CreateDataSource = CreateDataSource' {
- credentials :: Maybe (Sensitive DataSourceCredentials)
- dataSourceParameters :: Maybe DataSourceParameters
- permissions :: Maybe (NonEmpty ResourcePermission)
- sslProperties :: Maybe SslProperties
- tags :: Maybe (NonEmpty Tag)
- vpcConnectionProperties :: Maybe VpcConnectionProperties
- awsAccountId :: Text
- dataSourceId :: Text
- name :: Text
- type' :: DataSourceType
}
newCreateDataSource :: Text -> Text -> Text -> DataSourceType -> CreateDataSource
createDataSource_credentials :: Lens' CreateDataSource (Maybe DataSourceCredentials)
createDataSource_dataSourceParameters :: Lens' CreateDataSource (Maybe DataSourceParameters)
createDataSource_permissions :: Lens' CreateDataSource (Maybe (NonEmpty ResourcePermission))
createDataSource_sslProperties :: Lens' CreateDataSource (Maybe SslProperties)
createDataSource_tags :: Lens' CreateDataSource (Maybe (NonEmpty Tag))
createDataSource_vpcConnectionProperties :: Lens' CreateDataSource (Maybe VpcConnectionProperties)
createDataSource_awsAccountId :: Lens' CreateDataSource Text
createDataSource_dataSourceId :: Lens' CreateDataSource Text
createDataSource_name :: Lens' CreateDataSource Text
createDataSource_type :: Lens' CreateDataSource DataSourceType
data CreateDataSourceResponse = CreateDataSourceResponse' {
- arn :: Maybe Text
- creationStatus :: Maybe ResourceStatus
- dataSourceId :: Maybe Text
- requestId :: Maybe Text
- status :: Int
}
newCreateDataSourceResponse :: Int -> CreateDataSourceResponse
createDataSourceResponse_arn :: Lens' CreateDataSourceResponse (Maybe Text)
createDataSourceResponse_creationStatus :: Lens' CreateDataSourceResponse (Maybe ResourceStatus)
createDataSourceResponse_dataSourceId :: Lens' CreateDataSourceResponse (Maybe Text)
createDataSourceResponse_requestId :: Lens' CreateDataSourceResponse (Maybe Text)
createDataSourceResponse_status :: Lens' CreateDataSourceResponse Int

Creating a Request

data CreateDataSource Source #

See: newCreateDataSource smart constructor.

Constructors

CreateDataSource'

Fields

credentials :: Maybe (Sensitive DataSourceCredentials)
The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
dataSourceParameters :: Maybe DataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
permissions :: Maybe (NonEmpty ResourcePermission)
A list of resource permissions on the data source.
sslProperties :: Maybe SslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
tags :: Maybe (NonEmpty Tag)
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
vpcConnectionProperties :: Maybe VpcConnectionProperties
Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
awsAccountId :: Text
The Amazon Web Services account ID.
dataSourceId :: Text
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
name :: Text
A display name for the data source.
type' :: DataSourceType
The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Instances

Instances details

ToJSON CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods toJSON :: CreateDataSource -> Value # toEncoding :: CreateDataSource -> Encoding # toJSONList :: [CreateDataSource] -> Value # toEncodingList :: [CreateDataSource] -> Encoding #
ToHeaders CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods toHeaders :: CreateDataSource -> [Header] #
ToPath CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods toPath :: CreateDataSource -> ByteString #
ToQuery CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods toQuery :: CreateDataSource -> QueryString #
AWSRequest CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Associated Types type AWSResponse CreateDataSource # Methods request :: (Service -> Service) -> CreateDataSource -> Request CreateDataSource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDataSource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDataSource))) #
Generic CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Associated Types type Rep CreateDataSource :: Type -> Type # Methods from :: CreateDataSource -> Rep CreateDataSource x # to :: Rep CreateDataSource x -> CreateDataSource #
Show CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods showsPrec :: Int -> CreateDataSource -> ShowS # show :: CreateDataSource -> String # showList :: [CreateDataSource] -> ShowS #
NFData CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods rnf :: CreateDataSource -> () #
Eq CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods (==) :: CreateDataSource -> CreateDataSource -> Bool # (/=) :: CreateDataSource -> CreateDataSource -> Bool #
Hashable CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods hashWithSalt :: Int -> CreateDataSource -> Int # hash :: CreateDataSource -> Int #
type AWSResponse CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource type AWSResponse CreateDataSource = CreateDataSourceResponse
type Rep CreateDataSource Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource type Rep CreateDataSource = D1 ('MetaData "CreateDataSource" "Amazonka.QuickSight.CreateDataSource" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateDataSource'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive DataSourceCredentials))) :: S1 ('MetaSel ('Just "dataSourceParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DataSourceParameters))) :: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ResourcePermission))) :: (S1 ('MetaSel ('Just "sslProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SslProperties)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag)))))) :: ((S1 ('MetaSel ('Just "vpcConnectionProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcConnectionProperties)) :: S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataSourceType))))))

newCreateDataSource Source #

Arguments

:: Text	`CreateDataSource`
-> Text	`CreateDataSource`
-> Text	`CreateDataSource`
-> DataSourceType	`CreateDataSource`
-> CreateDataSource

Create a value of CreateDataSource 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:CreateDataSource', createDataSource_credentials - The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

CreateDataSource, createDataSource_dataSourceParameters - The parameters that Amazon QuickSight uses to connect to your underlying source.

CreateDataSource, createDataSource_permissions - A list of resource permissions on the data source.

CreateDataSource, createDataSource_sslProperties - Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

CreateDataSource, createDataSource_tags - Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

CreateDataSource, createDataSource_vpcConnectionProperties - Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

CreateDataSource, createDataSource_awsAccountId - The Amazon Web Services account ID.

CreateDataSource, createDataSource_dataSourceId - An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

CreateDataSource, createDataSource_name - A display name for the data source.

CreateDataSource, createDataSource_type - The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Request Lenses

createDataSource_credentials :: Lens' CreateDataSource (Maybe DataSourceCredentials) Source #

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.

createDataSource_dataSourceParameters :: Lens' CreateDataSource (Maybe DataSourceParameters) Source #

The parameters that Amazon QuickSight uses to connect to your underlying source.

createDataSource_permissions :: Lens' CreateDataSource (Maybe (NonEmpty ResourcePermission)) Source #

A list of resource permissions on the data source.

createDataSource_sslProperties :: Lens' CreateDataSource (Maybe SslProperties) Source #

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

createDataSource_tags :: Lens' CreateDataSource (Maybe (NonEmpty Tag)) Source #

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

createDataSource_vpcConnectionProperties :: Lens' CreateDataSource (Maybe VpcConnectionProperties) Source #

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.

createDataSource_awsAccountId :: Lens' CreateDataSource Text Source #

The Amazon Web Services account ID.

createDataSource_dataSourceId :: Lens' CreateDataSource Text Source #

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSource_name :: Lens' CreateDataSource Text Source #

A display name for the data source.

createDataSource_type :: Lens' CreateDataSource DataSourceType Source #

The type of the data source. To return a list of all data sources, use ListDataSources.

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

Destructuring the Response

data CreateDataSourceResponse Source #

See: newCreateDataSourceResponse smart constructor.

Constructors

CreateDataSourceResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) of the data source.
creationStatus :: Maybe ResourceStatus
The status of creating the data source.
dataSourceId :: Maybe Text
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
requestId :: Maybe Text
The Amazon Web Services request ID for this operation.
status :: Int
The HTTP status of the request.

Instances

Instances details

Generic CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Associated Types type Rep CreateDataSourceResponse :: Type -> Type # Methods from :: CreateDataSourceResponse -> Rep CreateDataSourceResponse x # to :: Rep CreateDataSourceResponse x -> CreateDataSourceResponse #
Read CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods readsPrec :: Int -> ReadS CreateDataSourceResponse # readList :: ReadS [CreateDataSourceResponse] # readPrec :: ReadPrec CreateDataSourceResponse # readListPrec :: ReadPrec [CreateDataSourceResponse] #
Show CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods showsPrec :: Int -> CreateDataSourceResponse -> ShowS # show :: CreateDataSourceResponse -> String # showList :: [CreateDataSourceResponse] -> ShowS #
NFData CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods rnf :: CreateDataSourceResponse -> () #
Eq CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource Methods (==) :: CreateDataSourceResponse -> CreateDataSourceResponse -> Bool # (/=) :: CreateDataSourceResponse -> CreateDataSourceResponse -> Bool #
type Rep CreateDataSourceResponse Source #
Instance details Defined in Amazonka.QuickSight.CreateDataSource type Rep CreateDataSourceResponse = D1 ('MetaData "CreateDataSourceResponse" "Amazonka.QuickSight.CreateDataSource" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "CreateDataSourceResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "creationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ResourceStatus))) :: (S1 ('MetaSel ('Just "dataSourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newCreateDataSourceResponse Source #

Arguments

:: Int	`CreateDataSourceResponse`
-> CreateDataSourceResponse

Create a value of CreateDataSourceResponse 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:

CreateDataSourceResponse, createDataSourceResponse_arn - The Amazon Resource Name (ARN) of the data source.

CreateDataSourceResponse, createDataSourceResponse_creationStatus - The status of creating the data source.

CreateDataSource, createDataSourceResponse_dataSourceId - The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

$sel:requestId:CreateDataSourceResponse', createDataSourceResponse_requestId - The Amazon Web Services request ID for this operation.

CreateDataSourceResponse, createDataSourceResponse_status - The HTTP status of the request.

Response Lenses

createDataSourceResponse_arn :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data source.

createDataSourceResponse_creationStatus :: Lens' CreateDataSourceResponse (Maybe ResourceStatus) Source #

The status of creating the data source.

createDataSourceResponse_dataSourceId :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

createDataSourceResponse_requestId :: Lens' CreateDataSourceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

createDataSourceResponse_status :: Lens' CreateDataSourceResponse Int Source #

The HTTP status of the request.