2025/10/09 - Amazon QuickSight - 13 new18 updated api methods
Changes This release adds support for ActionConnector and Flow, which are new resources associated with Amazon Quick Suite. Additional updates include expanded Data Source options, further branding customization, and new capabilities that can be restricted by Admins.
Updates permissions against principals on a flow.
See also: AWS API Documentation
Request Syntax
client.update_flow_permissions(
AwsAccountId='string',
FlowId='string',
GrantPermissions=[
{
'Actions': [
'string',
],
'Principal': 'string'
},
],
RevokePermissions=[
{
'Actions': [
'string',
],
'Principal': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the flow you are updating permissions against.
string
[REQUIRED]
The unique identifier of the flow to update permissions for.
list
The permissions that you want to grant on this flow.
(dict) --
A structure that contains the permission information for one principal against one flow.
Actions (list) -- [REQUIRED]
A list of actions that the principal can perform against the flow.
The following are the list of values to set a principal as a flow owner:
quicksight:PublishFlow
quicksight:GetFlow
quicksight:UpdateFlowPermissions
quicksight:GetFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:UpdateFlowSession
quicksight:UnpublishFlow
quicksight:GetFlowStages
quicksight:DeleteFlow
quicksight:DescribeFlowPermissions
quicksight:UpdateFlow
quicksight:CreatePresignedUrl
The following are the list of values to set a principal as a flow viewer:
quicksight:GetFlow
quicksight:UpdateFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:GetFlowSession
quicksight:CreatePresignedUrl
quicksight:GetFlowStages
(string) --
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be an Amazon QuickSight user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.
list
The permissions that you want to revoke from this flow.
(dict) --
A structure that contains the permission information for one principal against one flow.
Actions (list) -- [REQUIRED]
A list of actions that the principal can perform against the flow.
The following are the list of values to set a principal as a flow owner:
quicksight:PublishFlow
quicksight:GetFlow
quicksight:UpdateFlowPermissions
quicksight:GetFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:UpdateFlowSession
quicksight:UnpublishFlow
quicksight:GetFlowStages
quicksight:DeleteFlow
quicksight:DescribeFlowPermissions
quicksight:UpdateFlow
quicksight:CreatePresignedUrl
The following are the list of values to set a principal as a flow viewer:
quicksight:GetFlow
quicksight:UpdateFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:GetFlowSession
quicksight:CreatePresignedUrl
quicksight:GetFlowStages
(string) --
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be an Amazon QuickSight user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'Permissions': [
{
'Actions': [
'string',
],
'Principal': 'string'
},
],
'RequestId': 'string',
'FlowId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the flow you are updating permissions against.
Permissions (list) --
The permissions on the flow after they are updated.
(dict) --
A structure that contains the permission information for one principal against one flow.
Actions (list) --
A list of actions that the principal can perform against the flow.
The following are the list of values to set a principal as a flow owner:
quicksight:PublishFlow
quicksight:GetFlow
quicksight:UpdateFlowPermissions
quicksight:GetFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:UpdateFlowSession
quicksight:UnpublishFlow
quicksight:GetFlowStages
quicksight:DeleteFlow
quicksight:DescribeFlowPermissions
quicksight:UpdateFlow
quicksight:CreatePresignedUrl
The following are the list of values to set a principal as a flow viewer:
quicksight:GetFlow
quicksight:UpdateFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:GetFlowSession
quicksight:CreatePresignedUrl
quicksight:GetFlowStages
(string) --
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be an Amazon QuickSight user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.
RequestId (string) --
The Amazon Web Services request ID for this operation.
FlowId (string) --
The unique identifier of the flow with updated permissions.
Lists all action connectors in the specified Amazon Web Services account. Returns summary information for each connector including its name, type, creation time, and status.
See also: AWS API Documentation
Request Syntax
client.list_action_connectors(
AwsAccountId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The Amazon Web Services account ID for which to list action connectors.
integer
The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
string
A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue listing action connectors.
dict
Response Syntax
{
'ActionConnectorSummaries': [
{
'Arn': 'string',
'ActionConnectorId': 'string',
'Type': 'GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Error': {
'Message': 'string',
'Type': 'INTERNAL_FAILURE'
}
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ActionConnectorSummaries (list) --
A list of action connector summaries containing basic information about each connector.
(dict) --
Contains summary information about an action connector, used in list and search operations.
Arn (string) --
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) --
The unique identifier of the action connector.
Type (string) --
The type of action connector (e.g., SALESFORCE, JIRA, CUSTOM, BEDROCK).
Name (string) --
The name of the action connector.
CreatedTime (datetime) --
The date and time when the action connector was created.
LastUpdatedTime (datetime) --
The date and time when the action connector was last updated.
Status (string) --
The current status of the action connector.
Error (dict) --
Error information if the action connector is in an error state.
Message (string) --
The error message describing what went wrong with the action connector.
Type (string) --
The type or category of the error.
NextToken (string) --
A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Retrieves the metadata of a flow, not including its definition specifying the steps.
See also: AWS API Documentation
Request Syntax
client.get_flow_metadata(
AwsAccountId='string',
FlowId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the flow that you are getting metadata for.
string
[REQUIRED]
The unique identifier of the flow.
dict
Response Syntax
{
'Arn': 'string',
'FlowId': 'string',
'Name': 'string',
'Description': 'string',
'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
'UserCount': 123,
'RunCount': 123,
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
FlowId (string) --
The unique identifier of the flow.
Name (string) --
A display name for the flow.
Description (string) --
The description for the flow.
PublishState (string) --
The publish state for the flow. Valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
UserCount (integer) --
The number of users who have used the flow.
RunCount (integer) --
The number of runs done for the flow.
CreatedTime (datetime) --
The time this flow was created.
LastUpdatedTime (datetime) --
The last time this flow was modified.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Hard deletes an action connector, making it unrecoverable. This operation removes the connector and all its associated configurations. Any resources currently using this action connector will no longer be able to perform actions through it.
See also: AWS API Documentation
Request Syntax
client.delete_action_connector(
AwsAccountId='string',
ActionConnectorId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID that contains the action connector to delete.
string
[REQUIRED]
The unique identifier of the action connector to delete.
dict
Response Syntax
{
'Arn': 'string',
'ActionConnectorId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the deleted action connector.
ActionConnectorId (string) --
The unique identifier of the deleted action connector.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Creates an action connector that enables Amazon Quick Sight to connect to external services and perform actions. Action connectors support various authentication methods and can be configured with specific actions from supported connector types like Amazon S3, Salesforce, JIRA.
See also: AWS API Documentation
Request Syntax
client.create_action_connector(
AwsAccountId='string',
ActionConnectorId='string',
Name='string',
Type='GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR',
AuthenticationConfig={
'AuthenticationType': 'BASIC'|'API_KEY'|'OAUTH2_CLIENT_CREDENTIALS'|'NONE'|'IAM'|'OAUTH2_AUTHORIZATION_CODE',
'AuthenticationMetadata': {
'AuthorizationCodeGrantMetadata': {
'BaseEndpoint': 'string',
'RedirectUrl': 'string',
'AuthorizationCodeGrantCredentialsSource': 'PLAIN_CREDENTIALS',
'AuthorizationCodeGrantCredentialsDetails': {
'AuthorizationCodeGrantDetails': {
'ClientId': 'string',
'ClientSecret': 'string',
'TokenEndpoint': 'string',
'AuthorizationEndpoint': 'string'
}
}
},
'ClientCredentialsGrantMetadata': {
'BaseEndpoint': 'string',
'ClientCredentialsSource': 'PLAIN_CREDENTIALS',
'ClientCredentialsDetails': {
'ClientCredentialsGrantDetails': {
'ClientId': 'string',
'ClientSecret': 'string',
'TokenEndpoint': 'string'
}
}
},
'BasicAuthConnectionMetadata': {
'BaseEndpoint': 'string',
'Username': 'string',
'Password': 'string'
},
'ApiKeyConnectionMetadata': {
'BaseEndpoint': 'string',
'ApiKey': 'string',
'Email': 'string'
},
'NoneConnectionMetadata': {
'BaseEndpoint': 'string'
},
'IamConnectionMetadata': {
'RoleArn': 'string'
}
}
},
Description='string',
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID associated with the action connector.
string
[REQUIRED]
A unique identifier for the action connector. This ID must be unique within the Amazon Web Services account. The ActionConnectorId must not start with the prefix quicksuite-
string
[REQUIRED]
A descriptive name for the action connector.
string
[REQUIRED]
The type of action connector.
dict
[REQUIRED]
The authentication configuration for connecting to the external service. This includes the authentication type, base URL, and authentication metadata such as client credentials or API keys.
AuthenticationType (string) -- [REQUIRED]
The type of authentication method.
AuthenticationMetadata (dict) -- [REQUIRED]
The authentication metadata containing the specific configuration for the chosen authentication type.
AuthorizationCodeGrantMetadata (dict) --
OAuth 2.0 authorization code grant authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
RedirectUrl (string) -- [REQUIRED]
The redirect URL for the OAuth authorization flow.
AuthorizationCodeGrantCredentialsSource (string) --
The source of the authorization code grant credentials.
AuthorizationCodeGrantCredentialsDetails (dict) --
The detailed credentials configuration for authorization code grant.
AuthorizationCodeGrantDetails (dict) --
The authorization code grant configuration details.
ClientId (string) -- [REQUIRED]
The client ID for the OAuth application.
ClientSecret (string) -- [REQUIRED]
The client secret for the OAuth application.
TokenEndpoint (string) -- [REQUIRED]
The token endpoint URL for obtaining access tokens.
AuthorizationEndpoint (string) -- [REQUIRED]
The authorization endpoint URL for the OAuth flow.
ClientCredentialsGrantMetadata (dict) --
OAuth 2.0 client credentials grant authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base endpoint URL for the external service.
ClientCredentialsSource (string) --
The source of the client credentials configuration.
ClientCredentialsDetails (dict) --
The detailed client credentials configuration including client ID, client secret, and token endpoint.
ClientCredentialsGrantDetails (dict) --
The OAuth2 client credentials grant configuration details for authentication.
ClientId (string) -- [REQUIRED]
The client identifier issued to the client during the registration process with the authorization server.
ClientSecret (string) -- [REQUIRED]
The client secret issued to the client during the registration process with the authorization server.
TokenEndpoint (string) -- [REQUIRED]
The authorization server endpoint used to obtain access tokens via the client credentials grant flow.
BasicAuthConnectionMetadata (dict) --
Basic authentication metadata using username and password.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
Username (string) -- [REQUIRED]
The username for basic authentication.
Password (string) -- [REQUIRED]
The password for basic authentication.
ApiKeyConnectionMetadata (dict) --
API key authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
ApiKey (string) -- [REQUIRED]
The API key used for authentication.
Email (string) --
The email address associated with the API key, if required.
NoneConnectionMetadata (dict) --
No authentication metadata for services that don't require authentication.
BaseEndpoint (string) -- [REQUIRED]
The base endpoint URL for connections that do not require authentication.
IamConnectionMetadata (dict) --
IAM role-based authentication metadata for Amazon Web Services services.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.
string
An optional description of the action connector.
list
The permissions configuration that defines which users, groups, or namespaces can access this action connector and what operations they can perform.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
string
The ARN of the VPC connection to use for secure connectivity to the external service.
list
A list of tags to apply to the action connector for resource management and organization.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Arn': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'ActionConnectorId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the created action connector.
CreationStatus (string) --
The creation status of the action connector.
ActionConnectorId (string) --
The unique identifier of the created action connector.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Retrieves the permissions configuration for an action connector, showing which users, groups, and namespaces have access and what operations they can perform.
See also: AWS API Documentation
Request Syntax
client.describe_action_connector_permissions(
AwsAccountId='string',
ActionConnectorId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID that contains the action connector.
string
[REQUIRED]
The unique identifier of the action connector whose permissions you want to describe.
dict
Response Syntax
{
'Arn': 'string',
'ActionConnectorId': 'string',
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) --
The unique identifier of the action connector.
Permissions (list) --
The list of permissions associated with the action connector, including the principals and their allowed actions.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) --
The IAM action to grant or revoke permissions on.
(string) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Search for the flows in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.search_flows(
AwsAccountId='string',
Filters=[
{
'Name': 'assetName'|'assetDescription'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER',
'Operator': 'StringEquals'|'StringLike',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account where you are searching for flows from.
list
[REQUIRED]
The filters applied to the search when searching for flows in the Amazon Web Services account.
(dict) --
A structure that contains the filter information when searching flows.
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example "Name": "DIRECT_QUICKSIGHT_SOLE_OWNER".
Valid values are defined as follows:
assetName: Any flows whose names have a substring match to this value will be returned.
assetDescription: Any flows whose descriptions have a substring match to this value will be returned.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
Value (string) -- [REQUIRED]
The value of the named item, in this case DIRECT_QUICKSIGHT_SOLE_OWNER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
string
The token to request the next set of results, or null if you want to retrieve the first set.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'FlowSummaryList': [
{
'Arn': 'string',
'FlowId': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
'RunCount': 123,
'UserCount': 123,
'LastPublishedBy': 'string',
'LastPublishedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
FlowSummaryList (list) --
The list of flows found against the search.
(dict) --
The basic information of the flow exluding its definition specifying the steps.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
FlowId (string) --
The unique identifier of the flow.
Name (string) --
The display name of the flow.
Description (string) --
The description of the flow.
CreatedTime (datetime) --
The time this flow was created.
CreatedBy (string) --
The identifier of the principal who created the flow.
LastUpdatedTime (datetime) --
The last time this flow was modified.
LastUpdatedBy (string) --
The identifier of the last principal who updated the flow.
PublishState (string) --
The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
RunCount (integer) --
The number of runs done for the flow.
UserCount (integer) --
The number of users who have used the flow.
LastPublishedBy (string) --
The identifier of the last principal who published the flow.
LastPublishedAt (datetime) --
The last time this flow was published.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates an existing action connector with new configuration details, authentication settings, or enabled actions. You can modify the connector's name, description, authentication configuration, and which actions are enabled. For more information, https://docs.aws.amazon.com/quicksuite/latest/userguide/quick-action-auth.html.
See also: AWS API Documentation
Request Syntax
client.update_action_connector(
AwsAccountId='string',
ActionConnectorId='string',
Name='string',
AuthenticationConfig={
'AuthenticationType': 'BASIC'|'API_KEY'|'OAUTH2_CLIENT_CREDENTIALS'|'NONE'|'IAM'|'OAUTH2_AUTHORIZATION_CODE',
'AuthenticationMetadata': {
'AuthorizationCodeGrantMetadata': {
'BaseEndpoint': 'string',
'RedirectUrl': 'string',
'AuthorizationCodeGrantCredentialsSource': 'PLAIN_CREDENTIALS',
'AuthorizationCodeGrantCredentialsDetails': {
'AuthorizationCodeGrantDetails': {
'ClientId': 'string',
'ClientSecret': 'string',
'TokenEndpoint': 'string',
'AuthorizationEndpoint': 'string'
}
}
},
'ClientCredentialsGrantMetadata': {
'BaseEndpoint': 'string',
'ClientCredentialsSource': 'PLAIN_CREDENTIALS',
'ClientCredentialsDetails': {
'ClientCredentialsGrantDetails': {
'ClientId': 'string',
'ClientSecret': 'string',
'TokenEndpoint': 'string'
}
}
},
'BasicAuthConnectionMetadata': {
'BaseEndpoint': 'string',
'Username': 'string',
'Password': 'string'
},
'ApiKeyConnectionMetadata': {
'BaseEndpoint': 'string',
'ApiKey': 'string',
'Email': 'string'
},
'NoneConnectionMetadata': {
'BaseEndpoint': 'string'
},
'IamConnectionMetadata': {
'RoleArn': 'string'
}
}
},
Description='string',
VpcConnectionArn='string'
)
string
[REQUIRED]
The Amazon Web Services account ID that contains the action connector to update.
string
[REQUIRED]
The unique identifier of the action connector to update.
string
[REQUIRED]
The new name for the action connector.
dict
[REQUIRED]
The updated authentication configuration for connecting to the external service.
AuthenticationType (string) -- [REQUIRED]
The type of authentication method.
AuthenticationMetadata (dict) -- [REQUIRED]
The authentication metadata containing the specific configuration for the chosen authentication type.
AuthorizationCodeGrantMetadata (dict) --
OAuth 2.0 authorization code grant authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
RedirectUrl (string) -- [REQUIRED]
The redirect URL for the OAuth authorization flow.
AuthorizationCodeGrantCredentialsSource (string) --
The source of the authorization code grant credentials.
AuthorizationCodeGrantCredentialsDetails (dict) --
The detailed credentials configuration for authorization code grant.
AuthorizationCodeGrantDetails (dict) --
The authorization code grant configuration details.
ClientId (string) -- [REQUIRED]
The client ID for the OAuth application.
ClientSecret (string) -- [REQUIRED]
The client secret for the OAuth application.
TokenEndpoint (string) -- [REQUIRED]
The token endpoint URL for obtaining access tokens.
AuthorizationEndpoint (string) -- [REQUIRED]
The authorization endpoint URL for the OAuth flow.
ClientCredentialsGrantMetadata (dict) --
OAuth 2.0 client credentials grant authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base endpoint URL for the external service.
ClientCredentialsSource (string) --
The source of the client credentials configuration.
ClientCredentialsDetails (dict) --
The detailed client credentials configuration including client ID, client secret, and token endpoint.
ClientCredentialsGrantDetails (dict) --
The OAuth2 client credentials grant configuration details for authentication.
ClientId (string) -- [REQUIRED]
The client identifier issued to the client during the registration process with the authorization server.
ClientSecret (string) -- [REQUIRED]
The client secret issued to the client during the registration process with the authorization server.
TokenEndpoint (string) -- [REQUIRED]
The authorization server endpoint used to obtain access tokens via the client credentials grant flow.
BasicAuthConnectionMetadata (dict) --
Basic authentication metadata using username and password.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
Username (string) -- [REQUIRED]
The username for basic authentication.
Password (string) -- [REQUIRED]
The password for basic authentication.
ApiKeyConnectionMetadata (dict) --
API key authentication metadata.
BaseEndpoint (string) -- [REQUIRED]
The base URL endpoint for the external service.
ApiKey (string) -- [REQUIRED]
The API key used for authentication.
Email (string) --
The email address associated with the API key, if required.
NoneConnectionMetadata (dict) --
No authentication metadata for services that don't require authentication.
BaseEndpoint (string) -- [REQUIRED]
The base endpoint URL for connections that do not require authentication.
IamConnectionMetadata (dict) --
IAM role-based authentication metadata for Amazon Web Services services.
RoleArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the IAM role to assume for authentication with Amazon Web Services services. This IAM role should be in the same account as Quick Sight.
string
The updated description of the action connector.
string
The updated ARN of the VPC connection to use for secure connectivity.
dict
Response Syntax
{
'Arn': 'string',
'ActionConnectorId': 'string',
'RequestId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the updated action connector.
ActionConnectorId (string) --
The unique identifier of the updated action connector.
RequestId (string) --
The Amazon Web Services request ID for this operation.
UpdateStatus (string) --
The status of the update operation.
Status (integer) --
The HTTP status code of the request.
Retrieves detailed information about an action connector, including its configuration, authentication settings, enabled actions, and current status.
See also: AWS API Documentation
Request Syntax
client.describe_action_connector(
AwsAccountId='string',
ActionConnectorId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID that contains the action connector.
string
[REQUIRED]
The unique identifier of the action connector to describe.
dict
Response Syntax
{
'ActionConnector': {
'Arn': 'string',
'ActionConnectorId': 'string',
'Type': 'GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Error': {
'Message': 'string',
'Type': 'INTERNAL_FAILURE'
},
'Description': 'string',
'AuthenticationConfig': {
'AuthenticationType': 'BASIC'|'API_KEY'|'OAUTH2_CLIENT_CREDENTIALS'|'NONE'|'IAM'|'OAUTH2_AUTHORIZATION_CODE',
'AuthenticationMetadata': {
'AuthorizationCodeGrantMetadata': {
'BaseEndpoint': 'string',
'RedirectUrl': 'string',
'ReadAuthorizationCodeGrantCredentialsDetails': {
'ReadAuthorizationCodeGrantDetails': {
'ClientId': 'string',
'TokenEndpoint': 'string',
'AuthorizationEndpoint': 'string'
}
},
'AuthorizationCodeGrantCredentialsSource': 'PLAIN_CREDENTIALS'
},
'ClientCredentialsGrantMetadata': {
'BaseEndpoint': 'string',
'ReadClientCredentialsDetails': {
'ReadClientCredentialsGrantDetails': {
'ClientId': 'string',
'TokenEndpoint': 'string'
}
},
'ClientCredentialsSource': 'PLAIN_CREDENTIALS'
},
'BasicAuthConnectionMetadata': {
'BaseEndpoint': 'string',
'Username': 'string'
},
'ApiKeyConnectionMetadata': {
'BaseEndpoint': 'string',
'Email': 'string'
},
'NoneConnectionMetadata': {
'BaseEndpoint': 'string'
},
'IamConnectionMetadata': {
'RoleArn': 'string',
'SourceArn': 'string'
}
}
},
'EnabledActions': [
'string',
],
'VpcConnectionArn': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ActionConnector (dict) --
The detailed information about the action connector, including its configuration and current state.
Arn (string) --
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) --
The unique identifier of the action connector.
Type (string) --
The type of action connector.
Name (string) --
The name of the action connector.
CreatedTime (datetime) --
The timestamp when the action connector was created.
LastUpdatedTime (datetime) --
The date and time when the action connector was last updated.
Status (string) --
The current status of the action connector.
Error (dict) --
Error information if the action connector is in an error state.
Message (string) --
The error message describing what went wrong with the action connector.
Type (string) --
The type or category of the error.
Description (string) --
The description of the action connector.
AuthenticationConfig (dict) --
The authentication configuration used to connect to the external service.
AuthenticationType (string) --
The type of authentication being used (BASIC, API_KEY, OAUTH2_CLIENT_CREDENTIALS, or OAUTH2_AUTHORIZATION_CODE).
AuthenticationMetadata (dict) --
The authentication metadata containing configuration details specific to the authentication type.
AuthorizationCodeGrantMetadata (dict) --
Read-only metadata for OAuth2 authorization code grant flow configuration.
BaseEndpoint (string) --
The base endpoint URL for the OAuth2 authorization code grant flow.
RedirectUrl (string) --
The redirect URL where the authorization server will send the user after authorization.
ReadAuthorizationCodeGrantCredentialsDetails (dict) --
The read-only credentials details for the authorization code grant flow.
ReadAuthorizationCodeGrantDetails (dict) --
The read-only authorization code grant configuration details.
ClientId (string) --
The client identifier for the OAuth2 authorization code grant flow.
TokenEndpoint (string) --
The authorization server endpoint used to obtain access tokens via the authorization code grant flow.
AuthorizationEndpoint (string) --
The authorization server endpoint used to obtain authorization codes from the resource owner.
AuthorizationCodeGrantCredentialsSource (string) --
The source of credentials for the authorization code grant flow.
ClientCredentialsGrantMetadata (dict) --
Read-only metadata for OAuth2 client credentials grant flow configuration.
BaseEndpoint (string) --
The base endpoint URL for the OAuth2 client credentials grant flow.
ReadClientCredentialsDetails (dict) --
The read-only client credentials configuration details.
ReadClientCredentialsGrantDetails (dict) --
The read-only client credentials grant configuration details.
ClientId (string) --
The client identifier for the OAuth2 client credentials grant flow.
TokenEndpoint (string) --
The authorization server endpoint used to obtain access tokens via the client credentials grant flow.
ClientCredentialsSource (string) --
The source of client credentials for the OAuth2 client credentials grant flow.
BasicAuthConnectionMetadata (dict) --
Read-only metadata for basic authentication configuration.
BaseEndpoint (string) --
The base endpoint URL for basic authentication.
Username (string) --
The username used for basic authentication.
ApiKeyConnectionMetadata (dict) --
Read-only metadata for API key authentication configuration.
BaseEndpoint (string) --
The base endpoint URL for API key authentication.
Email (string) --
The email address associated with the API key authentication.
NoneConnectionMetadata (dict) --
Read-only metadata for connections that do not require authentication.
BaseEndpoint (string) --
The base endpoint URL for connections that do not require authentication.
IamConnectionMetadata (dict) --
Read-only metadata for IAM-based authentication configuration.
RoleArn (string) --
The Amazon Resource Name (ARN) of the IAM role to assume for authentication.
SourceArn (string) --
The Amazon Resource Name (ARN) of the source resource for IAM authentication.
EnabledActions (list) --
The list of actions that are enabled for this connector.
(string) --
VpcConnectionArn (string) --
The ARN of the VPC connection used for secure connectivity to the external service.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Get permissions for a flow.
See also: AWS API Documentation
Request Syntax
client.get_flow_permissions(
AwsAccountId='string',
FlowId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the flow that you are getting permissions for.
string
[REQUIRED]
The unique identifier of the flow to get permissions from.
dict
Response Syntax
{
'Arn': 'string',
'FlowId': 'string',
'Permissions': [
{
'Actions': [
'string',
],
'Principal': 'string'
},
],
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the flow you are getting permissions against.
FlowId (string) --
The unique identifier of the flow with permissions.
Permissions (list) --
A structure that contains the permissions for the flow.
(dict) --
A structure that contains the permission information for one principal against one flow.
Actions (list) --
A list of actions that the principal can perform against the flow.
The following are the list of values to set a principal as a flow owner:
quicksight:PublishFlow
quicksight:GetFlow
quicksight:UpdateFlowPermissions
quicksight:GetFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:UpdateFlowSession
quicksight:UnpublishFlow
quicksight:GetFlowStages
quicksight:DeleteFlow
quicksight:DescribeFlowPermissions
quicksight:UpdateFlow
quicksight:CreatePresignedUrl
The following are the list of values to set a principal as a flow viewer:
quicksight:GetFlow
quicksight:UpdateFlowSession
quicksight:StartFlowSession
quicksight:StopFlowSession
quicksight:GetFlowSession
quicksight:CreatePresignedUrl
quicksight:GetFlowStages
(string) --
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be an Amazon QuickSight user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates the permissions for an action connector by granting or revoking access for specific users and groups. You can control who can view, use, or manage the action connector.
See also: AWS API Documentation
Request Syntax
client.update_action_connector_permissions(
AwsAccountId='string',
ActionConnectorId='string',
GrantPermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RevokePermissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID that contains the action connector.
string
[REQUIRED]
The unique identifier of the action connector whose permissions you want to update.
list
The permissions to grant to users and groups for this action connector.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
list
The permissions to revoke from users and groups for this action connector.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'ActionConnectorId': 'string',
'RequestId': 'string',
'Status': 123,
'Permissions': [
{
'Principal': 'string',
'Actions': [
'string',
]
},
]
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) --
The unique identifier of the action connector.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
Permissions (list) --
The updated permissions configuration for the action connector.
(dict) --
Permission for the resource.
Principal (string) --
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) --
The IAM action to grant or revoke permissions on.
(string) --
Lists flows in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_flows(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the flow list that you are getting.
string
The token to request the next set of results, or null if you want to retrieve the first set.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'FlowSummaryList': [
{
'Arn': 'string',
'FlowId': 'string',
'Name': 'string',
'Description': 'string',
'CreatedTime': datetime(2015, 1, 1),
'CreatedBy': 'string',
'LastUpdatedTime': datetime(2015, 1, 1),
'LastUpdatedBy': 'string',
'PublishState': 'PUBLISHED'|'DRAFT'|'PENDING_APPROVAL',
'RunCount': 123,
'UserCount': 123,
'LastPublishedBy': 'string',
'LastPublishedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
FlowSummaryList (list) --
A structure that contains all of the flows in your Amazon Web Services account. This structure provides basic information about the flows.
(dict) --
The basic information of the flow exluding its definition specifying the steps.
Arn (string) --
The Amazon Resource Name (ARN) of the flow.
FlowId (string) --
The unique identifier of the flow.
Name (string) --
The display name of the flow.
Description (string) --
The description of the flow.
CreatedTime (datetime) --
The time this flow was created.
CreatedBy (string) --
The identifier of the principal who created the flow.
LastUpdatedTime (datetime) --
The last time this flow was modified.
LastUpdatedBy (string) --
The identifier of the last principal who updated the flow.
PublishState (string) --
The publish state for the flow. The valid values are DRAFT, PUBLISHED, or PENDING_APPROVAL.
RunCount (integer) --
The number of runs done for the flow.
UserCount (integer) --
The number of users who have used the flow.
LastPublishedBy (string) --
The identifier of the last principal who published the flow.
LastPublishedAt (datetime) --
The last time this flow was published.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Searches for action connectors in the specified Amazon Web Services account using filters. You can search by connector name, type, or user permissions.
See also: AWS API Documentation
Request Syntax
client.search_action_connectors(
AwsAccountId='string',
MaxResults=123,
NextToken='string',
Filters=[
{
'Name': 'ACTION_CONNECTOR_NAME'|'ACTION_CONNECTOR_TYPE'|'QUICKSIGHT_OWNER'|'QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER',
'Operator': 'StringEquals'|'StringLike',
'Value': 'string'
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID in which to search for action connectors.
integer
The maximum number of action connectors to return in a single response. Valid range is 1 to 100.
string
A pagination token to retrieve the next set of results. Use the token returned from a previous call to continue searching.
list
[REQUIRED]
The search filters to apply. You can filter by connector name, type, or user permissions. Maximum of one filter is supported.
(dict) --
A filter used to search for action connectors based on specific criteria.
Name (string) -- [REQUIRED]
The name of the filter attribute (e.g., ACTION_CONNECTOR_NAME, ACTION_CONNECTOR_TYPE, QUICKSIGHT_VIEWER_OR_OWNER).
Operator (string) -- [REQUIRED]
The comparison operator to use for the filter (e.g., StringEquals, StringLike).
Value (string) -- [REQUIRED]
The value to compare against using the specified operator.
dict
Response Syntax
{
'NextToken': 'string',
'RequestId': 'string',
'Status': 123,
'ActionConnectorSummaries': [
{
'Arn': 'string',
'ActionConnectorId': 'string',
'Type': 'GENERIC_HTTP'|'SERVICENOW_NOW_PLATFORM'|'SALESFORCE_CRM'|'MICROSOFT_OUTLOOK'|'PAGERDUTY_ADVANCE'|'JIRA_CLOUD'|'ATLASSIAN_CONFLUENCE'|'AMAZON_S3'|'AMAZON_BEDROCK_AGENT_RUNTIME'|'AMAZON_BEDROCK_RUNTIME'|'AMAZON_BEDROCK_DATA_AUTOMATION_RUNTIME'|'AMAZON_TEXTRACT'|'AMAZON_COMPREHEND'|'AMAZON_COMPREHEND_MEDICAL'|'MICROSOFT_ONEDRIVE'|'MICROSOFT_SHAREPOINT'|'MICROSOFT_TEAMS'|'SAP_BUSINESSPARTNER'|'SAP_PRODUCTMASTERDATA'|'SAP_PHYSICALINVENTORY'|'SAP_BILLOFMATERIALS'|'SAP_MATERIALSTOCK'|'ZENDESK_SUITE'|'SMARTSHEET'|'SLACK'|'ASANA'|'BAMBOO_HR',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Error': {
'Message': 'string',
'Type': 'INTERNAL_FAILURE'
}
},
]
}
Response Structure
(dict) --
NextToken (string) --
A pagination token to retrieve the next set of results. If null, there are no more results to retrieve.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status code of the request.
ActionConnectorSummaries (list) --
A list of action connector summaries that match the search criteria.
(dict) --
Contains summary information about an action connector, used in list and search operations.
Arn (string) --
The Amazon Resource Name (ARN) of the action connector.
ActionConnectorId (string) --
The unique identifier of the action connector.
Type (string) --
The type of action connector (e.g., SALESFORCE, JIRA, CUSTOM, BEDROCK).
Name (string) --
The name of the action connector.
CreatedTime (datetime) --
The date and time when the action connector was created.
LastUpdatedTime (datetime) --
The date and time when the action connector was last updated.
Status (string) --
The current status of the action connector.
Error (dict) --
Error information if the action connector is in an error state.
Message (string) --
The error message describing what went wrong with the action connector.
Type (string) --
The type or category of the error.
{'BrandDefinition': {'ApplicationTheme': {'ContextualAccentPalette': {'Automation': {'Background': 'string',
'Foreground': 'string'},
'Connection': {'Background': 'string',
'Foreground': 'string'},
'Insight': {'Background': 'string',
'Foreground': 'string'},
'Visualization': {'Background': 'string',
'Foreground': 'string'}}}}}
Creates an Quick Sight brand.
See also: AWS API Documentation
Request Syntax
client.create_brand(
AwsAccountId='string',
BrandId='string',
BrandDefinition={
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the brand.
string
[REQUIRED]
The ID of the QuickSight brand.
dict
The definition of the brand.
BrandName (string) -- [REQUIRED]
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) -- [REQUIRED]
The alt text for the logo.
LogoSet (dict) -- [REQUIRED]
A set of configured logos.
Primary (dict) -- [REQUIRED]
The primary logo.
Original (dict) -- [REQUIRED]
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) -- [REQUIRED]
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
list
A map of the key-value pairs that are assigned to the brand.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'RequestId': 'string',
'BrandDetail': {
'BrandId': 'string',
'Arn': 'string',
'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'VersionId': 'string',
'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED',
'Errors': [
'string',
],
'Logo': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
}
}
}
},
'BrandDefinition': {
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
}
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
BrandDetail (dict) --
The details of the brand.
BrandId (string) --
The ID of the QuickSight brand.
Arn (string) --
The Amazon Resource Name (ARN) of the brand.
BrandStatus (string) --
The status of the brand.
CreatedTime (datetime) --
The time that the brand was created.
LastUpdatedTime (datetime) --
The last time the brand was updated.
VersionId (string) --
The ID of the version.
VersionStatus (string) --
The status of the version.
Errors (list) --
A list of errors that occurred during the most recent brand operation.
(string) --
Logo (dict) --
The logo details.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
BrandDefinition (dict) --
The definition of the brand.
BrandName (string) --
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
{'Capabilities': {'Action': 'DENY',
'Automate': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Flow': 'DENY',
'KnowledgeBase': 'DENY',
'PerformFlowUiTask': 'DENY',
'PublishWithoutApproval': 'DENY',
'Research': 'DENY',
'Space': 'DENY',
'UseAgentWebSearch': 'DENY',
'UseBedrockModels': 'DENY'}}
Creates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.create_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'Space': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Research': 'DENY'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that you want to create the custom permissions profile in.
string
[REQUIRED]
The name of the custom permissions profile that you want to create.
dict
A set of actions to include in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
Space (string) --
The ability to perform space-related actions.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
Research (string) --
The ability to perform research-related actions.
list
The tags to associate with the custom permissions profile.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DashboardPublishOptions': {'QuickSuiteActionsOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}}}
Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation.
A dashboard is an entity in Amazon Quick Sight that identifies Amazon Quick Sight reports, created from analyses. You can share Amazon Quick Sight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The ARN of the dashboard.
VersionArn (string) --
The ARN of the dashboard, including the version number of the first version that is created.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The status of the dashboard creation request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}}},
'WebProxyCredentials': {'WebProxyPassword': 'string',
'WebProxyUsername': 'string'}},
'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}},
'Type': {'CONFLUENCE',
'GOOGLE_DRIVE',
'ONE_DRIVE',
'QBUSINESS',
'S3_KNOWLEDGE_BASE',
'SHAREPOINT',
'WEB_CRAWLER'}}
Creates a data source.
See also: AWS API Documentation
Request Syntax
client.create_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
Type='ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
FolderArns=[
'string',
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
string
[REQUIRED]
The type of the data source. To return a list of all data sources, use ListDataSources.
Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
dict
The parameters that Amazon Quick Sight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
The credentials Amazon Quick Sight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
list
A list of resource permissions on the data source.
(dict) --
Permission for the resource.
Principal (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Quick Sight user or group associated with a data source or dataset. (This is common.)
The ARN of an Quick Sight user, group, or namespace associated with an analysis, dashboard, template, or theme. Namespace sharing is not supported for action connectors. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a Quick Sight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. Account root sharing is not supported for action connectors. (This is less common.)
Actions (list) -- [REQUIRED]
The IAM action to grant or revoke permissions on.
(string) --
dict
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
list
When you create the data source, Amazon Quick Sight adds the data source to these folders.
(string) --
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
CreationStatus (string) --
The status of creating the data source.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}}}}}
Describes an existing import job.
Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
See also: AWS API Documentation
Request Syntax
client.describe_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account the import job was executed in.
string
[REQUIRED]
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
dict
Response Syntax
{
'JobStatus': 'QUEUED_FOR_IMMEDIATE_EXECUTION'|'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'FAILED_ROLLBACK_IN_PROGRESS'|'FAILED_ROLLBACK_COMPLETED'|'FAILED_ROLLBACK_ERROR',
'Errors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'RollbackErrors': [
{
'Arn': 'string',
'Type': 'string',
'Message': 'string'
},
],
'Arn': 'string',
'CreatedTime': datetime(2015, 1, 1),
'AssetBundleImportJobId': 'string',
'AwsAccountId': 'string',
'AssetBundleImportSource': {
'Body': 'string',
'S3Uri': 'string'
},
'OverrideParameters': {
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
'FailureAction': 'DO_NOTHING'|'ROLLBACK',
'RequestId': 'string',
'Status': 123,
'OverridePermissions': {
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
'OverrideTags': {
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
'OverrideValidationStrategy': {
'StrictModeForAllResources': True|False
},
'Warnings': [
{
'Arn': 'string',
'Message': 'string'
},
]
}
Response Structure
(dict) --
JobStatus (string) --
Indicates the status of a job through its queuing and execution.
Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:
SUCCESSFUL
FAILED
FAILED_ROLLBACK_COMPLETED
FAILED_ROLLBACK_ERROR
Errors (list) --
An array of error records that describes any failures that occurred during the export job processing.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
RollbackErrors (list) --
An array of error records that describes any failures that occurred while an import job was attempting a rollback.
Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
(dict) --
Describes an error that occurred within an Asset Bundle import execution.
Arn (string) --
The ARN of the resource whose processing caused an error.
Type (string) --
The specific error type or the error that occurred.
Message (string) --
A description of the error.
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
CreatedTime (datetime) --
The time that the import job was created.
AssetBundleImportJobId (string) --
The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
AwsAccountId (string) --
The ID of the Amazon Web Services account the import job was executed in.
AssetBundleImportSource (dict) --
The source of the asset bundle zip file that contains the data that is imported by the job.
Body (string) --
An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
S3Uri (string) --
The Amazon S3 URI that you provided at the start of the import job.
OverrideParameters (dict) --
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) --
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) --
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) --
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) --
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) --
The username for the data source connection.
Password (string) --
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) --
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) --
The incremental refresh for the dataset.
LookbackWindow (dict) --
The lookback window setup for an incremental refresh configuration.
ColumnName (string) --
The name of the lookback window column.
Size (integer) --
The lookback window column size.
SizeUnit (string) --
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) --
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) --
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) --
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) --
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
FailureAction (string) --
The failure action for the import job.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the response.
OverridePermissions (dict) --
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the data source that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the themes that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) --
A list of principals to grant permissions on.
(string) --
Actions (list) --
A list of IAM actions to grant permissions on.
(string) --
OverrideTags (dict) --
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) --
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) --
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) --
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) --
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) --
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) --
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) --
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) --
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) --
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) --
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) --
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) --
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) --
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) --
A list of tags for the folders that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) --
Tag key.
Value (string) --
Tag value.
OverrideValidationStrategy (dict) --
An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
Warnings (list) --
An array of warning records that describe all permitted errors that are encountered during the import job.
(dict) --
Describes a warning that occurred during an Asset Bundle import job.
Arn (string) --
The ARN of the resource that the warning occurred for.
Message (string) --
A description of the warning that occurred during an Asset Bundle import job.
{'BrandDefinition': {'ApplicationTheme': {'ContextualAccentPalette': {'Automation': {'Background': 'string',
'Foreground': 'string'},
'Connection': {'Background': 'string',
'Foreground': 'string'},
'Insight': {'Background': 'string',
'Foreground': 'string'},
'Visualization': {'Background': 'string',
'Foreground': 'string'}}}}}
Describes a brand.
See also: AWS API Documentation
Request Syntax
client.describe_brand(
AwsAccountId='string',
BrandId='string',
VersionId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the brand.
string
[REQUIRED]
The ID of the QuickSight brand.
string
The ID of the specific version. The default value is the latest version.
dict
Response Syntax
{
'RequestId': 'string',
'BrandDetail': {
'BrandId': 'string',
'Arn': 'string',
'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'VersionId': 'string',
'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED',
'Errors': [
'string',
],
'Logo': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
}
}
}
},
'BrandDefinition': {
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
}
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
BrandDetail (dict) --
The details of the brand.
BrandId (string) --
The ID of the QuickSight brand.
Arn (string) --
The Amazon Resource Name (ARN) of the brand.
BrandStatus (string) --
The status of the brand.
CreatedTime (datetime) --
The time that the brand was created.
LastUpdatedTime (datetime) --
The last time the brand was updated.
VersionId (string) --
The ID of the version.
VersionStatus (string) --
The status of the version.
Errors (list) --
A list of errors that occurred during the most recent brand operation.
(string) --
Logo (dict) --
The logo details.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
BrandDefinition (dict) --
The definition of the brand.
BrandName (string) --
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
{'BrandDefinition': {'ApplicationTheme': {'ContextualAccentPalette': {'Automation': {'Background': 'string',
'Foreground': 'string'},
'Connection': {'Background': 'string',
'Foreground': 'string'},
'Insight': {'Background': 'string',
'Foreground': 'string'},
'Visualization': {'Background': 'string',
'Foreground': 'string'}}}}}
Describes the published version of the brand.
See also: AWS API Documentation
Request Syntax
client.describe_brand_published_version(
AwsAccountId='string',
BrandId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the brand.
string
[REQUIRED]
The ID of the QuickSight brand.
dict
Response Syntax
{
'RequestId': 'string',
'BrandDetail': {
'BrandId': 'string',
'Arn': 'string',
'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'VersionId': 'string',
'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED',
'Errors': [
'string',
],
'Logo': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
}
}
}
},
'BrandDefinition': {
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
}
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
BrandDetail (dict) --
The details of the brand.
BrandId (string) --
The ID of the QuickSight brand.
Arn (string) --
The Amazon Resource Name (ARN) of the brand.
BrandStatus (string) --
The status of the brand.
CreatedTime (datetime) --
The time that the brand was created.
LastUpdatedTime (datetime) --
The last time the brand was updated.
VersionId (string) --
The ID of the version.
VersionStatus (string) --
The status of the version.
Errors (list) --
A list of errors that occurred during the most recent brand operation.
(string) --
Logo (dict) --
The logo details.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
BrandDefinition (dict) --
The definition of the brand.
BrandName (string) --
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
{'CustomPermissions': {'Capabilities': {'Action': 'DENY',
'Automate': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Flow': 'DENY',
'KnowledgeBase': 'DENY',
'PerformFlowUiTask': 'DENY',
'PublishWithoutApproval': 'DENY',
'Research': 'DENY',
'Space': 'DENY',
'UseAgentWebSearch': 'DENY',
'UseBedrockModels': 'DENY'}}}
Describes a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.describe_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profile that you want described.
string
[REQUIRED]
The name of the custom permissions profile to describe.
dict
Response Syntax
{
'Status': 123,
'CustomPermissions': {
'Arn': 'string',
'CustomPermissionsName': 'string',
'Capabilities': {
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'Space': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Research': 'DENY'
}
},
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
CustomPermissions (dict) --
The custom permissions profile.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
CustomPermissionsName (string) --
The name of the custom permissions profile.
Capabilities (dict) --
A set of actions in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
Space (string) --
The ability to perform space-related actions.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
Research (string) --
The ability to perform research-related actions.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DashboardPublishOptions': {'QuickSuiteActionsOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}}}
Provides a detailed description of the definition of a dashboard.
See also: AWS API Documentation
Request Syntax
client.describe_dashboard_definition(
AwsAccountId='string',
DashboardId='string',
VersionNumber=123,
AliasName='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the dashboard that you're describing.
string
[REQUIRED]
The ID for the dashboard.
integer
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
string
The alias name.
dict
Response Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.
Response Structure
# This section is too large to render. # Please see the AWS API Documentation linked below.
{'DataSource': {'AlternateDataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}},
'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}},
'Type': {'CONFLUENCE',
'GOOGLE_DRIVE',
'ONE_DRIVE',
'QBUSINESS',
'S3_KNOWLEDGE_BASE',
'SHAREPOINT',
'WEB_CRAWLER'}}}
Describes a data source.
See also: AWS API Documentation
Request Syntax
client.describe_data_source(
AwsAccountId='string',
DataSourceId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSource': {
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSource (dict) --
The information on the data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Quick Sight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'CustomPermissionsList': {'Capabilities': {'Action': 'DENY',
'Automate': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Flow': 'DENY',
'KnowledgeBase': 'DENY',
'PerformFlowUiTask': 'DENY',
'PublishWithoutApproval': 'DENY',
'Research': 'DENY',
'Space': 'DENY',
'UseAgentWebSearch': 'DENY',
'UseBedrockModels': 'DENY'}}}
Returns a list of all the custom permissions profiles.
See also: AWS API Documentation
Request Syntax
client.list_custom_permissions(
AwsAccountId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profiles that you want to list.
integer
The maximum number of results to return.
string
The token for the next set of results, or null if there are no more results.
dict
Response Syntax
{
'Status': 123,
'CustomPermissionsList': [
{
'Arn': 'string',
'CustomPermissionsName': 'string',
'Capabilities': {
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'Space': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Research': 'DENY'
}
},
],
'NextToken': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
CustomPermissionsList (list) --
A list of custom permissions profiles.
(dict) --
The custom permissions profile.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
CustomPermissionsName (string) --
The name of the custom permissions profile.
Capabilities (dict) --
A set of actions in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
Space (string) --
The ability to perform space-related actions.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
Research (string) --
The ability to perform research-related actions.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DataSources': {'AlternateDataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}},
'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}},
'Type': {'CONFLUENCE',
'GOOGLE_DRIVE',
'ONE_DRIVE',
'QBUSINESS',
'S3_KNOWLEDGE_BASE',
'SHAREPOINT',
'WEB_CRAWLER'}}}
Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_data_sources(
AwsAccountId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSources': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'Status': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
],
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'ErrorInfo': {
'Type': 'ACCESS_DENIED'|'COPY_SOURCE_NOT_FOUND'|'TIMEOUT'|'ENGINE_VERSION_NOT_SUPPORTED'|'UNKNOWN_HOST'|'GENERIC_SQL_FAILURE'|'CONFLICT'|'UNKNOWN',
'Message': 'string'
},
'SecretArn': 'string'
},
],
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSources (list) --
A list of data sources.
(dict) --
The structure of a data source.
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Name (string) --
A display name for the data source.
Type (string) --
The type of the data source. This type indicates which database engine the data source connects to.
Status (string) --
The HTTP status of the request.
CreatedTime (datetime) --
The time that this data source was created.
LastUpdatedTime (datetime) --
The last time that this data source was updated.
DataSourceParameters (dict) --
The parameters that Quick Sight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) --
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) --
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) --
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) --
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) --
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) --
An Oracle host.
Port (integer) --
The port.
Database (string) --
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) --
Host.
Port (integer) --
Port.
Catalog (string) --
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) --
Instance ID.
Database (string) --
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) --
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) --
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) --
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) --
Amazon S3 bucket.
Key (string) --
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) --
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) --
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) --
Host.
Database (string) --
Database.
Warehouse (string) --
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) --
Host.
Port (integer) --
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) --
Host.
Port (integer) --
Port.
Database (string) --
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) --
Twitter query string.
MaxRows (integer) --
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) --
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) --
The hostname or IP address of the Exasol data source.
Port (integer) --
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) --
The host name of the Databricks data source.
Port (integer) --
The port for the Databricks data source.
SqlEndpointPath (string) --
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) --
The host name of the Starburst data source.
Port (integer) --
The port for the Starburst data source.
Catalog (string) --
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) --
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) --
The host name of the Trino data source.
Port (integer) --
The port for the Trino data source.
Catalog (string) --
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) --
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) --
The host name of the Impala data source.
Port (integer) --
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) --
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) --
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) --
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) --
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
The VPC connection information. You need to use this parameter only when you want Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) --
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
ErrorInfo (dict) --
Error information from the last update or the creation of the data source.
Type (string) --
Error type.
Message (string) --
Error message.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSourceSummaries': {'Type': {'CONFLUENCE',
'GOOGLE_DRIVE',
'ONE_DRIVE',
'QBUSINESS',
'S3_KNOWLEDGE_BASE',
'SHAREPOINT',
'WEB_CRAWLER'}}}
Use the SearchDataSources operation to search for data sources that belong to an account.
See also: AWS API Documentation
Request Syntax
client.search_data_sources(
AwsAccountId='string',
Filters=[
{
'Operator': 'StringEquals'|'StringLike',
'Name': 'DIRECT_QUICKSIGHT_VIEWER_OR_OWNER'|'DIRECT_QUICKSIGHT_OWNER'|'DIRECT_QUICKSIGHT_SOLE_OWNER'|'DATASOURCE_NAME',
'Value': 'string'
},
],
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The Amazon Web Services account ID.
list
[REQUIRED]
The filters to apply to the search.
(dict) --
A filter that you apply when searching for data sources.
Operator (string) -- [REQUIRED]
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike".
If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.
Name (string) -- [REQUIRED]
The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER".
Valid values are defined as follows:
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered.
DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.
Value (string) -- [REQUIRED]
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
string
A pagination token that can be used in a subsequent request.
integer
The maximum number of results to be returned per request.
dict
Response Syntax
{
'DataSourceSummaries': [
{
'Arn': 'string',
'DataSourceId': 'string',
'Name': 'string',
'Type': 'ADOBE_ANALYTICS'|'AMAZON_ELASTICSEARCH'|'ATHENA'|'AURORA'|'AURORA_POSTGRESQL'|'AWS_IOT_ANALYTICS'|'GITHUB'|'JIRA'|'MARIADB'|'MYSQL'|'ORACLE'|'POSTGRESQL'|'PRESTO'|'REDSHIFT'|'S3'|'SALESFORCE'|'SERVICENOW'|'SNOWFLAKE'|'SPARK'|'SQLSERVER'|'TERADATA'|'TWITTER'|'TIMESTREAM'|'AMAZON_OPENSEARCH'|'EXASOL'|'DATABRICKS'|'STARBURST'|'TRINO'|'BIGQUERY'|'GOOGLESHEETS'|'GOOGLE_DRIVE'|'CONFLUENCE'|'SHAREPOINT'|'ONE_DRIVE'|'WEB_CRAWLER'|'S3_KNOWLEDGE_BASE'|'QBUSINESS',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
DataSourceSummaries (list) --
A DataSourceSummaries object that returns a summary of a data source.
(dict) --
A DataSourceSummary object that returns a summary of a data source.
Arn (string) --
The arn of the datasource.
DataSourceId (string) --
The unique ID of the data source.
Name (string) --
The name of the data source.
Type (string) --
The type of the data source.
CreatedTime (datetime) --
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
LastUpdatedTime (datetime) --
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
NextToken (string) --
A pagination token that can be used in a subsequent request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}}}}}
Starts an Asset Bundle import job.
An Asset Bundle import job imports specified Amazon Quick Sight assets into an Amazon Quick Sight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon Quick Sight account. Each Amazon Quick Sight account can run up to 5 import jobs concurrently.
The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
See also: AWS API Documentation
Request Syntax
client.start_asset_bundle_import_job(
AwsAccountId='string',
AssetBundleImportJobId='string',
AssetBundleImportSource={
'Body': b'bytes',
'S3Uri': 'string'
},
OverrideParameters={
'ResourceIdOverrideConfiguration': {
'PrefixForAllResources': 'string'
},
'VPCConnections': [
{
'VPCConnectionId': 'string',
'Name': 'string',
'SubnetIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'DnsResolvers': [
'string',
],
'RoleArn': 'string'
},
],
'RefreshSchedules': [
{
'DataSetId': 'string',
'ScheduleId': 'string',
'StartAfterDateTime': datetime(2015, 1, 1)
},
],
'DataSources': [
{
'DataSourceId': 'string',
'Name': 'string',
'DataSourceParameters': {
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
'VpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'SslProperties': {
'DisableSsl': True|False
},
'Credentials': {
'CredentialPair': {
'Username': 'string',
'Password': 'string'
},
'SecretArn': 'string'
}
},
],
'DataSets': [
{
'DataSetId': 'string',
'Name': 'string',
'DataSetRefreshProperties': {
'RefreshConfiguration': {
'IncrementalRefresh': {
'LookbackWindow': {
'ColumnName': 'string',
'Size': 123,
'SizeUnit': 'HOUR'|'DAY'|'WEEK'
}
}
},
'FailureConfiguration': {
'EmailAlert': {
'AlertStatus': 'ENABLED'|'DISABLED'
}
}
}
},
],
'Themes': [
{
'ThemeId': 'string',
'Name': 'string'
},
],
'Analyses': [
{
'AnalysisId': 'string',
'Name': 'string'
},
],
'Dashboards': [
{
'DashboardId': 'string',
'Name': 'string'
},
],
'Folders': [
{
'FolderId': 'string',
'Name': 'string',
'ParentFolderArn': 'string'
},
]
},
FailureAction='DO_NOTHING'|'ROLLBACK',
OverridePermissions={
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
},
'LinkSharingConfiguration': {
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
}
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Permissions': {
'Principals': [
'string',
],
'Actions': [
'string',
]
}
},
]
},
OverrideTags={
'VPCConnections': [
{
'VPCConnectionIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSources': [
{
'DataSourceIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'DataSets': [
{
'DataSetIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Themes': [
{
'ThemeIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Analyses': [
{
'AnalysisIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Dashboards': [
{
'DashboardIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
],
'Folders': [
{
'FolderIds': [
'string',
],
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
]
},
]
},
OverrideValidationStrategy={
'StrictModeForAllResources': True|False
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account to import assets into.
string
[REQUIRED]
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
dict
[REQUIRED]
The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
Body (bytes) --
The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If the size of the file that you want to upload is more than 20 MB, add the file to your Amazon S3 bucket and use S3Uri of the file for this operation.
If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
S3Uri (string) --
The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 1 GB.
dict
Optional overrides that are applied to the resource configuration before import.
ResourceIdOverrideConfiguration (dict) --
An optional structure that configures resource ID overrides to be applied within the import job.
PrefixForAllResources (string) --
An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
VPCConnections (list) --
A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single VPC connection that is imported.
VPCConnectionId (string) -- [REQUIRED]
The ID of the VPC Connection to apply overrides to.
Name (string) --
A new name for the VPC connection.
SubnetIds (list) --
A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
SecurityGroupIds (list) --
A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
(string) --
DnsResolvers (list) --
An optional override of DNS resolvers to be used by the VPC connection.
(string) --
RoleArn (string) --
An optional override of the role ARN to be used by the VPC connection.
RefreshSchedules (list) --
A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
(dict) --
A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.
DataSetId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
ScheduleId (string) -- [REQUIRED]
A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
StartAfterDateTime (datetime) --
An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
DataSources (list) --
A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single data source that is being imported.
DataSourceId (string) -- [REQUIRED]
The ID of the data source to apply overrides to.
Name (string) --
A new name for the data source.
DataSourceParameters (dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
VpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
SslProperties (dict) --
Secure Socket Layer (SSL) properties that apply when Quick Sight connects to your underlying data source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
Credentials (dict) --
An optional structure that provides the credentials to be used to create the imported data source.
CredentialPair (dict) --
A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
Username (string) -- [REQUIRED]
The username for the data source connection.
Password (string) -- [REQUIRED]
The password for the data source connection.
SecretArn (string) --
The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
DataSets (list) --
A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dataset that is being imported.
DataSetId (string) -- [REQUIRED]
The ID of the dataset to apply overrides to.
Name (string) --
A new name for the dataset.
DataSetRefreshProperties (dict) --
The refresh properties of a dataset.
RefreshConfiguration (dict) --
The refresh configuration for a dataset.
IncrementalRefresh (dict) -- [REQUIRED]
The incremental refresh for the dataset.
LookbackWindow (dict) -- [REQUIRED]
The lookback window setup for an incremental refresh configuration.
ColumnName (string) -- [REQUIRED]
The name of the lookback window column.
Size (integer) -- [REQUIRED]
The lookback window column size.
SizeUnit (string) -- [REQUIRED]
The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
FailureConfiguration (dict) --
The failure configuration for a dataset.
EmailAlert (dict) --
The email alert configuration for a dataset refresh failure.
AlertStatus (string) --
The status value that determines if email alerts are sent.
Themes (list) --
A list of overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single theme that is imported.
ThemeId (string) -- [REQUIRED]
The ID of the theme to apply overrides to.
Name (string) --
A new name for the theme.
Analyses (list) --
A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single analysis that is being imported.
AnalysisId (string) -- [REQUIRED]
The ID of the analysis that you ant to apply overrides to.
Name (string) --
A new name for the analysis.
Dashboards (list) --
A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single dashboard that is being imported.
DashboardId (string) -- [REQUIRED]
The ID of the dashboard that you want to apply overrides to.
Name (string) --
A new name for the dashboard.
Folders (list) --
A list of overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single folder that is being imported.
FolderId (string) -- [REQUIRED]
The ID of the folder that you want to apply overrides to.
Name (string) --
A new name for the folder.
ParentFolderArn (string) --
A new parent folder arn. This change can only be applied if the import creates a brand new folder. Existing folders cannot be moved.
string
The failure action for the import job.
If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.
If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon Quick Sight account in an inconsistent state.
dict
Optional permission overrides that are applied to the resource configuration before import.
DataSources (list) --
A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the data source that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
DataSets (list) --
A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the datasets that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Themes (list) --
A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the themes that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Analyses (list) --
A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the analyses that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Dashboards (list) --
A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of permissions to be applied to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
LinkSharingConfiguration (dict) --
A structure that contains the link sharing configurations that you want to apply overrides to.
Permissions (dict) --
A list of link sharing permissions for the dashboards that you want to apply overrides to.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
Folders (list) --
A list of permissions for the folders that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Permissions (dict) --
A structure that contains the permissions for the resource that you want to override in an asset bundle import job.
Principals (list) -- [REQUIRED]
A list of principals to grant permissions on.
(string) --
Actions (list) -- [REQUIRED]
A list of IAM actions to grant permissions on.
(string) --
dict
Optional tag overrides that are applied to the resource configuration before import.
VPCConnections (list) --
A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of VPC connection IDs.
VPCConnectionIds (list) -- [REQUIRED]
A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the VPC connections that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSources (list) --
A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of data source IDs.
DataSourceIds (list) -- [REQUIRED]
A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the data source that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
DataSets (list) --
A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dataset IDs.
DataSetIds (list) -- [REQUIRED]
A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the datasets that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Themes (list) --
A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of theme IDs.
ThemeIds (list) -- [REQUIRED]
A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the themes that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Analyses (list) --
A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of analysis IDs.
AnalysisIds (list) -- [REQUIRED]
A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the analyses that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Dashboards (list) --
A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of dashboard IDs.
DashboardIds (list) -- [REQUIRED]
A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the dashboards that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
Folders (list) --
A list of tag overrides for any Folder resources that are present in the asset bundle that is imported.
(dict) --
An object that contains a list of tags to be assigned to a list of folder IDs.
FolderIds (list) -- [REQUIRED]
A list of folder IDs that you want to apply overrides to. You can use * to override all folders in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the folders that you want to apply overrides to.
(dict) --
The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.
Key (string) -- [REQUIRED]
Tag key.
Value (string) -- [REQUIRED]
Tag value.
dict
An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
StrictModeForAllResources (boolean) --
A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
dict
Response Syntax
{
'Arn': 'string',
'AssetBundleImportJobId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) for the import job.
AssetBundleImportJobId (string) --
The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
RequestId (string) --
The Amazon Web Services response ID for this operation.
Status (integer) --
The HTTP status of the response.
{'BrandDefinition': {'ApplicationTheme': {'ContextualAccentPalette': {'Automation': {'Background': 'string',
'Foreground': 'string'},
'Connection': {'Background': 'string',
'Foreground': 'string'},
'Insight': {'Background': 'string',
'Foreground': 'string'},
'Visualization': {'Background': 'string',
'Foreground': 'string'}}}}}
Updates a brand.
See also: AWS API Documentation
Request Syntax
client.update_brand(
AwsAccountId='string',
BrandId='string',
BrandDefinition={
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the brand.
string
[REQUIRED]
The ID of the QuickSight brand.
dict
The definition of the brand.
BrandName (string) -- [REQUIRED]
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) -- [REQUIRED]
The alt text for the logo.
LogoSet (dict) -- [REQUIRED]
A set of configured logos.
Primary (dict) -- [REQUIRED]
The primary logo.
Original (dict) -- [REQUIRED]
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) -- [REQUIRED]
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
dict
Response Syntax
{
'RequestId': 'string',
'BrandDetail': {
'BrandId': 'string',
'Arn': 'string',
'BrandStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'VersionId': 'string',
'VersionStatus': 'CREATE_IN_PROGRESS'|'CREATE_SUCCEEDED'|'CREATE_FAILED',
'Errors': [
'string',
],
'Logo': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height64': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
},
'Height32': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
},
'GeneratedImageUrl': 'string'
}
}
}
}
},
'BrandDefinition': {
'BrandName': 'string',
'Description': 'string',
'ApplicationTheme': {
'BrandColorPalette': {
'Primary': {
'Foreground': 'string',
'Background': 'string'
},
'Secondary': {
'Foreground': 'string',
'Background': 'string'
},
'Accent': {
'Foreground': 'string',
'Background': 'string'
},
'Measure': {
'Foreground': 'string',
'Background': 'string'
},
'Dimension': {
'Foreground': 'string',
'Background': 'string'
},
'Success': {
'Foreground': 'string',
'Background': 'string'
},
'Info': {
'Foreground': 'string',
'Background': 'string'
},
'Warning': {
'Foreground': 'string',
'Background': 'string'
},
'Danger': {
'Foreground': 'string',
'Background': 'string'
}
},
'ContextualAccentPalette': {
'Connection': {
'Foreground': 'string',
'Background': 'string'
},
'Visualization': {
'Foreground': 'string',
'Background': 'string'
},
'Insight': {
'Foreground': 'string',
'Background': 'string'
},
'Automation': {
'Foreground': 'string',
'Background': 'string'
}
},
'BrandElementStyle': {
'NavbarStyle': {
'GlobalNavbar': {
'Foreground': 'string',
'Background': 'string'
},
'ContextualNavbar': {
'Foreground': 'string',
'Background': 'string'
}
}
}
},
'LogoConfiguration': {
'AltText': 'string',
'LogoSet': {
'Primary': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
},
'Favicon': {
'Original': {
'Source': {
'PublicUrl': 'string',
'S3Uri': 'string'
}
}
}
}
}
}
}
Response Structure
(dict) --
RequestId (string) --
The Amazon Web Services request ID for this operation.
BrandDetail (dict) --
The details of the brand.
BrandId (string) --
The ID of the QuickSight brand.
Arn (string) --
The Amazon Resource Name (ARN) of the brand.
BrandStatus (string) --
The status of the brand.
CreatedTime (datetime) --
The time that the brand was created.
LastUpdatedTime (datetime) --
The last time the brand was updated.
VersionId (string) --
The ID of the version.
VersionStatus (string) --
The status of the version.
Errors (list) --
A list of errors that occurred during the most recent brand operation.
(string) --
Logo (dict) --
The logo details.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height64 (dict) --
The image with the height set to 64 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
Height32 (dict) --
The image with the height set to 32 pixels.
Source (dict) --
The source of the logo image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
GeneratedImageUrl (string) --
The URL that points to the generated logo image.
BrandDefinition (dict) --
The definition of the brand.
BrandName (string) --
The name of the brand.
Description (string) --
The description of the brand.
ApplicationTheme (dict) --
The application theme of the brand.
BrandColorPalette (dict) --
The color palette.
Primary (dict) --
The primary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Secondary (dict) --
The secondary color.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Accent (dict) --
The color that is used for accent elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Measure (dict) --
The color that is used for measure elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Dimension (dict) --
The color that is used for dimension elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Success (dict) --
The color that is used for success elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Info (dict) --
The color that is used for info elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Warning (dict) --
The color that is used for warning elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Danger (dict) --
The color that is used for danger elements.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualAccentPalette (dict) --
The contextual accent palette.
Connection (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Visualization (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Insight (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
Automation (dict) --
The color palette.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
BrandElementStyle (dict) --
The element style.
NavbarStyle (dict) --
The navigation bar style.
GlobalNavbar (dict) --
The global navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
ContextualNavbar (dict) --
The contextual navigation bar style.
Foreground (string) --
The foreground color.
Background (string) --
The background color.
LogoConfiguration (dict) --
The logo configuration of the brand.
AltText (string) --
The alt text for the logo.
LogoSet (dict) --
A set of configured logos.
Primary (dict) --
The primary logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
Favicon (dict) --
The favicon logo.
Original (dict) --
The original image.
Source (dict) --
The source of the image.
PublicUrl (string) --
The public URL that points to the source image.
S3Uri (string) --
The Amazon S3 URI that points to the source image.
{'Capabilities': {'Action': 'DENY',
'Automate': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Flow': 'DENY',
'KnowledgeBase': 'DENY',
'PerformFlowUiTask': 'DENY',
'PublishWithoutApproval': 'DENY',
'Research': 'DENY',
'Space': 'DENY',
'UseAgentWebSearch': 'DENY',
'UseBedrockModels': 'DENY'}}
Updates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.update_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY',
'ExportToExcel': 'DENY',
'ExportToPdf': 'DENY',
'PrintReports': 'DENY',
'CreateAndUpdateThemes': 'DENY',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY',
'ShareAnalyses': 'DENY',
'CreateAndUpdateDatasets': 'DENY',
'ShareDatasets': 'DENY',
'SubscribeDashboardEmailReports': 'DENY',
'CreateAndUpdateDashboardEmailReports': 'DENY',
'ShareDashboards': 'DENY',
'CreateAndUpdateThresholdAlerts': 'DENY',
'RenameSharedFolders': 'DENY',
'CreateSharedFolders': 'DENY',
'CreateAndUpdateDataSources': 'DENY',
'ShareDataSources': 'DENY',
'ViewAccountSPICECapacity': 'DENY',
'CreateSPICEDataset': 'DENY',
'ExportToPdfInScheduledReports': 'DENY',
'ExportToCsvInScheduledReports': 'DENY',
'ExportToExcelInScheduledReports': 'DENY',
'IncludeContentInScheduledReportsEmail': 'DENY',
'Dashboard': 'DENY',
'Analysis': 'DENY',
'Automate': 'DENY',
'Flow': 'DENY',
'PublishWithoutApproval': 'DENY',
'UseBedrockModels': 'DENY',
'PerformFlowUiTask': 'DENY',
'UseAgentWebSearch': 'DENY',
'KnowledgeBase': 'DENY',
'Action': 'DENY',
'Space': 'DENY',
'ChatAgent': 'DENY',
'CreateChatAgents': 'DENY',
'Research': 'DENY'
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the custom permissions profile that you want to update.
string
[REQUIRED]
The name of the custom permissions profile that you want to update.
dict
A set of actions to include in the custom permissions profile.
ExportToCsv (string) --
The ability to export to CSV files from the UI.
ExportToExcel (string) --
The ability to export to Excel files from the UI.
ExportToPdf (string) --
The ability to export to PDF files from the UI.
PrintReports (string) --
The ability to print reports.
CreateAndUpdateThemes (string) --
The ability to export to Create and Update themes.
AddOrRunAnomalyDetectionForAnalyses (string) --
The ability to add or run anomaly detection.
ShareAnalyses (string) --
The ability to share analyses.
CreateAndUpdateDatasets (string) --
The ability to create and update datasets.
ShareDatasets (string) --
The ability to share datasets.
SubscribeDashboardEmailReports (string) --
The ability to subscribe to email reports.
CreateAndUpdateDashboardEmailReports (string) --
The ability to create and update email reports.
ShareDashboards (string) --
The ability to share dashboards.
CreateAndUpdateThresholdAlerts (string) --
The ability to create and update threshold alerts.
RenameSharedFolders (string) --
The ability to rename shared folders.
CreateSharedFolders (string) --
The ability to create shared folders.
CreateAndUpdateDataSources (string) --
The ability to create and update data sources.
ShareDataSources (string) --
The ability to share data sources.
ViewAccountSPICECapacity (string) --
The ability to view account SPICE capacity.
CreateSPICEDataset (string) --
The ability to create a SPICE dataset.
ExportToPdfInScheduledReports (string) --
The ability to export to PDF files in scheduled email reports.
ExportToCsvInScheduledReports (string) --
The ability to export to CSV files in scheduled email reports.
ExportToExcelInScheduledReports (string) --
The ability to export to Excel files in scheduled email reports.
IncludeContentInScheduledReportsEmail (string) --
The ability to include content in scheduled email reports.
Dashboard (string) --
The ability to perform dashboard-related actions.
Analysis (string) --
The ability to perform analysis-related actions.
Automate (string) --
The ability to perform automate-related actions.
Flow (string) --
The ability to perform flow-related actions.
PublishWithoutApproval (string) --
The ability to enable approvals for flow share.
UseBedrockModels (string) --
The ability to use Bedrock models for general knowledge step in flows.
PerformFlowUiTask (string) --
The ability to use UI Agent step to perform tasks on public websites.
UseAgentWebSearch (string) --
The ability to use internet to enhance results in Chat Agents, Flows, and Quick Research. Web search queries will be processed securely in an Amazon Web Services region us-east-1.
KnowledgeBase (string) --
The ability to use knowledge bases to specify content from external applications.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
Space (string) --
The ability to perform space-related actions.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
Research (string) --
The ability to perform research-related actions.
dict
Response Syntax
{
'Status': 123,
'Arn': 'string',
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
Arn (string) --
The Amazon Resource Name (ARN) of the custom permissions profile.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DashboardPublishOptions': {'QuickSuiteActionsOption': {'AvailabilityStatus': 'ENABLED '
'| '
'DISABLED'}}}
Updates a dashboard in an Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
# This section is too large to render. # Please see the AWS API Documentation linked below.Parameters
# This section is too large to render. # Please see the AWS API Documentation linked below.
dict
Response Syntax
{
'Arn': 'string',
'VersionArn': 'string',
'DashboardId': 'string',
'CreationStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
VersionArn (string) --
The ARN of the dashboard, including the version number.
DashboardId (string) --
The ID for the dashboard.
CreationStatus (string) --
The creation status of the request.
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}}},
'WebProxyCredentials': {'WebProxyPassword': 'string',
'WebProxyUsername': 'string'}},
'DataSourceParameters': {'ConfluenceParameters': {'ConfluenceUrl': 'string'},
'QBusinessParameters': {'ApplicationArn': 'string'},
'S3KnowledgeBaseParameters': {'BucketUrl': 'string',
'MetadataFilesLocation': 'string',
'RoleArn': 'string'},
'WebCrawlerParameters': {'LoginPageUrl': 'string',
'PasswordButtonXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'UsernameFieldXpath': 'string',
'WebCrawlerAuthType': 'NO_AUTH '
'| '
'BASIC_AUTH '
'| '
'FORM '
'| '
'SAML',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 'integer'}}}
Updates a data source.
See also: AWS API Documentation
Request Syntax
client.update_data_source(
AwsAccountId='string',
DataSourceId='string',
Name='string',
DataSourceParameters={
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'AuroraParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AuroraPostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'AwsIotAnalyticsParameters': {
'DataSetName': 'string'
},
'JiraParameters': {
'SiteBaseUrl': 'string'
},
'MariaDbParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'MySqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'OracleParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'UseServiceName': True|False
},
'PostgreSqlParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'PrestoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'RdsParameters': {
'InstanceId': 'string',
'Database': 'string'
},
'RedshiftParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'ClusterId': 'string',
'IAMParameters': {
'RoleArn': 'string',
'DatabaseUser': 'string',
'DatabaseGroups': [
'string',
],
'AutoCreateDatabaseUser': True|False
},
'IdentityCenterConfiguration': {
'EnableIdentityPropagation': True|False
}
},
'S3Parameters': {
'ManifestFileLocation': {
'Bucket': 'string',
'Key': 'string'
},
'RoleArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'SparkParameters': {
'Host': 'string',
'Port': 123
},
'SqlServerParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TeradataParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string'
},
'TwitterParameters': {
'Query': 'string',
'MaxRows': 123
},
'AmazonOpenSearchParameters': {
'Domain': 'string'
},
'ExasolParameters': {
'Host': 'string',
'Port': 123
},
'DatabricksParameters': {
'Host': 'string',
'Port': 123,
'SqlEndpointPath': 'string'
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string'
}
},
'TrinoParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string'
},
'BigQueryParameters': {
'ProjectId': 'string',
'DataSetRegion': 'string'
},
'ImpalaParameters': {
'Host': 'string',
'Port': 123,
'Database': 'string',
'SqlEndpointPath': 'string'
},
'CustomConnectionParameters': {
'ConnectionType': 'string'
},
'WebCrawlerParameters': {
'WebCrawlerAuthType': 'NO_AUTH'|'BASIC_AUTH'|'FORM'|'SAML',
'UsernameFieldXpath': 'string',
'PasswordFieldXpath': 'string',
'UsernameButtonXpath': 'string',
'PasswordButtonXpath': 'string',
'LoginPageUrl': 'string',
'WebProxyHostName': 'string',
'WebProxyPortNumber': 123
},
'ConfluenceParameters': {
'ConfluenceUrl': 'string'
},
'QBusinessParameters': {
'ApplicationArn': 'string'
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
}
},
VpcConnectionProperties={
'VpcConnectionArn': 'string'
},
SslProperties={
'DisableSsl': True|False
}
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
A display name for the data source.
dict
The parameters that Amazon Quick Sight uses to connect to your underlying source.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
dict
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.
CredentialPair (dict) --
Credential pair. For more information, see ``CredentialPair ``.
Username (string) -- [REQUIRED]
User name.
Password (string) -- [REQUIRED]
Password.
AlternateDataSourceParameters (list) --
A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
(dict) --
The parameters that Quick Sight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
AmazonElasticsearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
AthenaParameters (dict) --
The parameters for Amazon Athena.
WorkGroup (string) --
The workgroup that Amazon Athena uses.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your workgroup.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
AuroraParameters (dict) --
The parameters for Amazon Aurora MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
AuroraPostgreSqlParameters (dict) --
The parameters for Amazon Aurora.
Host (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL-Compatible host to connect to.
Port (integer) -- [REQUIRED]
The port that Amazon Aurora PostgreSQL is listening on.
Database (string) -- [REQUIRED]
The Amazon Aurora PostgreSQL database to connect to.
AwsIotAnalyticsParameters (dict) --
The parameters for IoT Analytics.
DataSetName (string) -- [REQUIRED]
Dataset name.
JiraParameters (dict) --
The parameters for Jira.
SiteBaseUrl (string) -- [REQUIRED]
The base URL of the Jira site.
MariaDbParameters (dict) --
The parameters for MariaDB.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
MySqlParameters (dict) --
The parameters for MySQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
OracleParameters (dict) --
The parameters for Oracle.
Host (string) -- [REQUIRED]
An Oracle host.
Port (integer) -- [REQUIRED]
The port.
Database (string) -- [REQUIRED]
The database.
UseServiceName (boolean) --
A Boolean value that indicates whether the Database uses a service name or an SID. If this value is left blank, the default value is SID. If this value is set to false, the value is SID.
PostgreSqlParameters (dict) --
The parameters for PostgreSQL.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
PrestoParameters (dict) --
The parameters for Presto.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Catalog (string) -- [REQUIRED]
Catalog.
RdsParameters (dict) --
The parameters for Amazon RDS.
InstanceId (string) -- [REQUIRED]
Instance ID.
Database (string) -- [REQUIRED]
Database.
RedshiftParameters (dict) --
The parameters for Amazon Redshift.
Host (string) --
Host. This field can be blank if ClusterId is provided.
Port (integer) --
Port. This field can be blank if the ClusterId is provided.
Database (string) -- [REQUIRED]
Database.
ClusterId (string) --
Cluster ID. This field can be blank if the Host and Port are provided.
IAMParameters (dict) --
An optional parameter that uses IAM authentication to grant Quick Sight access to your cluster. This parameter can be used instead of DataSourceCredentials.
RoleArn (string) -- [REQUIRED]
Use the RoleArn structure to allow Quick Sight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Quick Sight. The role's trust policy must allow the Quick Sight service principal to assume the role.
DatabaseUser (string) --
The user whose permissions and group memberships will be used by Quick Sight to access the cluster. If this user already exists in your database, Amazon Quick Sight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
DatabaseGroups (list) --
A list of groups whose permissions will be granted to Quick Sight to access the cluster. These permissions are combined with the permissions granted to Quick Sight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
(string) --
AutoCreateDatabaseUser (boolean) --
Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Quick Sight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
IdentityCenterConfiguration (dict) --
An optional parameter that configures IAM Identity Center authentication to grant Quick Sight access to your cluster.
This parameter can only be specified if your Quick Sight account is configured with IAM Identity Center.
EnableIdentityPropagation (boolean) --
A Boolean option that controls whether Trusted Identity Propagation should be used.
S3Parameters (dict) --
The parameters for S3.
ManifestFileLocation (dict) -- [REQUIRED]
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Quick Sight.
Bucket (string) -- [REQUIRED]
Amazon S3 bucket.
Key (string) -- [REQUIRED]
Amazon S3 key that identifies an object.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
S3KnowledgeBaseParameters (dict) --
The parameters for S3 Knowledge Base.
RoleArn (string) --
Use the RoleArn structure to override an account-wide role for a specific S3 Knowledge Base data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 Knowledge Base data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
BucketUrl (string) -- [REQUIRED]
The URL of the S3 bucket that contains the knowledge base data.
MetadataFilesLocation (string) --
The location of metadata files within the S3 bucket that describe the structure and content of the knowledge base.
ServiceNowParameters (dict) --
The parameters for ServiceNow.
SiteBaseUrl (string) -- [REQUIRED]
URL of the base site.
SnowflakeParameters (dict) --
The parameters for Snowflake.
Host (string) -- [REQUIRED]
Host.
Database (string) -- [REQUIRED]
Database.
Warehouse (string) -- [REQUIRED]
Warehouse.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
DatabaseAccessControlRole (string) --
The database access control role.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Snowflake.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
SparkParameters (dict) --
The parameters for Spark.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
SqlServerParameters (dict) --
The parameters for SQL Server.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TeradataParameters (dict) --
The parameters for Teradata.
Host (string) -- [REQUIRED]
Host.
Port (integer) -- [REQUIRED]
Port.
Database (string) -- [REQUIRED]
Database.
TwitterParameters (dict) --
The parameters for Twitter.
Query (string) -- [REQUIRED]
Twitter query string.
MaxRows (integer) -- [REQUIRED]
Maximum number of rows to query Twitter.
AmazonOpenSearchParameters (dict) --
The parameters for OpenSearch.
Domain (string) -- [REQUIRED]
The OpenSearch domain.
ExasolParameters (dict) --
The parameters for Exasol.
Host (string) -- [REQUIRED]
The hostname or IP address of the Exasol data source.
Port (integer) -- [REQUIRED]
The port for the Exasol data source.
DatabricksParameters (dict) --
The parameters that are required to connect to a Databricks data source.
Host (string) -- [REQUIRED]
The host name of the Databricks data source.
Port (integer) -- [REQUIRED]
The port for the Databricks data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Databricks data source.
StarburstParameters (dict) --
The parameters that are required to connect to a Starburst data source.
Host (string) -- [REQUIRED]
The host name of the Starburst data source.
Port (integer) -- [REQUIRED]
The port for the Starburst data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Starburst data source.
ProductType (string) --
The product type for the Starburst data source.
DatabaseAccessControlRole (string) --
The database access control role.
AuthenticationType (string) --
The authentication type that you want to use for your connection. This parameter accepts OAuth and non-OAuth authentication types.
OAuthParameters (dict) --
An object that contains information needed to create a data source connection between an Quick Sight account and Starburst.
TokenProviderUrl (string) -- [REQUIRED]
The token endpoint URL of the identity provider.
OAuthScope (string) --
The OAuth scope.
IdentityProviderVpcConnectionProperties (dict) --
VPC connection properties.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
IdentityProviderResourceUri (string) --
The resource uri of the identity provider.
TrinoParameters (dict) --
The parameters that are required to connect to a Trino data source.
Host (string) -- [REQUIRED]
The host name of the Trino data source.
Port (integer) -- [REQUIRED]
The port for the Trino data source.
Catalog (string) -- [REQUIRED]
The catalog name for the Trino data source.
BigQueryParameters (dict) --
The parameters that are required to connect to a Google BigQuery data source.
ProjectId (string) -- [REQUIRED]
The Google Cloud Platform project ID where your datasource was created.
DataSetRegion (string) --
The storage location where you create a Google BigQuery data source.
ImpalaParameters (dict) --
The parameters for Impala.
Host (string) -- [REQUIRED]
The host name of the Impala data source.
Port (integer) -- [REQUIRED]
The port of the Impala data source.
Database (string) --
The database of the Impala data source.
SqlEndpointPath (string) -- [REQUIRED]
The HTTP path of the Impala data source.
CustomConnectionParameters (dict) --
The parameters for custom connectors.
ConnectionType (string) --
The type of custom connector.
WebCrawlerParameters (dict) --
The parameters for Web Crawler.
WebCrawlerAuthType (string) -- [REQUIRED]
The authentication type for the web crawler. The type can be one of the following:
NO_AUTH: No authentication required.
BASIC_AUTH: Basic authentication using username and password.
SAML: SAML-based authentication.
FORM: Form-based authentication.
UsernameFieldXpath (string) --
The XPath expression for locating the username field on the login page.
PasswordFieldXpath (string) --
The XPath expression for locating the password field on the login page.
UsernameButtonXpath (string) --
The XPath expression for locating the username submit button on the login page.
PasswordButtonXpath (string) --
The XPath expression for locating the password submit button on the login page.
LoginPageUrl (string) --
The URL of the login page for the web crawler to authenticate.
WebProxyHostName (string) --
The hostname of the web proxy server for the web crawler.
WebProxyPortNumber (integer) --
The port number of the web proxy server for the web crawler.
ConfluenceParameters (dict) --
The parameters for Confluence.
ConfluenceUrl (string) -- [REQUIRED]
The URL of the Confluence site to connect to.
QBusinessParameters (dict) --
The parameters for Amazon Q Business.
ApplicationArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Q Business application.
CopySourceArn (string) --
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
SecretArn (string) --
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
WebProxyCredentials (dict) --
The credentials for connecting through a web proxy server.
WebProxyUsername (string) -- [REQUIRED]
The username for authenticating with the web proxy server.
WebProxyPassword (string) -- [REQUIRED]
The password for authenticating with the web proxy server.
dict
Use this parameter only when you want Amazon Quick Sight to use a VPC connection when connecting to your underlying source.
VpcConnectionArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the VPC connection.
dict
Secure Socket Layer (SSL) properties that apply when Amazon Quick Sight connects to your underlying source.
DisableSsl (boolean) --
A Boolean option to control whether SSL should be disabled.
dict
Response Syntax
{
'Arn': 'string',
'DataSourceId': 'string',
'UpdateStatus': 'CREATION_IN_PROGRESS'|'CREATION_SUCCESSFUL'|'CREATION_FAILED'|'UPDATE_IN_PROGRESS'|'UPDATE_SUCCESSFUL'|'UPDATE_FAILED'|'DELETED',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the data source.
DataSourceId (string) --
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
UpdateStatus (string) --
The update status of the data source's last update.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.