Update Data Source
| quicksight_update_data_source | R Documentation |
Updates a data source¶
Description¶
Updates a data source.
Usage¶
quicksight_update_data_source(AwsAccountId, DataSourceId, Name,
DataSourceParameters, Credentials, VpcConnectionProperties,
SslProperties)
Arguments¶
AwsAccountId |
[required] The Amazon Web Services account ID. |
DataSourceId |
[required] The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. |
Name |
[required] A display name for the data source. |
DataSourceParameters |
The parameters that Amazon Quick Sight uses to connect to your underlying source. |
Credentials |
The credentials that Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported. |
VpcConnectionProperties |
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source. |
SslProperties |
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source. |
Value¶
A list with the following syntax:
list(
Arn = "string",
DataSourceId = "string",
UpdateStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED",
RequestId = "string",
Status = 123
)
Request syntax¶
svc$update_data_source(
AwsAccountId = "string",
DataSourceId = "string",
Name = "string",
DataSourceParameters = list(
AmazonElasticsearchParameters = list(
Domain = "string"
),
AthenaParameters = list(
WorkGroup = "string",
RoleArn = "string",
ConsumerAccountRoleArn = "string",
IdentityCenterConfiguration = list(
EnableIdentityPropagation = TRUE|FALSE
)
),
AuroraParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AuroraPostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AwsIotAnalyticsParameters = list(
DataSetName = "string"
),
JiraParameters = list(
SiteBaseUrl = "string"
),
MariaDbParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
MySqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
OracleParameters = list(
Host = "string",
Port = 123,
Database = "string",
UseServiceName = TRUE|FALSE
),
PostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
PrestoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
RdsParameters = list(
InstanceId = "string",
Database = "string"
),
RedshiftParameters = list(
Host = "string",
Port = 123,
Database = "string",
ClusterId = "string",
IAMParameters = list(
RoleArn = "string",
DatabaseUser = "string",
DatabaseGroups = list(
"string"
),
AutoCreateDatabaseUser = TRUE|FALSE
),
IdentityCenterConfiguration = list(
EnableIdentityPropagation = TRUE|FALSE
)
),
S3Parameters = list(
ManifestFileLocation = list(
Bucket = "string",
Key = "string"
),
RoleArn = "string"
),
S3TablesParameters = list(
TableBucketArn = "string"
),
S3KnowledgeBaseParameters = list(
RoleArn = "string",
BucketUrl = "string",
MetadataFilesLocation = "string"
),
ServiceNowParameters = list(
SiteBaseUrl = "string"
),
SnowflakeParameters = list(
Host = "string",
Database = "string",
Warehouse = "string",
AuthenticationType = "PASSWORD"|"KEYPAIR"|"TOKEN"|"X509",
DatabaseAccessControlRole = "string",
OAuthParameters = list(
TokenProviderUrl = "string",
OAuthScope = "string",
IdentityProviderVpcConnectionProperties = list(
VpcConnectionArn = "string"
),
IdentityProviderResourceUri = "string",
IdentityProviderCACertificatesBundleS3Uri = "string"
)
),
SparkParameters = list(
Host = "string",
Port = 123
),
SqlServerParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TeradataParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TwitterParameters = list(
Query = "string",
MaxRows = 123
),
AmazonOpenSearchParameters = list(
Domain = "string"
),
ExasolParameters = list(
Host = "string",
Port = 123
),
DatabricksParameters = list(
Host = "string",
Port = 123,
SqlEndpointPath = "string"
),
StarburstParameters = list(
Host = "string",
Port = 123,
Catalog = "string",
ProductType = "GALAXY"|"ENTERPRISE",
DatabaseAccessControlRole = "string",
AuthenticationType = "PASSWORD"|"KEYPAIR"|"TOKEN"|"X509",
OAuthParameters = list(
TokenProviderUrl = "string",
OAuthScope = "string",
IdentityProviderVpcConnectionProperties = list(
VpcConnectionArn = "string"
),
IdentityProviderResourceUri = "string",
IdentityProviderCACertificatesBundleS3Uri = "string"
)
),
TrinoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
BigQueryParameters = list(
ProjectId = "string",
DataSetRegion = "string"
),
ImpalaParameters = list(
Host = "string",
Port = 123,
Database = "string",
SqlEndpointPath = "string"
),
CustomConnectionParameters = list(
ConnectionType = "string"
),
WebCrawlerParameters = list(
WebCrawlerAuthType = "NO_AUTH"|"BASIC_AUTH"|"FORM"|"SAML",
UsernameFieldXpath = "string",
PasswordFieldXpath = "string",
UsernameButtonXpath = "string",
PasswordButtonXpath = "string",
LoginPageUrl = "string",
WebProxyHostName = "string",
WebProxyPortNumber = 123
),
ConfluenceParameters = list(
ConfluenceUrl = "string"
),
QBusinessParameters = list(
ApplicationArn = "string"
)
),
Credentials = list(
CredentialPair = list(
Username = "string",
Password = "string",
AlternateDataSourceParameters = list(
list(
AmazonElasticsearchParameters = list(
Domain = "string"
),
AthenaParameters = list(
WorkGroup = "string",
RoleArn = "string",
ConsumerAccountRoleArn = "string",
IdentityCenterConfiguration = list(
EnableIdentityPropagation = TRUE|FALSE
)
),
AuroraParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AuroraPostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
AwsIotAnalyticsParameters = list(
DataSetName = "string"
),
JiraParameters = list(
SiteBaseUrl = "string"
),
MariaDbParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
MySqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
OracleParameters = list(
Host = "string",
Port = 123,
Database = "string",
UseServiceName = TRUE|FALSE
),
PostgreSqlParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
PrestoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
RdsParameters = list(
InstanceId = "string",
Database = "string"
),
RedshiftParameters = list(
Host = "string",
Port = 123,
Database = "string",
ClusterId = "string",
IAMParameters = list(
RoleArn = "string",
DatabaseUser = "string",
DatabaseGroups = list(
"string"
),
AutoCreateDatabaseUser = TRUE|FALSE
),
IdentityCenterConfiguration = list(
EnableIdentityPropagation = TRUE|FALSE
)
),
S3Parameters = list(
ManifestFileLocation = list(
Bucket = "string",
Key = "string"
),
RoleArn = "string"
),
S3TablesParameters = list(
TableBucketArn = "string"
),
S3KnowledgeBaseParameters = list(
RoleArn = "string",
BucketUrl = "string",
MetadataFilesLocation = "string"
),
ServiceNowParameters = list(
SiteBaseUrl = "string"
),
SnowflakeParameters = list(
Host = "string",
Database = "string",
Warehouse = "string",
AuthenticationType = "PASSWORD"|"KEYPAIR"|"TOKEN"|"X509",
DatabaseAccessControlRole = "string",
OAuthParameters = list(
TokenProviderUrl = "string",
OAuthScope = "string",
IdentityProviderVpcConnectionProperties = list(
VpcConnectionArn = "string"
),
IdentityProviderResourceUri = "string",
IdentityProviderCACertificatesBundleS3Uri = "string"
)
),
SparkParameters = list(
Host = "string",
Port = 123
),
SqlServerParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TeradataParameters = list(
Host = "string",
Port = 123,
Database = "string"
),
TwitterParameters = list(
Query = "string",
MaxRows = 123
),
AmazonOpenSearchParameters = list(
Domain = "string"
),
ExasolParameters = list(
Host = "string",
Port = 123
),
DatabricksParameters = list(
Host = "string",
Port = 123,
SqlEndpointPath = "string"
),
StarburstParameters = list(
Host = "string",
Port = 123,
Catalog = "string",
ProductType = "GALAXY"|"ENTERPRISE",
DatabaseAccessControlRole = "string",
AuthenticationType = "PASSWORD"|"KEYPAIR"|"TOKEN"|"X509",
OAuthParameters = list(
TokenProviderUrl = "string",
OAuthScope = "string",
IdentityProviderVpcConnectionProperties = list(
VpcConnectionArn = "string"
),
IdentityProviderResourceUri = "string",
IdentityProviderCACertificatesBundleS3Uri = "string"
)
),
TrinoParameters = list(
Host = "string",
Port = 123,
Catalog = "string"
),
BigQueryParameters = list(
ProjectId = "string",
DataSetRegion = "string"
),
ImpalaParameters = list(
Host = "string",
Port = 123,
Database = "string",
SqlEndpointPath = "string"
),
CustomConnectionParameters = list(
ConnectionType = "string"
),
WebCrawlerParameters = list(
WebCrawlerAuthType = "NO_AUTH"|"BASIC_AUTH"|"FORM"|"SAML",
UsernameFieldXpath = "string",
PasswordFieldXpath = "string",
UsernameButtonXpath = "string",
PasswordButtonXpath = "string",
LoginPageUrl = "string",
WebProxyHostName = "string",
WebProxyPortNumber = 123
),
ConfluenceParameters = list(
ConfluenceUrl = "string"
),
QBusinessParameters = list(
ApplicationArn = "string"
)
)
)
),
CopySourceArn = "string",
SecretArn = "string",
KeyPairCredentials = list(
KeyPairUsername = "string",
PrivateKey = "string",
PrivateKeyPassphrase = "string"
),
WebProxyCredentials = list(
WebProxyUsername = "string",
WebProxyPassword = "string"
),
OAuthClientCredentials = list(
ClientId = "string",
ClientSecret = "string",
Username = "string"
)
),
VpcConnectionProperties = list(
VpcConnectionArn = "string"
),
SslProperties = list(
DisableSsl = TRUE|FALSE
)
)