2026/11/21 - Amazon QuickSight - 26 new17 updated api methods
Changes Quicksight public SDK release for November 20
Updates an inbound connector. You can change its name, description, status, and configuration. You can't change the connector type after the connector is created.
See also: AWS API Documentation
Request Syntax
client.update_inbound_connector(
AwsAccountId='string',
InboundConnectorId='string',
Name='string',
Description='string',
InboundConnectorConfiguration={
'InboundConnectorType': 'QUICK_DESKTOP'
},
InboundConnectorStatus='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the inbound connector.
string
The new name of the inbound connector.
string
The new description of the inbound connector.
dict
The new configuration of the inbound connector. You can't change the InboundConnectorType.
InboundConnectorType (string) -- [REQUIRED]
The type of the inbound connector. You can't change the type after the connector is created.
string
The new status of the inbound connector.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'InboundConnectorId': 'string',
'Arn': 'string',
'InboundConnectorStatus': 'ENABLED'|'DISABLED',
'LastUpdatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
InboundConnectorId (string) --
The ID of the inbound connector.
Arn (string) --
The ARN of the inbound connector.
InboundConnectorStatus (string) --
The status of the inbound connector.
LastUpdatedTime (datetime) --
The time when the inbound connector was last updated.
Removes a governance policy from multiple Amazon Quick Sight principals in a single request. A principal that doesn't have the policy is reported as a success.
Each entry succeeds or fails independently. Check the Errors list in the response for entries that failed.
See also: AWS API Documentation
Request Syntax
client.batch_delete_policy_assignment_by_policy(
AccountId='string',
PolicyArn='string',
PrincipalArns=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the policy and the principals.
string
[REQUIRED]
The ARN of the policy to remove. For each principal, the operation removes the assignment only if the principal currently has this policy.
list
[REQUIRED]
A list of 1–50 principal ARNs to remove the policy from. Each ARN must be unique within the request.
(string) --
dict
Response Syntax
{
'PolicyArn': 'string',
'Success': [
{
'PrincipalArn': 'string'
},
],
'Errors': [
{
'PrincipalArn': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PolicyArn (string) --
The ARN of the policy from the request.
Success (list) --
A list of principals that no longer have the policy.
(dict) --
A principal that no longer has the policy after a BatchDeletePolicyAssignmentByPolicy request, including a principal that didn't have the policy.
PrincipalArn (string) --
The ARN of the principal.
Errors (list) --
A list of principals that the operation couldn't remove the policy from, with the reason for each failure.
(dict) --
A principal that a BatchDeletePolicyAssignmentByPolicy request couldn't remove the policy from.
PrincipalArn (string) --
The ARN of the principal.
ErrorCode (string) --
The reason the entry failed. Possible values:
ValidationException – The entry is not valid.
ResourceNotFoundException – The principal doesn't exist.
ConflictException – The principal has a different policy of the same type, or the assignment changed while this request was being processed.
ThrottlingException – The entry was throttled. You can retry this entry.
InternalFailureException – An internal error occurred.
ErrorMessage (string) --
A description of the error.
Deletes the refresh schedule for an Amazon Quick Sight knowledge base. Delete the schedule when you no longer want the knowledge base to refresh automatically.
See also: AWS API Documentation
Request Syntax
client.delete_knowledge_base_refresh_schedule(
AwsAccountId='string',
KnowledgeBaseId='string',
ScheduleId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
[REQUIRED]
The unique identifier for the refresh schedule to delete.
dict
Response Syntax
{
'ScheduleId': 'string',
'KnowledgeBaseArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ScheduleId (string) --
The unique identifier for the deleted refresh schedule.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base that the schedule applied to.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Deletes a client secret from an access control application.
See also: AWS API Documentation
Request Syntax
client.delete_access_control_application_secret(
AwsAccountId='string',
ApplicationId='string',
ClientSecretId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the access control application.
string
[REQUIRED]
The ID of the client secret.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Deletes an access control application. You can't delete an access control application that is associated with an inbound connector whose status is ENABLED.
If another update to the same application is in progress, Quick Sight returns a ConflictException. Retry the request.
See also: AWS API Documentation
Request Syntax
client.delete_access_control_application(
AwsAccountId='string',
ApplicationId='string',
IdcApplicationArn='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
The ID of the access control application to delete.
string
The ARN of an IAM Identity Center application that Quick Sight created for an access control application that has already been deleted. Provide this ARN to clean up the IAM Identity Center application.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'ApplicationId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ApplicationId (string) --
The ID of the deleted access control application.
Describes the policy of the specified type that an Amazon Quick Sight principal has. If the principal has no policy of that type, the response contains no policy details.
See also: AWS API Documentation
Request Syntax
client.get_policy_assignment(
AccountId='string',
PolicyType='LIMITS_PROFILE'|'CUSTOM_PERMISSIONS',
PrincipalArn='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the principal.
string
[REQUIRED]
The type of policy to describe. Choose one of the following values:
LIMITS_PROFILE – A limits profile that sets resource usage limits.
CUSTOM_PERMISSIONS – A custom permissions profile that restricts the capabilities available to a principal.
string
[REQUIRED]
The ARN of the user, group, or account.
dict
Response Syntax
{
'PolicyArn': 'string',
'PolicyName': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'Revision': 123
}
Response Structure
(dict) --
PolicyArn (string) --
The ARN of the policy that the principal has. The response doesn't include this value if the principal has no policy of the requested type.
PolicyName (string) --
The display name of the assigned policy. This value is absent if the policy has no name or the name can't be retrieved.
UpdatedAt (datetime) --
The date and time that the assignment was last updated.
Revision (integer) --
The current revision of the assignment. Pass this value in a later PutPolicyAssignment or DeletePolicyAssignment request to make sure that the assignment hasn't changed.
Lists the inbound connectors in a Quick Sight account. You can filter the results by connector type. Quick Sight paginates the results. To retrieve additional results, use the NextToken parameter.
See also: AWS API Documentation
Request Syntax
client.list_inbound_connectors(
AwsAccountId='string',
MaxResults=123,
NextToken='string',
Type=[
'QUICK_DESKTOP',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
integer
The maximum number of results to return. The default is 100.
string
The token for the next set of results, or null if there are no more results.
list
The inbound connector type to filter by.
(string) --
The type of an inbound connector. Valid values are the following:
QUICK_DESKTOP: The Quick Sight desktop application.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'InboundConnectorSummaries': [
{
'InboundConnectorId': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'TenantUrl': 'string',
'InboundConnectorConfiguration': {
'InboundConnectorType': 'QUICK_DESKTOP'
},
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
InboundConnectorSummaries (list) --
A list of inbound connector summaries.
(dict) --
A summary of an inbound connector, including its ID, ARN, name, status, tenant URL, configuration, and timestamps.
InboundConnectorId (string) --
The ID of the inbound connector.
Arn (string) --
The ARN of the inbound connector.
Name (string) --
The name of the inbound connector.
Status (string) --
The status of the inbound connector.
CreatedTime (datetime) --
The time when the inbound connector was created.
LastUpdatedTime (datetime) --
The time when the inbound connector was last updated.
TenantUrl (string) --
The endpoint URL that clients use to reach Quick Sight through the inbound connector.
InboundConnectorConfiguration (dict) --
The configuration of the inbound connector.
InboundConnectorType (string) --
The type of the inbound connector. You can't change the type after the connector is created.
Description (string) --
The description of the inbound connector.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Lists the access control applications in a Quick Sight account in the current Amazon Web Services Region. You can filter the results by namespace. Quick Sight paginates the results. To retrieve additional results, use the NextToken parameter.
See also: AWS API Documentation
Request Syntax
client.list_access_control_applications(
AwsAccountId='string',
Namespace='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
The namespace to filter by. If you don't specify a namespace, access control applications in all namespaces are returned.
integer
The maximum number of results to return. The default is 100.
string
The token for the next set of results, or null if there are no more results.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'AccessControlApplications': [
{
'ApplicationId': 'string',
'Arn': 'string',
'Name': 'string',
'Namespace': 'string',
'AuthenticationType': 'OIDC',
'Status': 'ENABLED'|'DISABLED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'TenantUrl': 'string',
'IdpAuthorizingConfiguration': {
'IdpAuthorizingType': 'EXTERNAL_IDP_PUBLIC_AUTH_CODE'|'EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE'|'QUICK_MANAGED_AUTH_CODE'|'IDC_AUTH_CODE',
'IdpAuthorizingConfigurationSummaryDetail': {
'ExternalIdpPublicAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
},
'ExternalIdpConfidentialAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
}
},
'IdcTrustedTokenIssuerConfiguration': {
'IdcTrustedTokenIssuerArn': 'string'
}
},
'QuickAuthenticationConfiguration': {
'QuickAuthenticationType': 'QUICK_MANAGED_PUBLIC_AUTH_CODE',
'QuickAuthenticationConfigurationDetail': {
'QuickManagedPublicAuthCode': {
'RedirectUris': [
'string',
],
'ClientId': 'string'
}
}
},
'Description': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
AccessControlApplications (list) --
A list of access control application summaries.
(dict) --
A summary of an access control application, including its ID, ARN, name, namespace, authentication type, status, and timestamps.
ApplicationId (string) --
The ID of the access control application.
Arn (string) --
The ARN of the access control application.
Name (string) --
The name of the access control application.
Namespace (string) --
The Quick Sight namespace that the access control application belongs to.
AuthenticationType (string) --
The authentication protocol that the access control application uses.
Status (string) --
The status of the access control application.
CreatedTime (datetime) --
The time when the access control application was created.
LastUpdatedTime (datetime) --
The time when the access control application was last updated.
TenantUrl (string) --
The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.
IdpAuthorizingConfiguration (dict) --
A summary of the identity provider configuration of the access control application, without client secret information.
IdpAuthorizingType (string) --
How users of the access control application are authenticated.
IdpAuthorizingConfigurationSummaryDetail (dict) --
The details of the external IdP configuration. This is present when the IdpAuthorizingType is EXTERNAL_IDP_PUBLIC_AUTH_CODE or EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE.
ExternalIdpPublicAuthCode (dict) --
The configuration for an external IdP with a public client.
ClientId (string) --
The OAuth 2.0 client ID.
IssuerUrl (string) --
The issuer URL of the external OpenID Connect IdP.
ExternalIdpConfidentialAuthCode (dict) --
The configuration for an external IdP with a confidential client.
ClientId (string) --
The OAuth 2.0 client ID.
IssuerUrl (string) --
The issuer URL of the external OpenID Connect IdP.
IdcTrustedTokenIssuerConfiguration (dict) --
A trusted token issuer configuration. When you provide it, Quick Sight authenticates the user with the external IdP and then exchanges the token with IAM Identity Center through the specified trusted token issuer. You can't change it after the application is created.
IdcTrustedTokenIssuerArn (string) --
The ARN of the trusted token issuer in IAM Identity Center.
QuickAuthenticationConfiguration (dict) --
The Quick Sight authentication configuration of the access control application. Client secret values are never included.
QuickAuthenticationType (string) --
How the external client authenticates to Quick Sight.
QuickAuthenticationConfigurationDetail (dict) --
The details of the Quick Sight authentication configuration.
QuickManagedPublicAuthCode (dict) --
The configuration of a Quick Sight-managed public client.
RedirectUris (list) --
The OAuth 2.0 redirect URIs of the client.
(string) --
An HTTP or HTTPS URI.
ClientId (string) --
The OAuth 2.0 client ID.
Description (string) --
The description of the access control application.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Lists the access control applications that are associated with an inbound connector. Quick Sight paginates the results. To retrieve additional results, use the NextToken parameter.
See also: AWS API Documentation
Request Syntax
client.list_inbound_connector_application_associations(
AwsAccountId='string',
InboundConnectorId='string',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the inbound connector.
integer
The maximum number of results to return. The default is 100.
string
The token for the next set of results, or null if there are no more results.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'ApplicationAssociations': [
{
'AccessControlApplicationArn': 'string',
'CreatedTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ApplicationAssociations (list) --
A list of the access control applications that are associated with the inbound connector.
(dict) --
An association between an inbound connector and an access control application.
AccessControlApplicationArn (string) --
The ARN of the associated access control application.
CreatedTime (datetime) --
The time when the association was created.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
Lists the Amazon Quick Sight principals that have a governance policy. This operation returns paginated results. A page can contain fewer results than MaxResults, or none, and still include a NextToken. Continue to call the operation until the response doesn't include a NextToken. We recommend that you use pagination to make sure that the operation returns quickly and successfully.
Results are eventually consistent and might not reflect recent changes. If the policy has no assignments, the response contains an empty Principals list. If the policy doesn't exist, the request fails with a ResourceNotFoundException.
See also: AWS API Documentation
Request Syntax
client.list_principals_for_policy(
AccountId='string',
PolicyArn='string',
PrincipalType='USER'|'GROUP'|'ACCOUNT',
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the policy.
string
[REQUIRED]
The ARN of the policy.
string
An optional filter that limits the results to principals of the specified type. If you don't specify a value, the operation returns principals of all types. You can specify one of the following values:
USER – An Amazon Quick Sight user.
GROUP – An Amazon Quick Sight group.
ACCOUNT – The Amazon Quick Sight account.
integer
The maximum number of results to return in a single call. Valid range is 1–100. If you don't specify a value, the operation returns up to 100 results.
string
The token returned by a previous call. Use it to get the next page of results.
dict
Response Syntax
{
'Principals': [
{
'PrincipalArn': 'string',
'PrincipalType': 'USER'|'GROUP'|'ACCOUNT',
'UpdatedAt': datetime(2015, 1, 1),
'Revision': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Principals (list) --
A list of principals that the policy is assigned to.
(dict) --
A principal that a governance policy is assigned to.
PrincipalArn (string) --
The ARN of the user, group, or account.
PrincipalType (string) --
The type of the principal.
UpdatedAt (datetime) --
The date and time that the assignment was last updated.
Revision (integer) --
The current revision of the assignment.
NextToken (string) --
The token for the next page of results. This value is absent if there are no more results.
Lists the refresh schedules for an Amazon Quick Sight knowledge base. Currently, a knowledge base can have only one refresh schedule, so the list contains at most one schedule. Results are paginated. To retrieve the next page of results, use the NextToken value from the previous response.
See also: AWS API Documentation
Request Syntax
client.list_knowledge_base_refresh_schedules(
AwsAccountId='string',
KnowledgeBaseId='string',
NextToken='string',
MaxResults=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
The token for the next set of results. If you don't specify a value, the request returns the first page of results.
integer
The maximum number of results to return in a single page. Valid values are 1 through 100. If you don't specify a value, the default is 25.
dict
Response Syntax
{
'ScheduleSummaries': [
{
'ScheduleId': 'string',
'ScheduleFrequency': {
'Interval': 'DAILY'|'WEEKLY'|'MONTHLY'|'HOURLY',
'RefreshOnDay': {
'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'DayOfMonth': 'string'
}
},
'StartTime': datetime(2015, 1, 1),
'State': 'ENABLED'|'DISABLED'
},
],
'KnowledgeBaseArn': 'string',
'NextToken': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ScheduleSummaries (list) --
A list of refresh schedules for the knowledge base.
(dict) --
A summary of a knowledge base refresh schedule, including its identifier, frequency, start time, and state. The DescribeKnowledgeBaseRefreshSchedule and ListKnowledgeBaseRefreshSchedules operations return this summary.
ScheduleId (string) --
The unique identifier for the refresh schedule.
ScheduleFrequency (dict) --
The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.
Interval (string) --
The interval at which the schedule refreshes the knowledge base. Valid values include:
DAILY – The schedule refreshes the knowledge base once each day.
WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.
MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.
HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.
For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.
RefreshOnDay (dict) --
The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
DayOfWeek (string) --
The day of the week on which a weekly refresh runs.
DayOfMonth (string) --
The day of the month on which a monthly refresh runs. Valid values include:
1 through 28 – The refresh runs on that day of each month.
LAST_DAY_OF_MONTH – The refresh runs on the last day of each month.
StartTime (datetime) --
The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.
State (string) --
The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base that the schedules apply to.
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 the Amazon Web Services Secrets Manager secret ARNs of an IdP-provided client secret. You can add, replace, or remove the ARN for a Region, but you can't remove the last remaining Region. To remove it, delete the client secret.
See also: AWS API Documentation
Request Syntax
client.update_access_control_application_secret(
AwsAccountId='string',
ApplicationId='string',
ClientSecretId='string',
UpdateRegionalSecretManagerArns={
'string': 'string'
},
RemoveRegionalSecretManagerArns=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the access control application.
string
[REQUIRED]
The ID of the client secret.
dict
The Region ARNs to add or replace. The Region in each ARN must match its key.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
(string) --
The ARN of an Amazon Web Services Secrets Manager secret.
list
The Regions whose ARNs to remove. You can't remove the last remaining Region. To remove it, delete the client secret instead.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'ClientSecretId': 'string',
'UpdatedAt': datetime(2015, 1, 1),
'RegionalSecretManagerArns': {
'string': 'string'
}
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ClientSecretId (string) --
The ID of the client secret.
UpdatedAt (datetime) --
The time when the client secret was updated.
RegionalSecretManagerArns (dict) --
The Region ARNs of the client secret after the update.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
(string) --
The ARN of an Amazon Web Services Secrets Manager secret.
Deletes an inbound connector. You must disable the connector before you can delete it. When you delete a connector, Quick Sight doesn't delete the access control applications that are associated with it.
See also: AWS API Documentation
Request Syntax
client.delete_inbound_connector(
AwsAccountId='string',
InboundConnectorId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the inbound connector.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'InboundConnectorId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
InboundConnectorId (string) --
The ID of the deleted inbound connector.
Creates a client secret for an access control application. An access control application can have up to two client secrets, so that you can rotate a secret without downtime.
Provide the Amazon Web Services Secrets Manager (Secrets Manager) secret ARN for each Region where the client secret, issued by your identity provider (IdP), is stored.
See also: AWS API Documentation
Request Syntax
client.create_access_control_application_secret(
AwsAccountId='string',
ApplicationId='string',
Description='string',
ClientSecretConfiguration={
'ClientSecretSourceType': 'IDP_PROVIDED',
'ClientSecretConfigurationDetail': {
'Idp': {
'RegionalSecretManagerArns': {
'string': 'string'
}
}
}
}
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the access control application.
string
A description of the client secret, for example rotation-june-2026. If you don't provide a description, the client secret has no description.
dict
[REQUIRED]
The source of the client secret, which is your IdP, and the Amazon Web Services Secrets Manager ARNs of the secret.
ClientSecretSourceType (string) -- [REQUIRED]
The source of the client secret. The only valid value is IDP_PROVIDED: your IdP issued the secret value.
ClientSecretConfigurationDetail (dict) --
The details of the client secret. This is required when the ClientSecretSourceType is IDP_PROVIDED.
Idp (dict) --
An IdP-provided client secret, with the Amazon Web Services Secrets Manager secret ARN for each Region.
RegionalSecretManagerArns (dict) -- [REQUIRED]
The ARN of the Amazon Web Services Secrets Manager secret that holds the client secret, for each Region.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
(string) --
The ARN of an Amazon Web Services Secrets Manager secret.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'ClientSecretId': 'string',
'CreatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ClientSecretId (string) --
The ID of the client secret.
CreatedAt (datetime) --
The time when the client secret was created.
Describes an inbound connector.
See also: AWS API Documentation
Request Syntax
client.describe_inbound_connector(
AwsAccountId='string',
InboundConnectorId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the inbound connector.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'InboundConnector': {
'InboundConnectorId': 'string',
'Arn': 'string',
'Name': 'string',
'Status': 'ENABLED'|'DISABLED',
'TenantUrl': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'InboundConnectorConfiguration': {
'InboundConnectorType': 'QUICK_DESKTOP'
},
'Description': 'string'
}
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
InboundConnector (dict) --
The inbound connector.
InboundConnectorId (string) --
The ID of the inbound connector.
Arn (string) --
The ARN of the inbound connector.
Name (string) --
The name of the inbound connector.
Status (string) --
The status of the inbound connector.
TenantUrl (string) --
The endpoint URL that clients use to reach Quick Sight through the inbound connector.
CreatedTime (datetime) --
The time when the inbound connector was created.
LastUpdatedTime (datetime) --
The time when the inbound connector was last updated.
InboundConnectorConfiguration (dict) --
The configuration of the inbound connector.
InboundConnectorType (string) --
The type of the inbound connector. You can't change the type after the connector is created.
Description (string) --
The description of the inbound connector.
Assigns a governance policy to an Amazon Quick Sight principal. A principal can have one policy of each policy type. If the principal already has a policy of the same type, this operation replaces it.
To make the change conditional, specify ExistingPolicyArn, Revision, or both. If the current assignment doesn't match, the request fails with a ConflictException and makes no change. If the principal already has the specified policy, the request succeeds and makes no change.
See also: AWS API Documentation
Request Syntax
client.put_policy_assignment(
AccountId='string',
PolicyArn='string',
PrincipalArn='string',
ExistingPolicyArn='string',
Revision=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the policy and the principal.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the policy to assign.
string
[REQUIRED]
The ARN of the user, group, or account to assign the policy to.
string
The ARN of the policy that you expect the principal to have before this request. If the principal has a different policy of the same type, or no policy of that type, the request fails with a ConflictException and makes no change. If you don't specify a value, the operation doesn't check the existing assignment.
integer
The revision of the assignment from your most recent read. If the assignment has changed since that revision, the request fails with a ConflictException. If you don't specify a value, the operation doesn't check the revision.
dict
Response Syntax
{
'PolicyArn': 'string',
'ReplacedPolicyArn': 'string',
'Revision': 123
}
Response Structure
(dict) --
PolicyArn (string) --
The ARN of the policy that is now assigned to the principal.
ReplacedPolicyArn (string) --
The ARN of the policy that this request replaced. This value is absent if the principal had no policy of this type before the request.
Revision (integer) --
The revision of the assignment after this request. Use this value in later requests to detect concurrent changes.
Creates an inbound connector in a Quick Sight account. An inbound connector is the endpoint that an external client, such as the Quick Sight desktop application, uses to reach Quick Sight in your account.
Your users authenticate through the access control applications that are associated with the connector. To manage these associations, use UpdateInboundConnectorApplicationAssociations.
An account can have one QUICK_DESKTOP inbound connector in each Region.
See also: AWS API Documentation
Request Syntax
client.create_inbound_connector(
AwsAccountId='string',
InboundConnectorId='string',
Name='string',
Description='string',
InboundConnectorConfiguration={
'InboundConnectorType': 'QUICK_DESKTOP'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID for the inbound connector. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
For a QUICK_DESKTOP inbound connector, the ID must be ibc-desktop- followed by your Amazon Web Services account ID and the Region that you call, separated by a hyphen. For example, ibc-desktop-111122223333-us-east-1. Quick Sight reserves IDs that start with ibc-desktop- for QUICK_DESKTOP inbound connectors.
string
[REQUIRED]
The name of the inbound connector.
string
The description of the inbound connector.
dict
[REQUIRED]
The configuration of the inbound connector.
InboundConnectorType (string) -- [REQUIRED]
The type of the inbound connector. You can't change the type after the connector is created.
list
The tags to assign to the inbound connector.
(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,
'RequestId': 'string',
'InboundConnectorId': 'string',
'Arn': 'string',
'TenantUrl': 'string',
'InboundConnectorStatus': 'ENABLED'|'DISABLED',
'CreatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
InboundConnectorId (string) --
The ID of the inbound connector.
Arn (string) --
The ARN of the inbound connector.
TenantUrl (string) --
The endpoint URL that clients use to reach Quick Sight through the inbound connector.
InboundConnectorStatus (string) --
The status of the inbound connector. A new connector is always ENABLED.
CreatedTime (datetime) --
The time when the inbound connector was created.
Updates the refresh schedule for an Amazon Quick Sight knowledge base. Use this operation to change how often the knowledge base refreshes, or to enable or disable the schedule. Specify the schedule by its ScheduleId. The operation changes only the fields that you provide. Any field that you omit keeps its existing value.
See also: AWS API Documentation
Request Syntax
client.update_knowledge_base_refresh_schedule(
AwsAccountId='string',
KnowledgeBaseId='string',
ScheduleId='string',
ScheduleFrequency={
'Interval': 'DAILY'|'WEEKLY'|'MONTHLY'|'HOURLY',
'RefreshOnDay': {
'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'DayOfMonth': 'string'
}
},
StartTime=datetime(2015, 1, 1),
State='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
[REQUIRED]
The unique identifier for the refresh schedule to update.
dict
The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs. If you don't specify this parameter, the schedule keeps its existing frequency.
Interval (string) -- [REQUIRED]
The interval at which the schedule refreshes the knowledge base. Valid values include:
DAILY – The schedule refreshes the knowledge base once each day.
WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.
MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.
HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.
For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.
RefreshOnDay (dict) --
The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
DayOfWeek (string) --
The day of the week on which a weekly refresh runs.
DayOfMonth (string) --
The day of the month on which a monthly refresh runs. Valid values include:
1 through 28 – The refresh runs on that day of each month.
LAST_DAY_OF_MONTH – The refresh runs on the last day of each month.
datetime
The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base. The first refresh runs at the next scheduled time after this date and time. If you don't specify this parameter, the schedule keeps its existing start time.
string
The state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes. If you don't specify this parameter, the schedule keeps its existing state.
dict
Response Syntax
{
'ScheduleId': 'string',
'KnowledgeBaseArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ScheduleId (string) --
The unique identifier for the refresh schedule.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base that the schedule applies to.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Updates an access control application. You can change its name, description, status, IdP settings such as the client ID and issuer URL, and its Quick Sight authentication settings such as redirect URIs.
You can't change the IdpAuthorizingType, the QuickAuthenticationType, or the trusted token issuer after the application is created. To manage client secrets, use CreateAccessControlApplicationSecret, UpdateAccessControlApplicationSecret, and DeleteAccessControlApplicationSecret.
See also: AWS API Documentation
Request Syntax
client.update_access_control_application(
AwsAccountId='string',
ApplicationId='string',
Name='string',
Description='string',
IdpAuthorizingConfiguration={
'IdpAuthorizingType': 'EXTERNAL_IDP_PUBLIC_AUTH_CODE'|'EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE'|'QUICK_MANAGED_AUTH_CODE'|'IDC_AUTH_CODE',
'IdpAuthorizingConfigurationDetailInput': {
'ExternalIdpPublicAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
},
'ExternalIdpConfidentialAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
}
},
'IdcTrustedTokenIssuerConfiguration': {
'IdcTrustedTokenIssuerArn': 'string'
}
},
QuickAuthenticationConfiguration={
'QuickAuthenticationType': 'QUICK_MANAGED_PUBLIC_AUTH_CODE',
'QuickAuthenticationConfigurationDetailInput': {
'QuickManagedPublicAuthCode': {
'RedirectUris': [
'string',
]
}
}
},
Status='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the access control application.
string
The new name of the access control application.
string
The new description of the access control application.
dict
The identity provider settings to update, such as the client ID and issuer URL. You can't change the IdpAuthorizingType or the trusted token issuer. To manage client secrets, use the client secret operations.
IdpAuthorizingType (string) -- [REQUIRED]
How users of the access control application are authenticated.
IdpAuthorizingConfigurationDetailInput (dict) --
The details of the external IdP configuration. This is present when the IdpAuthorizingType is EXTERNAL_IDP_PUBLIC_AUTH_CODE or EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE.
ExternalIdpPublicAuthCode (dict) --
The configuration for an external IdP with a public client.
ClientId (string) -- [REQUIRED]
The OAuth 2.0 client ID.
IssuerUrl (string) -- [REQUIRED]
The issuer URL of the external OpenID Connect IdP.
ExternalIdpConfidentialAuthCode (dict) --
The configuration for an external IdP with a confidential client.
ClientId (string) -- [REQUIRED]
The OAuth 2.0 client ID.
IssuerUrl (string) -- [REQUIRED]
The issuer URL of the external OpenID Connect IdP.
IdcTrustedTokenIssuerConfiguration (dict) --
A trusted token issuer configuration. When you provide it, Quick Sight authenticates the user with the external IdP and then exchanges the token with IAM Identity Center through the specified trusted token issuer. You can't change it after the application is created.
IdcTrustedTokenIssuerArn (string) -- [REQUIRED]
The ARN of the trusted token issuer in IAM Identity Center.
dict
The Quick Sight authentication settings to update, such as redirect URIs. You can't change the QuickAuthenticationType.
QuickAuthenticationType (string) -- [REQUIRED]
How the external client authenticates to Quick Sight.
QuickAuthenticationConfigurationDetailInput (dict) --
The details of the Quick Sight authentication configuration.
QuickManagedPublicAuthCode (dict) --
The configuration of a Quick Sight-managed public client.
RedirectUris (list) -- [REQUIRED]
The OAuth 2.0 redirect URIs of the client.
(string) --
An HTTP or HTTPS URI.
string
The new status of the access control application.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'ApplicationId': 'string',
'Arn': 'string',
'AccessControlApplicationStatus': 'ENABLED'|'DISABLED',
'LastUpdatedTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ApplicationId (string) --
The ID of the access control application.
Arn (string) --
The ARN of the access control application.
AccessControlApplicationStatus (string) --
The status of the access control application.
LastUpdatedTime (datetime) --
The time when the access control application was last updated.
Describes the refresh schedule for an Amazon Quick Sight knowledge base, including the schedule's frequency, start time, and state.
See also: AWS API Documentation
Request Syntax
client.describe_knowledge_base_refresh_schedule(
AwsAccountId='string',
KnowledgeBaseId='string',
ScheduleId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
[REQUIRED]
The unique identifier for the refresh schedule.
dict
Response Syntax
{
'Schedule': {
'ScheduleId': 'string',
'ScheduleFrequency': {
'Interval': 'DAILY'|'WEEKLY'|'MONTHLY'|'HOURLY',
'RefreshOnDay': {
'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'DayOfMonth': 'string'
}
},
'StartTime': datetime(2015, 1, 1),
'State': 'ENABLED'|'DISABLED'
},
'KnowledgeBaseArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Schedule (dict) --
The refresh schedule for the knowledge base.
ScheduleId (string) --
The unique identifier for the refresh schedule.
ScheduleFrequency (dict) --
The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.
Interval (string) --
The interval at which the schedule refreshes the knowledge base. Valid values include:
DAILY – The schedule refreshes the knowledge base once each day.
WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.
MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.
HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.
For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.
RefreshOnDay (dict) --
The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
DayOfWeek (string) --
The day of the week on which a weekly refresh runs.
DayOfMonth (string) --
The day of the month on which a monthly refresh runs. Valid values include:
1 through 28 – The refresh runs on that day of each month.
LAST_DAY_OF_MONTH – The refresh runs on the last day of each month.
StartTime (datetime) --
The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base.
State (string) --
The current state of the refresh schedule. A schedule that isn't ENABLED doesn't run refreshes.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base that the schedule applies to.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Creates an access control application in an Amazon Quick Sight account. You use an access control application to define how an external client signs in to Quick Sight with OAuth 2.0.
To connect a client to Quick Sight through an inbound connector, associate the access control application with the connector by using the UpdateInboundConnectorApplicationAssociations operation.
See also: AWS API Documentation
Request Syntax
client.create_access_control_application(
AwsAccountId='string',
ApplicationId='string',
Name='string',
Description='string',
Namespace='string',
AuthenticationType='OIDC',
IdpAuthorizingConfiguration={
'IdpAuthorizingType': 'EXTERNAL_IDP_PUBLIC_AUTH_CODE'|'EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE'|'QUICK_MANAGED_AUTH_CODE'|'IDC_AUTH_CODE',
'IdpAuthorizingConfigurationDetailInput': {
'ExternalIdpPublicAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
},
'ExternalIdpConfidentialAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string',
'ClientSecret': {
'RegionalSecretManagerArns': {
'string': 'string'
}
}
}
},
'IdcTrustedTokenIssuerConfiguration': {
'IdcTrustedTokenIssuerArn': 'string'
}
},
QuickAuthenticationConfiguration={
'QuickAuthenticationType': 'QUICK_MANAGED_PUBLIC_AUTH_CODE',
'QuickAuthenticationConfigurationDetailInput': {
'QuickManagedPublicAuthCode': {
'RedirectUris': [
'string',
]
}
}
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID for the access control application. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Quick Sight reserves IDs that start with quick-aca- for the access control application of the Quick Sight desktop application. To create one, the ID must be quick-aca- followed by your Amazon Web Services account ID and the namespace, separated by a hyphen. For example, quick-aca-111122223333-default. In addition, QuickAuthenticationType must be QUICK_MANAGED_PUBLIC_AUTH_CODE with http://localhost:18080 as the only redirect URI, and IdpAuthorizingType must be IDC_AUTH_CODE or QUICK_MANAGED_AUTH_CODE.
string
[REQUIRED]
The name of the access control application.
string
The description of the access control application.
string
[REQUIRED]
The Quick Sight namespace for the access control application.
string
[REQUIRED]
The authentication protocol that the access control application uses.
dict
[REQUIRED]
The identity provider configuration of the access control application.
IdpAuthorizingType (string) -- [REQUIRED]
How users of the access control application are authenticated.
IdpAuthorizingConfigurationDetailInput (dict) --
The details of the external IdP configuration. This is present when the IdpAuthorizingType is EXTERNAL_IDP_PUBLIC_AUTH_CODE or EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE.
ExternalIdpPublicAuthCode (dict) --
The configuration for an external IdP with a public client.
ClientId (string) -- [REQUIRED]
The OAuth 2.0 client ID.
IssuerUrl (string) -- [REQUIRED]
The issuer URL of the external OpenID Connect IdP.
ExternalIdpConfidentialAuthCode (dict) --
The configuration for an external IdP with a confidential client.
ClientId (string) -- [REQUIRED]
The OAuth 2.0 client ID.
IssuerUrl (string) -- [REQUIRED]
The issuer URL of the external OpenID Connect IdP.
ClientSecret (dict) -- [REQUIRED]
The first client secret of the confidential client.
RegionalSecretManagerArns (dict) -- [REQUIRED]
The ARN of the Amazon Web Services Secrets Manager secret that holds the client secret, for each Region.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
(string) --
The ARN of an Amazon Web Services Secrets Manager secret.
IdcTrustedTokenIssuerConfiguration (dict) --
A trusted token issuer configuration. When you provide it, Quick Sight authenticates the user with the external IdP and then exchanges the token with IAM Identity Center through the specified trusted token issuer. You can't change it after the application is created.
This is required when the application uses an external IdP and its namespace uses IAM Identity Center.
IdcTrustedTokenIssuerArn (string) -- [REQUIRED]
The ARN of the trusted token issuer in IAM Identity Center.
dict
[REQUIRED]
The Quick Sight authentication configuration of the access control application. You provide redirect URIs, and Quick Sight generates the client ID.
QuickAuthenticationType (string) -- [REQUIRED]
How the external client authenticates to Quick Sight.
QuickAuthenticationConfigurationDetailInput (dict) --
The details of the Quick Sight authentication configuration.
QuickManagedPublicAuthCode (dict) --
The configuration of a Quick Sight-managed public client.
RedirectUris (list) -- [REQUIRED]
The OAuth 2.0 redirect URIs of the client.
(string) --
An HTTP or HTTPS URI.
list
The tags to assign to the access control application.
(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,
'RequestId': 'string',
'ApplicationId': 'string',
'Arn': 'string',
'AccessControlApplicationStatus': 'ENABLED'|'DISABLED',
'CreatedTime': datetime(2015, 1, 1),
'TenantUrl': 'string',
'IdcApplicationArn': 'string',
'QuickAuthenticationConfiguration': {
'QuickAuthenticationType': 'QUICK_MANAGED_PUBLIC_AUTH_CODE',
'QuickAuthenticationConfigurationDetailCreateOutput': {
'QuickManagedPublicAuthCode': {
'RedirectUris': [
'string',
],
'ClientId': 'string'
}
}
}
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
ApplicationId (string) --
The ID of the access control application.
Arn (string) --
The ARN of the access control application.
AccessControlApplicationStatus (string) --
The status of the access control application. A new application is always ENABLED.
CreatedTime (datetime) --
The time when the access control application was created.
TenantUrl (string) --
The tenant URL of the access control application.
IdcApplicationArn (string) --
The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the IdpAuthorizingType is IDC_AUTH_CODE, or when a trusted token issuer is configured.
QuickAuthenticationConfiguration (dict) --
The generated Quick Sight authentication configuration. It contains the generated client ID.
QuickAuthenticationType (string) --
How the external client authenticates to Quick Sight.
QuickAuthenticationConfigurationDetailCreateOutput (dict) --
The details of the Quick Sight authentication configuration.
QuickManagedPublicAuthCode (dict) --
The configuration of a Quick Sight-managed public client.
RedirectUris (list) --
The OAuth 2.0 redirect URIs of the client.
(string) --
An HTTP or HTTPS URI.
ClientId (string) --
The OAuth 2.0 client ID.
Describes an access control application. The response includes client secret metadata, but never client secret values.
See also: AWS API Documentation
Request Syntax
client.describe_access_control_application(
AwsAccountId='string',
ApplicationId='string'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the access control application.
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string',
'AccessControlApplication': {
'ApplicationId': 'string',
'Arn': 'string',
'Name': 'string',
'Namespace': 'string',
'AuthenticationType': 'OIDC',
'Status': 'ENABLED'|'DISABLED',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'TenantUrl': 'string',
'Description': 'string',
'IdcApplicationArn': 'string',
'IdpAuthorizingConfiguration': {
'IdpAuthorizingType': 'EXTERNAL_IDP_PUBLIC_AUTH_CODE'|'EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE'|'QUICK_MANAGED_AUTH_CODE'|'IDC_AUTH_CODE',
'IdpAuthorizingConfigurationDetail': {
'ExternalIdpPublicAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string'
},
'ExternalIdpConfidentialAuthCode': {
'ClientId': 'string',
'IssuerUrl': 'string',
'ClientSecrets': [
{
'ClientSecretId': 'string',
'RegionalSecretManagerArns': {
'string': 'string'
},
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1),
'Description': 'string'
},
]
}
},
'IdcTrustedTokenIssuerConfiguration': {
'IdcTrustedTokenIssuerArn': 'string'
}
},
'QuickAuthenticationConfiguration': {
'QuickAuthenticationType': 'QUICK_MANAGED_PUBLIC_AUTH_CODE',
'QuickAuthenticationConfigurationDetail': {
'QuickManagedPublicAuthCode': {
'RedirectUris': [
'string',
],
'ClientId': 'string'
}
}
}
}
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
AccessControlApplication (dict) --
The access control application.
ApplicationId (string) --
The ID of the access control application.
Arn (string) --
The ARN of the access control application.
Name (string) --
The name of the access control application.
Namespace (string) --
The Quick Sight namespace that the access control application belongs to.
AuthenticationType (string) --
The authentication protocol that the access control application uses.
Status (string) --
The status of the access control application.
CreatedTime (datetime) --
The time when the access control application was created.
LastUpdatedTime (datetime) --
The time when the access control application was last updated.
TenantUrl (string) --
The tenant URL of the access control application. This URL hosts the OAuth 2.0 and OpenID Connect endpoints for the application, such as /authorize, /token, /.well-known/openid-configuration, and /jwks.
Description (string) --
The description of the access control application.
IdcApplicationArn (string) --
The ARN of the Amazon Web Services IAM Identity Center application that Quick Sight manages for this access control application. This value is present when the IdpAuthorizingType is IDC_AUTH_CODE, or when a trusted token issuer is configured.
IdpAuthorizingConfiguration (dict) --
The identity provider configuration of the access control application. Client secret values are never included.
IdpAuthorizingType (string) --
How users of the access control application are authenticated.
IdpAuthorizingConfigurationDetail (dict) --
The details of the external IdP configuration. This is present when the IdpAuthorizingType is EXTERNAL_IDP_PUBLIC_AUTH_CODE or EXTERNAL_IDP_CONFIDENTIAL_AUTH_CODE.
ExternalIdpPublicAuthCode (dict) --
The configuration for an external IdP with a public client.
ClientId (string) --
The OAuth 2.0 client ID.
IssuerUrl (string) --
The issuer URL of the external OpenID Connect IdP.
ExternalIdpConfidentialAuthCode (dict) --
The configuration for an external IdP with a confidential client.
ClientId (string) --
The OAuth 2.0 client ID.
IssuerUrl (string) --
The issuer URL of the external OpenID Connect IdP.
ClientSecrets (list) --
The client secrets of the confidential client, with the Amazon Web Services Secrets Manager ARN for each Region. Secret values are never included.
(dict) --
A client secret of a confidential external IdP client. Secret values are never included.
ClientSecretId (string) --
The ID of the client secret.
RegionalSecretManagerArns (dict) --
The ARN of the Amazon Web Services Secrets Manager secret that holds the client secret, for each Region.
(string) --
An Amazon Web Services Region code, for example aa-example-1.
(string) --
The ARN of an Amazon Web Services Secrets Manager secret.
CreatedAt (datetime) --
The time when the client secret was created.
UpdatedAt (datetime) --
The time when the secret's Region ARNs were last updated. This value is present only after you call UpdateAccessControlApplicationSecret.
Description (string) --
The description of the client secret.
IdcTrustedTokenIssuerConfiguration (dict) --
A trusted token issuer configuration. When you provide it, Quick Sight authenticates the user with the external IdP and then exchanges the token with IAM Identity Center through the specified trusted token issuer. You can't change it after the application is created.
IdcTrustedTokenIssuerArn (string) --
The ARN of the trusted token issuer in IAM Identity Center.
QuickAuthenticationConfiguration (dict) --
The Quick Sight authentication configuration of the access control application. Client secret values are never included.
QuickAuthenticationType (string) --
How the external client authenticates to Quick Sight.
QuickAuthenticationConfigurationDetail (dict) --
The details of the Quick Sight authentication configuration.
QuickManagedPublicAuthCode (dict) --
The configuration of a Quick Sight-managed public client.
RedirectUris (list) --
The OAuth 2.0 redirect URIs of the client.
(string) --
An HTTP or HTTPS URI.
ClientId (string) --
The OAuth 2.0 client ID.
Creates a schedule that periodically refreshes an Amazon Quick Sight knowledge base at the frequency that you specify.
A knowledge base can have only one refresh schedule. If the knowledge base already has a refresh schedule, the request fails with a LimitExceededException.
See also: AWS API Documentation
Request Syntax
client.create_knowledge_base_refresh_schedule(
AwsAccountId='string',
KnowledgeBaseId='string',
ScheduleId='string',
ScheduleFrequency={
'Interval': 'DAILY'|'WEEKLY'|'MONTHLY'|'HOURLY',
'RefreshOnDay': {
'DayOfWeek': 'SUNDAY'|'MONDAY'|'TUESDAY'|'WEDNESDAY'|'THURSDAY'|'FRIDAY'|'SATURDAY',
'DayOfMonth': 'string'
}
},
StartTime=datetime(2015, 1, 1),
State='ENABLED'|'DISABLED'
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the knowledge base.
string
[REQUIRED]
The unique identifier for the knowledge base.
string
[REQUIRED]
A unique identifier for the knowledge base refresh schedule.
dict
[REQUIRED]
The frequency configuration for the refresh schedule. The frequency configuration specifies how often the schedule runs and, for weekly or monthly schedules, the day on which it runs.
Interval (string) -- [REQUIRED]
The interval at which the schedule refreshes the knowledge base. Valid values include:
DAILY – The schedule refreshes the knowledge base once each day.
WEEKLY – The schedule refreshes the knowledge base once each week, on the day that you specify in RefreshOnDay.DayOfWeek.
MONTHLY – The schedule refreshes the knowledge base once each month, on the day that you specify in RefreshOnDay.DayOfMonth.
HOURLY – The schedule refreshes the knowledge base once each hour. Available only if your account is enabled for hourly refresh. Otherwise, the request fails with an InvalidParameterValueException.
For DAILY, WEEKLY, and MONTHLY intervals, the service chooses the time of day at which the refresh runs. You can't specify the time of day.
RefreshOnDay (dict) --
The day on which the refresh runs. This parameter is required for a WEEKLY or MONTHLY interval: specify the day of the week for WEEKLY or the day of the month for MONTHLY. If you don't specify it for one of these intervals, the request fails. This parameter isn't used for a DAILY or HOURLY interval.
DayOfWeek (string) --
The day of the week on which a weekly refresh runs.
DayOfMonth (string) --
The day of the month on which a monthly refresh runs. Valid values include:
1 through 28 – The refresh runs on that day of each month.
LAST_DAY_OF_MONTH – The refresh runs on the last day of each month.
datetime
The date and time, in ISO 8601 format, after which the schedule can start refreshing the knowledge base. The first refresh runs at the next scheduled time after this date and time. If you don't specify a value, the schedule becomes active immediately, and the first refresh runs at the next scheduled time.
string
The state that you want the refresh schedule to have when you create it. If you don't specify a state, the schedule is created in the ENABLED state. A schedule that isn't ENABLED doesn't run refreshes.
dict
Response Syntax
{
'ScheduleId': 'string',
'KnowledgeBaseArn': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
ScheduleId (string) --
The unique identifier for the refresh schedule.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the knowledge base that the schedule applies to.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
Removes a governance policy from an Amazon Quick Sight principal. If the principal doesn't have the specified policy, the request succeeds and makes no change. If the principal has a different policy of the same type, the request fails with a ConflictException.
See also: AWS API Documentation
Request Syntax
client.delete_policy_assignment(
AccountId='string',
PolicyArn='string',
PrincipalArn='string',
Revision=123
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the principal.
string
[REQUIRED]
The ARN of the policy to remove. The operation removes the assignment only if the principal currently has this policy.
string
[REQUIRED]
The ARN of the user, group, or account to remove the policy from.
integer
The revision of the assignment from your most recent read. If the assignment has changed since that revision, the request fails with a ConflictException. If you don't specify a value, the operation doesn't check the revision.
dict
Response Syntax
{}
Response Structure
(dict) --
Assigns a governance policy to multiple Amazon Quick Sight principals in a single request. If a principal already has a policy of the same type, this operation replaces it.
Each entry succeeds or fails independently. Check the Errors list in the response for entries that failed.
See also: AWS API Documentation
Request Syntax
client.batch_put_policy_assignment_by_policy(
AccountId='string',
PolicyArn='string',
Assignments=[
{
'PrincipalArn': 'string',
'ExistingPolicyArn': 'string',
'Revision': 123
},
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the policy and the principals.
string
[REQUIRED]
The ARN of the policy to assign.
list
[REQUIRED]
A list of 1–50 principals to assign the policy to. Each principal ARN must be unique within the request.
(dict) --
A principal to assign a policy to in a BatchPutPolicyAssignmentByPolicy request.
PrincipalArn (string) -- [REQUIRED]
The ARN of the user, group, or account to assign the policy to.
ExistingPolicyArn (string) --
The ARN of the policy that you expect the principal to have before this request. If the principal has a different policy of the same type, or no policy of that type, this entry fails with a ConflictException error code and makes no change.
Revision (integer) --
The revision of the assignment from your most recent read. If the assignment has changed since that revision, this entry fails with a ConflictException error code.
dict
Response Syntax
{
'PolicyArn': 'string',
'Success': [
{
'PrincipalArn': 'string',
'ReplacedPolicyArn': 'string',
'Revision': 123
},
],
'Errors': [
{
'PrincipalArn': 'string',
'ErrorCode': 'string',
'ErrorMessage': 'string'
},
]
}
Response Structure
(dict) --
PolicyArn (string) --
The ARN of the policy from the request.
Success (list) --
A list of principals that the policy was assigned to.
(dict) --
A principal that a BatchPutPolicyAssignmentByPolicy request assigned the policy to.
PrincipalArn (string) --
The ARN of the principal.
ReplacedPolicyArn (string) --
The ARN of the policy that this assignment replaced. This value is absent if the principal had no policy of this type before the request.
Revision (integer) --
The revision of the assignment after this request.
Errors (list) --
A list of principals that the policy couldn't be assigned to, with the reason for each failure.
(dict) --
A principal that a BatchPutPolicyAssignmentByPolicy request couldn't assign the policy to.
PrincipalArn (string) --
The ARN of the principal.
ErrorCode (string) --
The reason the entry failed. Possible values:
ValidationException – The entry is not valid.
ResourceNotFoundException – The principal doesn't exist, or the policy was deleted while the request was being processed.
ConflictException – The principal doesn't have the existing policy that you specified, or the assignment changed since the revision that you specified.
ThrottlingException – The entry was throttled. You can retry this entry.
InternalFailureException – An internal error occurred.
ErrorMessage (string) --
A description of the error.
Associates access control applications with an inbound connector, disassociates them from it, or both. You can add up to 20 associations and remove up to 20 associations in each request. An inbound connector supports up to 6,000 associations.
See also: AWS API Documentation
Request Syntax
client.update_inbound_connector_application_associations(
AwsAccountId='string',
InboundConnectorId='string',
AssociateAccessControlApplications=[
'string',
],
DisassociateAccessControlApplications=[
'string',
]
)
string
[REQUIRED]
The ID of the Amazon Web Services account that contains the Quick Sight account.
string
[REQUIRED]
The ID of the inbound connector.
list
The ARNs of up to 20 access control applications to associate with the inbound connector. ARNs that are already associated are ignored.
(string) --
list
The ARNs of up to 20 access control applications to disassociate from the inbound connector. ARNs that aren't associated are ignored.
(string) --
dict
Response Syntax
{
'Status': 123,
'RequestId': 'string'
}
Response Structure
(dict) --
Status (integer) --
The HTTP status of the request.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}
Response {'Policy': {'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}}
Creates an approval policy in Quick Sight.
See also: AWS API Documentation
Request Syntax
client.create_approval_policy(
PolicyId='string',
Name='string',
Description='string',
Actions=[
'SHARE'|'PUBLISH',
],
AssetTypes=[
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
ApplicableTo={
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
ApprovalGroups=[
'string',
]
)
string
[REQUIRED]
The unique identifier to assign to the approval policy. You cannot change this value after you create the policy.
string
[REQUIRED]
The name of the approval policy.
string
A description of the approval policy.
list
[REQUIRED]
The list of governed actions that trigger the approval workflow.
(string) --
list
[REQUIRED]
The list of asset types that the approval policy applies to.
(string) --
dict
[REQUIRED]
The scoping configuration that determines who the approval policy applies to.
Type (string) -- [REQUIRED]
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
list
[REQUIRED]
The list of group ARNs whose members can approve requests.
(string) --
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyArn': 'string',
'Name': 'string',
'Description': 'string',
'Actions': [
'SHARE'|'PUBLISH',
],
'AssetTypes': [
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
'ApplicableTo': {
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
'ApprovalGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Policy (dict) --
The approval policy that was created.
PolicyId (string) --
The unique identifier of the approval policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the approval policy.
Name (string) --
The name of the approval policy.
Description (string) --
A description of the approval policy.
Actions (list) --
The list of governed actions that trigger the approval workflow.
(string) --
AssetTypes (list) --
The list of asset types that the approval policy applies to.
(string) --
ApplicableTo (dict) --
The scoping configuration that determines who the approval policy applies to.
Type (string) --
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
ApprovalGroups (list) --
The list of group ARNs whose members can approve requests.
(string) --
CreatedAt (datetime) --
The date and time that the approval policy was created.
UpdatedAt (datetime) --
The date and time that the approval policy was last updated.
{'Capabilities': {'CreateAndUpdateLocalMCPAction': 'DENY | ALLOW',
'LocalMCPAction': 'DENY | ALLOW',
'UseLocalMCPAction': 'DENY | ALLOW'}}
Creates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.create_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY'|'ALLOW',
'ExportToExcel': 'DENY'|'ALLOW',
'ExportToPdf': 'DENY'|'ALLOW',
'PrintReports': 'DENY'|'ALLOW',
'CreateAndUpdateThemes': 'DENY'|'ALLOW',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY'|'ALLOW',
'ShareAnalyses': 'DENY'|'ALLOW',
'CreateAndUpdateDatasets': 'DENY'|'ALLOW',
'ShareDatasets': 'DENY'|'ALLOW',
'SubscribeDashboardEmailReports': 'DENY'|'ALLOW',
'CreateAndUpdateDashboardEmailReports': 'DENY'|'ALLOW',
'ShareDashboards': 'DENY'|'ALLOW',
'CreateAndUpdateThresholdAlerts': 'DENY'|'ALLOW',
'RenameSharedFolders': 'DENY'|'ALLOW',
'CreateSharedFolders': 'DENY'|'ALLOW',
'CreateAndUpdateDataSources': 'DENY'|'ALLOW',
'ShareDataSources': 'DENY'|'ALLOW',
'ViewAccountSPICECapacity': 'DENY'|'ALLOW',
'CreateSPICEDataset': 'DENY'|'ALLOW',
'ExportToPdfInScheduledReports': 'DENY'|'ALLOW',
'ExportToCsvInScheduledReports': 'DENY'|'ALLOW',
'ExportToExcelInScheduledReports': 'DENY'|'ALLOW',
'IncludeContentInScheduledReportsEmail': 'DENY'|'ALLOW',
'Dashboard': 'DENY'|'ALLOW',
'Analysis': 'DENY'|'ALLOW',
'Automate': 'DENY'|'ALLOW',
'Flow': 'DENY'|'ALLOW',
'Apps': 'DENY'|'ALLOW',
'CreateAndUpdateApps': 'DENY'|'ALLOW',
'ShareApps': 'DENY'|'ALLOW',
'InvokeAppsAIInference': 'DENY'|'ALLOW',
'AccessAppsNativeDataStore': 'DENY'|'ALLOW',
'PublishWithoutApproval': 'DENY'|'ALLOW',
'UseBedrockModels': 'DENY'|'ALLOW',
'PerformFlowUiTask': 'DENY'|'ALLOW',
'ApproveFlowShareRequests': 'DENY'|'ALLOW',
'UseAgentWebSearch': 'DENY'|'ALLOW',
'KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateKnowledgeBases': 'DENY'|'ALLOW',
'ShareKnowledgeBases': 'DENY'|'ALLOW',
'SharePointKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointKnowledgeBase': 'DENY'|'ALLOW',
'ShareSharePointKnowledgeBase': 'DENY'|'ALLOW',
'UseSharePointKnowledgeBase': 'DENY'|'ALLOW',
'GoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'WebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'ShareWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'UseWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'S3KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateS3KnowledgeBase': 'DENY'|'ALLOW',
'ShareS3KnowledgeBase': 'DENY'|'ALLOW',
'UseS3KnowledgeBase': 'DENY'|'ALLOW',
'ConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'ShareConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'UseConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'OneDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'QBusinessKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'ShareQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'UseQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'BedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'ShareBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'UseBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'BoxKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBoxKnowledgeBase': 'DENY'|'ALLOW',
'ShareBoxKnowledgeBase': 'DENY'|'ALLOW',
'UseBoxKnowledgeBase': 'DENY'|'ALLOW',
'IDCKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateIDCKnowledgeBase': 'DENY'|'ALLOW',
'ShareIDCKnowledgeBase': 'DENY'|'ALLOW',
'UseIDCKnowledgeBase': 'DENY'|'ALLOW',
'Action': 'DENY'|'ALLOW',
'GenericHTTPAction': 'DENY'|'ALLOW',
'CreateAndUpdateGenericHTTPAction': 'DENY'|'ALLOW',
'ShareGenericHTTPAction': 'DENY'|'ALLOW',
'UseGenericHTTPAction': 'DENY'|'ALLOW',
'AsanaAction': 'DENY'|'ALLOW',
'CreateAndUpdateAsanaAction': 'DENY'|'ALLOW',
'ShareAsanaAction': 'DENY'|'ALLOW',
'UseAsanaAction': 'DENY'|'ALLOW',
'SlackAction': 'DENY'|'ALLOW',
'CreateAndUpdateSlackAction': 'DENY'|'ALLOW',
'ShareSlackAction': 'DENY'|'ALLOW',
'UseSlackAction': 'DENY'|'ALLOW',
'ServiceNowAction': 'DENY'|'ALLOW',
'CreateAndUpdateServiceNowAction': 'DENY'|'ALLOW',
'ShareServiceNowAction': 'DENY'|'ALLOW',
'UseServiceNowAction': 'DENY'|'ALLOW',
'SalesforceAction': 'DENY'|'ALLOW',
'CreateAndUpdateSalesforceAction': 'DENY'|'ALLOW',
'ShareSalesforceAction': 'DENY'|'ALLOW',
'UseSalesforceAction': 'DENY'|'ALLOW',
'MSExchangeAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSExchangeAction': 'DENY'|'ALLOW',
'ShareMSExchangeAction': 'DENY'|'ALLOW',
'UseMSExchangeAction': 'DENY'|'ALLOW',
'PagerDutyAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAction': 'DENY'|'ALLOW',
'SharePagerDutyAction': 'DENY'|'ALLOW',
'UsePagerDutyAction': 'DENY'|'ALLOW',
'JiraAction': 'DENY'|'ALLOW',
'CreateAndUpdateJiraAction': 'DENY'|'ALLOW',
'ShareJiraAction': 'DENY'|'ALLOW',
'UseJiraAction': 'DENY'|'ALLOW',
'ConfluenceAction': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceAction': 'DENY'|'ALLOW',
'ShareConfluenceAction': 'DENY'|'ALLOW',
'UseConfluenceAction': 'DENY'|'ALLOW',
'OneDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveAction': 'DENY'|'ALLOW',
'ShareOneDriveAction': 'DENY'|'ALLOW',
'UseOneDriveAction': 'DENY'|'ALLOW',
'SharePointAction': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointAction': 'DENY'|'ALLOW',
'ShareSharePointAction': 'DENY'|'ALLOW',
'UseSharePointAction': 'DENY'|'ALLOW',
'MSTeamsAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSTeamsAction': 'DENY'|'ALLOW',
'ShareMSTeamsAction': 'DENY'|'ALLOW',
'UseMSTeamsAction': 'DENY'|'ALLOW',
'GoogleCalendarAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleCalendarAction': 'DENY'|'ALLOW',
'ShareGoogleCalendarAction': 'DENY'|'ALLOW',
'UseGoogleCalendarAction': 'DENY'|'ALLOW',
'ZendeskAction': 'DENY'|'ALLOW',
'CreateAndUpdateZendeskAction': 'DENY'|'ALLOW',
'ShareZendeskAction': 'DENY'|'ALLOW',
'UseZendeskAction': 'DENY'|'ALLOW',
'SmartsheetAction': 'DENY'|'ALLOW',
'CreateAndUpdateSmartsheetAction': 'DENY'|'ALLOW',
'ShareSmartsheetAction': 'DENY'|'ALLOW',
'UseSmartsheetAction': 'DENY'|'ALLOW',
'SAPBusinessPartnerAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'ShareSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'UseSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'SAPProductMasterDataAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY'|'ALLOW',
'ShareSAPProductMasterDataAction': 'DENY'|'ALLOW',
'UseSAPProductMasterDataAction': 'DENY'|'ALLOW',
'SAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'ShareSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'UseSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'SAPBillOfMaterialAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'ShareSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'UseSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'SAPMaterialStockAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPMaterialStockAction': 'DENY'|'ALLOW',
'ShareSAPMaterialStockAction': 'DENY'|'ALLOW',
'UseSAPMaterialStockAction': 'DENY'|'ALLOW',
'FactSetAction': 'DENY'|'ALLOW',
'CreateAndUpdateFactSetAction': 'DENY'|'ALLOW',
'ShareFactSetAction': 'DENY'|'ALLOW',
'UseFactSetAction': 'DENY'|'ALLOW',
'AmazonSThreeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonSThreeAction': 'DENY'|'ALLOW',
'ShareAmazonSThreeAction': 'DENY'|'ALLOW',
'UseAmazonSThreeAction': 'DENY'|'ALLOW',
'TextractAction': 'DENY'|'ALLOW',
'CreateAndUpdateTextractAction': 'DENY'|'ALLOW',
'ShareTextractAction': 'DENY'|'ALLOW',
'UseTextractAction': 'DENY'|'ALLOW',
'ComprehendAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendAction': 'DENY'|'ALLOW',
'ShareComprehendAction': 'DENY'|'ALLOW',
'UseComprehendAction': 'DENY'|'ALLOW',
'ComprehendMedicalAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendMedicalAction': 'DENY'|'ALLOW',
'ShareComprehendMedicalAction': 'DENY'|'ALLOW',
'UseComprehendMedicalAction': 'DENY'|'ALLOW',
'AmazonBedrockARSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockARSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockARSAction': 'DENY'|'ALLOW',
'AmazonBedrockFSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockFSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockFSAction': 'DENY'|'ALLOW',
'AmazonBedrockKRSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'MCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateMCPAction': 'DENY'|'ALLOW',
'ShareMCPAction': 'DENY'|'ALLOW',
'UseMCPAction': 'DENY'|'ALLOW',
'LocalMCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateLocalMCPAction': 'DENY'|'ALLOW',
'UseLocalMCPAction': 'DENY'|'ALLOW',
'OpenAPIAction': 'DENY'|'ALLOW',
'CreateAndUpdateOpenAPIAction': 'DENY'|'ALLOW',
'ShareOpenAPIAction': 'DENY'|'ALLOW',
'UseOpenAPIAction': 'DENY'|'ALLOW',
'SandPGMIAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGMIAction': 'DENY'|'ALLOW',
'ShareSandPGMIAction': 'DENY'|'ALLOW',
'UseSandPGMIAction': 'DENY'|'ALLOW',
'SandPGlobalEnergyAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'ShareSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'UseSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'BambooHRAction': 'DENY'|'ALLOW',
'CreateAndUpdateBambooHRAction': 'DENY'|'ALLOW',
'ShareBambooHRAction': 'DENY'|'ALLOW',
'UseBambooHRAction': 'DENY'|'ALLOW',
'BoxAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateBoxAgentAction': 'DENY'|'ALLOW',
'ShareBoxAgentAction': 'DENY'|'ALLOW',
'UseBoxAgentAction': 'DENY'|'ALLOW',
'CanvaAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateCanvaAgentAction': 'DENY'|'ALLOW',
'ShareCanvaAgentAction': 'DENY'|'ALLOW',
'UseCanvaAgentAction': 'DENY'|'ALLOW',
'GithubAction': 'DENY'|'ALLOW',
'CreateAndUpdateGithubAction': 'DENY'|'ALLOW',
'ShareGithubAction': 'DENY'|'ALLOW',
'UseGithubAction': 'DENY'|'ALLOW',
'NotionAction': 'DENY'|'ALLOW',
'CreateAndUpdateNotionAction': 'DENY'|'ALLOW',
'ShareNotionAction': 'DENY'|'ALLOW',
'UseNotionAction': 'DENY'|'ALLOW',
'LinearAction': 'DENY'|'ALLOW',
'CreateAndUpdateLinearAction': 'DENY'|'ALLOW',
'ShareLinearAction': 'DENY'|'ALLOW',
'UseLinearAction': 'DENY'|'ALLOW',
'HuggingFaceAction': 'DENY'|'ALLOW',
'CreateAndUpdateHuggingFaceAction': 'DENY'|'ALLOW',
'ShareHuggingFaceAction': 'DENY'|'ALLOW',
'UseHuggingFaceAction': 'DENY'|'ALLOW',
'MondayAction': 'DENY'|'ALLOW',
'CreateAndUpdateMondayAction': 'DENY'|'ALLOW',
'ShareMondayAction': 'DENY'|'ALLOW',
'UseMondayAction': 'DENY'|'ALLOW',
'HubspotAction': 'DENY'|'ALLOW',
'CreateAndUpdateHubspotAction': 'DENY'|'ALLOW',
'ShareHubspotAction': 'DENY'|'ALLOW',
'UseHubspotAction': 'DENY'|'ALLOW',
'IntercomAction': 'DENY'|'ALLOW',
'CreateAndUpdateIntercomAction': 'DENY'|'ALLOW',
'ShareIntercomAction': 'DENY'|'ALLOW',
'UseIntercomAction': 'DENY'|'ALLOW',
'NewRelicAction': 'DENY'|'ALLOW',
'CreateAndUpdateNewRelicAction': 'DENY'|'ALLOW',
'ShareNewRelicAction': 'DENY'|'ALLOW',
'UseNewRelicAction': 'DENY'|'ALLOW',
'PagerDutyAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAgentAction': 'DENY'|'ALLOW',
'SharePagerDutyAgentAction': 'DENY'|'ALLOW',
'UsePagerDutyAgentAction': 'DENY'|'ALLOW',
'VisierAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateVisierAgentAction': 'DENY'|'ALLOW',
'ShareVisierAgentAction': 'DENY'|'ALLOW',
'UseVisierAgentAction': 'DENY'|'ALLOW',
'ZoomAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomAction': 'DENY'|'ALLOW',
'ShareZoomAction': 'DENY'|'ALLOW',
'UseZoomAction': 'DENY'|'ALLOW',
'SnowFlakeAction': 'DENY'|'ALLOW',
'CreateAndUpdateSnowFlakeAction': 'DENY'|'ALLOW',
'ShareSnowFlakeAction': 'DENY'|'ALLOW',
'UseSnowFlakeAction': 'DENY'|'ALLOW',
'ZapierAction': 'DENY'|'ALLOW',
'CreateAndUpdateZapierAction': 'DENY'|'ALLOW',
'ShareZapierAction': 'DENY'|'ALLOW',
'UseZapierAction': 'DENY'|'ALLOW',
'AirtableAction': 'DENY'|'ALLOW',
'CreateAndUpdateAirtableAction': 'DENY'|'ALLOW',
'ShareAirtableAction': 'DENY'|'ALLOW',
'UseAirtableAction': 'DENY'|'ALLOW',
'DropboxAction': 'DENY'|'ALLOW',
'CreateAndUpdateDropboxAction': 'DENY'|'ALLOW',
'ShareDropboxAction': 'DENY'|'ALLOW',
'UseDropboxAction': 'DENY'|'ALLOW',
'GmailAction': 'DENY'|'ALLOW',
'CreateAndUpdateGmailAction': 'DENY'|'ALLOW',
'ShareGmailAction': 'DENY'|'ALLOW',
'UseGmailAction': 'DENY'|'ALLOW',
'GoogleAnalyticsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleAnalyticsAction': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsAction': 'DENY'|'ALLOW',
'UseGoogleAnalyticsAction': 'DENY'|'ALLOW',
'GoogleDocsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDocsAction': 'DENY'|'ALLOW',
'ShareGoogleDocsAction': 'DENY'|'ALLOW',
'UseGoogleDocsAction': 'DENY'|'ALLOW',
'GoogleDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveAction': 'DENY'|'ALLOW',
'ShareGoogleDriveAction': 'DENY'|'ALLOW',
'UseGoogleDriveAction': 'DENY'|'ALLOW',
'GoogleMeetAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleMeetAction': 'DENY'|'ALLOW',
'ShareGoogleMeetAction': 'DENY'|'ALLOW',
'UseGoogleMeetAction': 'DENY'|'ALLOW',
'GoogleSheetsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSheetsAction': 'DENY'|'ALLOW',
'ShareGoogleSheetsAction': 'DENY'|'ALLOW',
'UseGoogleSheetsAction': 'DENY'|'ALLOW',
'GoogleSlidesAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSlidesAction': 'DENY'|'ALLOW',
'ShareGoogleSlidesAction': 'DENY'|'ALLOW',
'UseGoogleSlidesAction': 'DENY'|'ALLOW',
'QuickBooksAction': 'DENY'|'ALLOW',
'CreateAndUpdateQuickBooksAction': 'DENY'|'ALLOW',
'ShareQuickBooksAction': 'DENY'|'ALLOW',
'UseQuickBooksAction': 'DENY'|'ALLOW',
'FigmaAction': 'DENY'|'ALLOW',
'CreateAndUpdateFigmaAction': 'DENY'|'ALLOW',
'ShareFigmaAction': 'DENY'|'ALLOW',
'UseFigmaAction': 'DENY'|'ALLOW',
'WhatsAppAction': 'DENY'|'ALLOW',
'CreateAndUpdateWhatsAppAction': 'DENY'|'ALLOW',
'ShareWhatsAppAction': 'DENY'|'ALLOW',
'UseWhatsAppAction': 'DENY'|'ALLOW',
'GoogleChatAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleChatAction': 'DENY'|'ALLOW',
'ShareGoogleChatAction': 'DENY'|'ALLOW',
'UseGoogleChatAction': 'DENY'|'ALLOW',
'OneNoteAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneNoteAction': 'DENY'|'ALLOW',
'ShareOneNoteAction': 'DENY'|'ALLOW',
'UseOneNoteAction': 'DENY'|'ALLOW',
'ShopifyAction': 'DENY'|'ALLOW',
'CreateAndUpdateShopifyAction': 'DENY'|'ALLOW',
'ShareShopifyAction': 'DENY'|'ALLOW',
'UseShopifyAction': 'DENY'|'ALLOW',
'AdobeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAdobeAction': 'DENY'|'ALLOW',
'ShareAdobeAction': 'DENY'|'ALLOW',
'UseAdobeAction': 'DENY'|'ALLOW',
'CiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'ShareCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'UseCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'ShareCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'UseCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'DunAndBradstreetAction': 'DENY'|'ALLOW',
'CreateAndUpdateDunAndBradstreetAction': 'DENY'|'ALLOW',
'ShareDunAndBradstreetAction': 'DENY'|'ALLOW',
'UseDunAndBradstreetAction': 'DENY'|'ALLOW',
'HGInsightsAction': 'DENY'|'ALLOW',
'CreateAndUpdateHGInsightsAction': 'DENY'|'ALLOW',
'ShareHGInsightsAction': 'DENY'|'ALLOW',
'UseHGInsightsAction': 'DENY'|'ALLOW',
'ZoomInfoAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomInfoAction': 'DENY'|'ALLOW',
'ShareZoomInfoAction': 'DENY'|'ALLOW',
'UseZoomInfoAction': 'DENY'|'ALLOW',
'MoodysAction': 'DENY'|'ALLOW',
'CreateAndUpdateMoodysAction': 'DENY'|'ALLOW',
'ShareMoodysAction': 'DENY'|'ALLOW',
'UseMoodysAction': 'DENY'|'ALLOW',
'BeeAction': 'DENY'|'ALLOW',
'CreateAndUpdateBeeAction': 'DENY'|'ALLOW',
'ShareBeeAction': 'DENY'|'ALLOW',
'UseBeeAction': 'DENY'|'ALLOW',
'GongAction': 'DENY'|'ALLOW',
'CreateAndUpdateGongAction': 'DENY'|'ALLOW',
'ShareGongAction': 'DENY'|'ALLOW',
'UseGongAction': 'DENY'|'ALLOW',
'Topic': 'DENY'|'ALLOW',
'EditVisualWithQ': 'DENY'|'ALLOW',
'BuildCalculatedFieldWithQ': 'DENY'|'ALLOW',
'CreateDashboardExecutiveSummaryWithQ': 'DENY'|'ALLOW',
'Space': 'DENY'|'ALLOW',
'CreateSpaces': 'DENY'|'ALLOW',
'ShareSpaces': 'DENY'|'ALLOW',
'ChatAgent': 'DENY'|'ALLOW',
'CreateChatAgents': 'DENY'|'ALLOW',
'ShareChatAgents': 'DENY'|'ALLOW',
'Research': 'DENY'|'ALLOW',
'SelfUpgradeUserRole': 'DENY'|'ALLOW',
'Extension': 'DENY'|'ALLOW',
'UseBrowserExtension': 'DENY'|'ALLOW',
'UseWordAddInExtension': 'DENY'|'ALLOW',
'UseOutlookAddInExtension': 'DENY'|'ALLOW',
'UseExcelAddInExtension': 'DENY'|'ALLOW',
'UsePowerpointAddInExtension': 'DENY'|'ALLOW',
'ManageSharedFolders': 'DENY'|'ALLOW',
'GenerateAnalyses': 'DENY'|'ALLOW',
'Story': 'DENY'|'ALLOW',
'Scenario': 'DENY'|'ALLOW',
'Trigger': 'DENY'|'ALLOW',
'ScheduleTrigger': 'DENY'|'ALLOW',
'InboundEmailTrigger': 'DENY'|'ALLOW',
'QuickEventTrigger': 'DENY'|'ALLOW',
'FileDataSource': 'DENY'|'ALLOW',
'CreateFileDataSource': 'DENY'|'ALLOW',
'UpdateFileDataSource': 'DENY'|'ALLOW',
'ShareFileDataSource': 'DENY'|'ALLOW',
'S3DataSource': 'DENY'|'ALLOW',
'CreateS3DataSource': 'DENY'|'ALLOW',
'UpdateS3DataSource': 'DENY'|'ALLOW',
'ShareS3DataSource': 'DENY'|'ALLOW',
'S3AnalyticsDataSource': 'DENY'|'ALLOW',
'CreateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'ShareS3AnalyticsDataSource': 'DENY'|'ALLOW',
'S3TablesDataSource': 'DENY'|'ALLOW',
'CreateS3TablesDataSource': 'DENY'|'ALLOW',
'UpdateS3TablesDataSource': 'DENY'|'ALLOW',
'ShareS3TablesDataSource': 'DENY'|'ALLOW',
'AthenaDataSource': 'DENY'|'ALLOW',
'CreateAthenaDataSource': 'DENY'|'ALLOW',
'UpdateAthenaDataSource': 'DENY'|'ALLOW',
'ShareAthenaDataSource': 'DENY'|'ALLOW',
'RdsDataSource': 'DENY'|'ALLOW',
'CreateRdsDataSource': 'DENY'|'ALLOW',
'UpdateRdsDataSource': 'DENY'|'ALLOW',
'ShareRdsDataSource': 'DENY'|'ALLOW',
'RedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'CreateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'ShareRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'RedshiftManualDataSource': 'DENY'|'ALLOW',
'CreateRedshiftManualDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftManualDataSource': 'DENY'|'ALLOW',
'ShareRedshiftManualDataSource': 'DENY'|'ALLOW',
'OpenSearchDataSource': 'DENY'|'ALLOW',
'CreateOpenSearchDataSource': 'DENY'|'ALLOW',
'UpdateOpenSearchDataSource': 'DENY'|'ALLOW',
'ShareOpenSearchDataSource': 'DENY'|'ALLOW',
'TimestreamDataSource': 'DENY'|'ALLOW',
'CreateTimestreamDataSource': 'DENY'|'ALLOW',
'UpdateTimestreamDataSource': 'DENY'|'ALLOW',
'ShareTimestreamDataSource': 'DENY'|'ALLOW',
'AuroraDataSource': 'DENY'|'ALLOW',
'CreateAuroraDataSource': 'DENY'|'ALLOW',
'UpdateAuroraDataSource': 'DENY'|'ALLOW',
'ShareAuroraDataSource': 'DENY'|'ALLOW',
'MySqlDataSource': 'DENY'|'ALLOW',
'CreateMySqlDataSource': 'DENY'|'ALLOW',
'UpdateMySqlDataSource': 'DENY'|'ALLOW',
'ShareMySqlDataSource': 'DENY'|'ALLOW',
'PostgreSqlDataSource': 'DENY'|'ALLOW',
'CreatePostgreSqlDataSource': 'DENY'|'ALLOW',
'UpdatePostgreSqlDataSource': 'DENY'|'ALLOW',
'SharePostgreSqlDataSource': 'DENY'|'ALLOW',
'OracleDataSource': 'DENY'|'ALLOW',
'CreateOracleDataSource': 'DENY'|'ALLOW',
'UpdateOracleDataSource': 'DENY'|'ALLOW',
'ShareOracleDataSource': 'DENY'|'ALLOW',
'SqlServerDataSource': 'DENY'|'ALLOW',
'CreateSqlServerDataSource': 'DENY'|'ALLOW',
'UpdateSqlServerDataSource': 'DENY'|'ALLOW',
'ShareSqlServerDataSource': 'DENY'|'ALLOW',
'MariaDbDataSource': 'DENY'|'ALLOW',
'CreateMariaDbDataSource': 'DENY'|'ALLOW',
'UpdateMariaDbDataSource': 'DENY'|'ALLOW',
'ShareMariaDbDataSource': 'DENY'|'ALLOW',
'SnowflakeDataSource': 'DENY'|'ALLOW',
'CreateSnowflakeDataSource': 'DENY'|'ALLOW',
'UpdateSnowflakeDataSource': 'DENY'|'ALLOW',
'ShareSnowflakeDataSource': 'DENY'|'ALLOW',
'GoogleBigQueryDataSource': 'DENY'|'ALLOW',
'CreateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'UpdateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'ShareGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'DatabricksDataSource': 'DENY'|'ALLOW',
'CreateDatabricksDataSource': 'DENY'|'ALLOW',
'UpdateDatabricksDataSource': 'DENY'|'ALLOW',
'ShareDatabricksDataSource': 'DENY'|'ALLOW',
'StarburstDataSource': 'DENY'|'ALLOW',
'CreateStarburstDataSource': 'DENY'|'ALLOW',
'UpdateStarburstDataSource': 'DENY'|'ALLOW',
'ShareStarburstDataSource': 'DENY'|'ALLOW',
'TrinoDataSource': 'DENY'|'ALLOW',
'CreateTrinoDataSource': 'DENY'|'ALLOW',
'UpdateTrinoDataSource': 'DENY'|'ALLOW',
'ShareTrinoDataSource': 'DENY'|'ALLOW',
'ImpalaDataSource': 'DENY'|'ALLOW',
'CreateImpalaDataSource': 'DENY'|'ALLOW',
'UpdateImpalaDataSource': 'DENY'|'ALLOW',
'ShareImpalaDataSource': 'DENY'|'ALLOW',
'TeradataDataSource': 'DENY'|'ALLOW',
'CreateTeradataDataSource': 'DENY'|'ALLOW',
'UpdateTeradataDataSource': 'DENY'|'ALLOW',
'ShareTeradataDataSource': 'DENY'|'ALLOW',
'PrestoDataSource': 'DENY'|'ALLOW',
'CreatePrestoDataSource': 'DENY'|'ALLOW',
'UpdatePrestoDataSource': 'DENY'|'ALLOW',
'SharePrestoDataSource': 'DENY'|'ALLOW',
'SparkDataSource': 'DENY'|'ALLOW',
'CreateSparkDataSource': 'DENY'|'ALLOW',
'UpdateSparkDataSource': 'DENY'|'ALLOW',
'ShareSparkDataSource': 'DENY'|'ALLOW',
'ExasolDataSource': 'DENY'|'ALLOW',
'CreateExasolDataSource': 'DENY'|'ALLOW',
'UpdateExasolDataSource': 'DENY'|'ALLOW',
'ShareExasolDataSource': 'DENY'|'ALLOW',
'Db2DataSource': 'DENY'|'ALLOW',
'CreateDb2DataSource': 'DENY'|'ALLOW',
'UpdateDb2DataSource': 'DENY'|'ALLOW',
'ShareDb2DataSource': 'DENY'|'ALLOW',
'SapHanaDataSource': 'DENY'|'ALLOW',
'CreateSapHanaDataSource': 'DENY'|'ALLOW',
'UpdateSapHanaDataSource': 'DENY'|'ALLOW',
'ShareSapHanaDataSource': 'DENY'|'ALLOW',
'DenodoDataSource': 'DENY'|'ALLOW',
'CreateDenodoDataSource': 'DENY'|'ALLOW',
'UpdateDenodoDataSource': 'DENY'|'ALLOW',
'ShareDenodoDataSource': 'DENY'|'ALLOW',
'DremioDataSource': 'DENY'|'ALLOW',
'CreateDremioDataSource': 'DENY'|'ALLOW',
'UpdateDremioDataSource': 'DENY'|'ALLOW',
'ShareDremioDataSource': 'DENY'|'ALLOW',
'SalesforceDataSource': 'DENY'|'ALLOW',
'CreateSalesforceDataSource': 'DENY'|'ALLOW',
'UpdateSalesforceDataSource': 'DENY'|'ALLOW',
'ShareSalesforceDataSource': 'DENY'|'ALLOW',
'RadiantDataSource': 'DENY'|'ALLOW',
'CreateRadiantDataSource': 'DENY'|'ALLOW',
'UpdateRadiantDataSource': 'DENY'|'ALLOW',
'ShareRadiantDataSource': 'DENY'|'ALLOW',
'PayPalDataSource': 'DENY'|'ALLOW',
'CreatePayPalDataSource': 'DENY'|'ALLOW',
'UpdatePayPalDataSource': 'DENY'|'ALLOW',
'SharePayPalDataSource': 'DENY'|'ALLOW',
'SquareDataSource': 'DENY'|'ALLOW',
'CreateSquareDataSource': 'DENY'|'ALLOW',
'UpdateSquareDataSource': 'DENY'|'ALLOW',
'ShareSquareDataSource': 'DENY'|'ALLOW',
'GitHubDataSource': 'DENY'|'ALLOW',
'CreateGitHubDataSource': 'DENY'|'ALLOW',
'UpdateGitHubDataSource': 'DENY'|'ALLOW',
'ShareGitHubDataSource': 'DENY'|'ALLOW',
'TwitterDataSource': 'DENY'|'ALLOW',
'CreateTwitterDataSource': 'DENY'|'ALLOW',
'UpdateTwitterDataSource': 'DENY'|'ALLOW',
'ShareTwitterDataSource': 'DENY'|'ALLOW',
'JiraDataSource': 'DENY'|'ALLOW',
'CreateJiraDataSource': 'DENY'|'ALLOW',
'UpdateJiraDataSource': 'DENY'|'ALLOW',
'ShareJiraDataSource': 'DENY'|'ALLOW',
'ServiceNowDataSource': 'DENY'|'ALLOW',
'CreateServiceNowDataSource': 'DENY'|'ALLOW',
'UpdateServiceNowDataSource': 'DENY'|'ALLOW',
'ShareServiceNowDataSource': 'DENY'|'ALLOW',
'AdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleSheetsDataSource': 'DENY'|'ALLOW',
'CreateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'ShareGoogleSheetsDataSource': 'DENY'|'ALLOW',
'DocumentDbDataSource': 'DENY'|'ALLOW',
'CreateDocumentDbDataSource': 'DENY'|'ALLOW',
'UpdateDocumentDbDataSource': 'DENY'|'ALLOW',
'ShareDocumentDbDataSource': 'DENY'|'ALLOW',
'MongoDbDataSource': 'DENY'|'ALLOW',
'CreateMongoDbDataSource': 'DENY'|'ALLOW',
'UpdateMongoDbDataSource': 'DENY'|'ALLOW',
'ShareMongoDbDataSource': 'DENY'|'ALLOW',
'MongoAtlasDataSource': 'DENY'|'ALLOW',
'CreateMongoAtlasDataSource': 'DENY'|'ALLOW',
'UpdateMongoAtlasDataSource': 'DENY'|'ALLOW',
'ShareMongoAtlasDataSource': 'DENY'|'ALLOW',
'DynamoDbDataSource': 'DENY'|'ALLOW',
'CreateDynamoDbDataSource': 'DENY'|'ALLOW',
'UpdateDynamoDbDataSource': 'DENY'|'ALLOW',
'ShareDynamoDbDataSource': 'DENY'|'ALLOW'
},
Governance={
'DefaultCategoryEffects': {
'string': 'DENY_BY_DEFAULT'
}
},
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.
Apps (string) --
The ability to perform apps-related actions.
CreateAndUpdateApps (string) --
The ability to create or update apps.
ShareApps (string) --
The ability to share apps with other users.
InvokeAppsAIInference (string) --
The ability to add and invoke AI inference in new and existing apps.
AccessAppsNativeDataStore (string) --
The ability to access the native data store for new and existing apps.
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.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
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.
CreateAndUpdateKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
SharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
GoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
WebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
S3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
OneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
QBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
IDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
LocalMCPAction (string) --
The ability to create, update, and use local Model Context Protocol (MCP) actions. This capability includes CreateAndUpdateLocalMCPAction and UseLocalMCPAction.
CreateAndUpdateLocalMCPAction (string) --
The ability to create and update local Model Context Protocol (MCP) server configurations. Denying this capability does not by itself deny use of previously configured local MCP servers.
UseLocalMCPAction (string) --
The ability to start local Model Context Protocol (MCP) servers and use their actions, including actions from previously configured local MCP servers.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
PagerDutyAgentAction (string) --
The ability to perform actions using PagerDuty Agent connectors.
CreateAndUpdatePagerDutyAgentAction (string) --
The ability to create and update PagerDuty Agent actions.
SharePagerDutyAgentAction (string) --
The ability to share PagerDuty Agent actions.
UsePagerDutyAgentAction (string) --
The ability to use PagerDuty Agent actions.
VisierAgentAction (string) --
The ability to perform actions using Visier Agent connectors.
CreateAndUpdateVisierAgentAction (string) --
The ability to create and update Visier Agent actions.
ShareVisierAgentAction (string) --
The ability to share Visier Agent actions.
UseVisierAgentAction (string) --
The ability to use Visier Agent actions.
ZoomAction (string) --
The ability to perform actions using Zoom connectors.
CreateAndUpdateZoomAction (string) --
The ability to create and update Zoom actions.
ShareZoomAction (string) --
The ability to share Zoom actions.
UseZoomAction (string) --
The ability to use Zoom actions.
SnowFlakeAction (string) --
The ability to perform actions using Snowflake Cortex Agent connectors.
CreateAndUpdateSnowFlakeAction (string) --
The ability to create and update Snowflake Cortex Agent actions.
ShareSnowFlakeAction (string) --
The ability to share Snowflake Cortex Agent actions.
UseSnowFlakeAction (string) --
The ability to use Snowflake Cortex Agent actions.
ZapierAction (string) --
The ability to perform actions using Zapier Agent connectors.
CreateAndUpdateZapierAction (string) --
The ability to create and update Zapier Agent actions.
ShareZapierAction (string) --
The ability to share Zapier Agent actions.
UseZapierAction (string) --
The ability to use Zapier Agent actions.
AirtableAction (string) --
The ability to perform actions using Airtable connectors.
CreateAndUpdateAirtableAction (string) --
The ability to create and update Airtable actions.
ShareAirtableAction (string) --
The ability to share Airtable actions.
UseAirtableAction (string) --
The ability to use Airtable actions.
DropboxAction (string) --
The ability to perform actions using Dropbox connectors.
CreateAndUpdateDropboxAction (string) --
The ability to create and update Dropbox actions.
ShareDropboxAction (string) --
The ability to share Dropbox actions.
UseDropboxAction (string) --
The ability to use Dropbox actions.
GmailAction (string) --
The ability to perform actions using Gmail connectors.
CreateAndUpdateGmailAction (string) --
The ability to create and update Gmail actions.
ShareGmailAction (string) --
The ability to share Gmail actions.
UseGmailAction (string) --
The ability to use Gmail actions.
GoogleAnalyticsAction (string) --
The ability to perform actions using Google Analytics connectors.
CreateAndUpdateGoogleAnalyticsAction (string) --
The ability to create and update Google Analytics actions.
ShareGoogleAnalyticsAction (string) --
The ability to share Google Analytics actions.
UseGoogleAnalyticsAction (string) --
The ability to use Google Analytics actions.
GoogleDocsAction (string) --
The ability to perform actions using Google Docs connectors.
CreateAndUpdateGoogleDocsAction (string) --
The ability to create and update Google Docs actions.
ShareGoogleDocsAction (string) --
The ability to share Google Docs actions.
UseGoogleDocsAction (string) --
The ability to use Google Docs actions.
GoogleDriveAction (string) --
The ability to perform actions using Google Drive connectors.
CreateAndUpdateGoogleDriveAction (string) --
The ability to create and update Google Drive actions.
ShareGoogleDriveAction (string) --
The ability to share Google Drive actions.
UseGoogleDriveAction (string) --
The ability to use Google Drive actions.
GoogleMeetAction (string) --
The ability to perform actions using Google Meet connectors.
CreateAndUpdateGoogleMeetAction (string) --
The ability to create and update Google Meet actions.
ShareGoogleMeetAction (string) --
The ability to share Google Meet actions.
UseGoogleMeetAction (string) --
The ability to use Google Meet actions.
GoogleSheetsAction (string) --
The ability to perform actions using Google Sheets connectors.
CreateAndUpdateGoogleSheetsAction (string) --
The ability to create and update Google Sheets actions.
ShareGoogleSheetsAction (string) --
The ability to share Google Sheets actions.
UseGoogleSheetsAction (string) --
The ability to use Google Sheets actions.
GoogleSlidesAction (string) --
The ability to perform actions using Google Slides connectors.
CreateAndUpdateGoogleSlidesAction (string) --
The ability to create and update Google Slides actions.
ShareGoogleSlidesAction (string) --
The ability to share Google Slides actions.
UseGoogleSlidesAction (string) --
The ability to use Google Slides actions.
QuickBooksAction (string) --
The ability to perform actions using QuickBooks connectors.
CreateAndUpdateQuickBooksAction (string) --
The ability to create and update QuickBooks actions.
ShareQuickBooksAction (string) --
The ability to share QuickBooks actions.
UseQuickBooksAction (string) --
The ability to use QuickBooks actions.
FigmaAction (string) --
The ability to perform actions using Figma connectors.
CreateAndUpdateFigmaAction (string) --
The ability to create and update Figma actions.
ShareFigmaAction (string) --
The ability to share Figma actions.
UseFigmaAction (string) --
The ability to use Figma actions.
WhatsAppAction (string) --
The ability to perform actions using WhatsApp connectors.
CreateAndUpdateWhatsAppAction (string) --
The ability to create and update WhatsApp actions.
ShareWhatsAppAction (string) --
The ability to share WhatsApp actions.
UseWhatsAppAction (string) --
The ability to use WhatsApp actions.
GoogleChatAction (string) --
The ability to perform actions using Google Chat connectors.
CreateAndUpdateGoogleChatAction (string) --
The ability to create and update Google Chat actions.
ShareGoogleChatAction (string) --
The ability to share Google Chat actions.
UseGoogleChatAction (string) --
The ability to use Google Chat actions.
OneNoteAction (string) --
The ability to perform actions using Microsoft OneNote connectors.
CreateAndUpdateOneNoteAction (string) --
The ability to create and update Microsoft OneNote actions.
ShareOneNoteAction (string) --
The ability to share Microsoft OneNote actions.
UseOneNoteAction (string) --
The ability to use Microsoft OneNote actions.
ShopifyAction (string) --
The ability to perform actions using Shopify connectors.
CreateAndUpdateShopifyAction (string) --
The ability to create and update Shopify actions.
ShareShopifyAction (string) --
The ability to share Shopify actions.
UseShopifyAction (string) --
The ability to use Shopify actions.
AdobeAction (string) --
The ability to perform actions using Adobe Marketing Agent connectors.
CreateAndUpdateAdobeAction (string) --
The ability to create and update Adobe Marketing Agent actions.
ShareAdobeAction (string) --
The ability to share Adobe Marketing Agent actions.
UseAdobeAction (string) --
The ability to use Adobe Marketing Agent actions.
CiscoWebexVidcastAction (string) --
The ability to perform actions using Cisco Webex Video Messaging Agent connectors.
CreateAndUpdateCiscoWebexVidcastAction (string) --
The ability to create and update Cisco Webex Video Messaging Agent actions.
ShareCiscoWebexVidcastAction (string) --
The ability to share Cisco Webex Video Messaging Agent actions.
UseCiscoWebexVidcastAction (string) --
The ability to use Cisco Webex Video Messaging Agent actions.
CiscoWebexMeetingsAction (string) --
The ability to perform actions using Cisco Webex Meetings connectors.
CreateAndUpdateCiscoWebexMeetingsAction (string) --
The ability to create and update Cisco Webex Meetings actions.
ShareCiscoWebexMeetingsAction (string) --
The ability to share Cisco Webex Meetings actions.
UseCiscoWebexMeetingsAction (string) --
The ability to use Cisco Webex Meetings actions.
DunAndBradstreetAction (string) --
The ability to perform actions using Dun and Bradstreet connectors.
CreateAndUpdateDunAndBradstreetAction (string) --
The ability to create and update Dun and Bradstreet actions.
ShareDunAndBradstreetAction (string) --
The ability to share Dun and Bradstreet actions.
UseDunAndBradstreetAction (string) --
The ability to use Dun and Bradstreet actions.
HGInsightsAction (string) --
The ability to perform actions using HG Insights Agent connectors.
CreateAndUpdateHGInsightsAction (string) --
The ability to create and update HG Insights Agent actions.
ShareHGInsightsAction (string) --
The ability to share HG Insights Agent actions.
UseHGInsightsAction (string) --
The ability to use HG Insights Agent actions.
ZoomInfoAction (string) --
The ability to perform actions using ZoomInfo Agent connectors.
CreateAndUpdateZoomInfoAction (string) --
The ability to create and update ZoomInfo Agent actions.
ShareZoomInfoAction (string) --
The ability to share ZoomInfo Agent actions.
UseZoomInfoAction (string) --
The ability to use ZoomInfo Agent actions.
MoodysAction (string) --
The ability to perform actions using Moody's GenAI Ready Data connectors.
CreateAndUpdateMoodysAction (string) --
The ability to create and update Moody's GenAI Ready Data actions.
ShareMoodysAction (string) --
The ability to share Moody's GenAI Ready Data actions.
UseMoodysAction (string) --
The ability to use Moody's GenAI Ready Data actions.
BeeAction (string) --
The ability to perform actions using Bee connectors.
CreateAndUpdateBeeAction (string) --
The ability to create and update Bee actions.
ShareBeeAction (string) --
The ability to share Bee actions.
UseBeeAction (string) --
The ability to use Bee actions.
GongAction (string) --
The ability to perform actions using Gong connectors.
CreateAndUpdateGongAction (string) --
The ability to create and update Gong actions.
ShareGongAction (string) --
The ability to share Gong actions.
UseGongAction (string) --
The ability to use Gong actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
UseBrowserExtension (string) --
The ability to use Amazon Quick through the browser extension for Chrome, Firefox, and Edge.
UseWordAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Word add-in.
UseOutlookAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Outlook add-in.
UseExcelAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Excel add-in.
UsePowerpointAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft PowerPoint add-in.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
Story (string) --
The ability to perform Story-related actions.
Scenario (string) --
The ability to perform Scenario-related actions.
Trigger (string) --
The ability to manage trigger-related settings for flows and automations.
ScheduleTrigger (string) --
The ability to create, view, edit, delete, and run schedule triggers for flows and automations.
InboundEmailTrigger (string) --
The ability to create, view, edit, delete, and run inbound email triggers for flows and automations.
QuickEventTrigger (string) --
The ability to create, view, edit, delete, and run Quick event triggers for flows and automations.
FileDataSource (string) --
The ability to create, update, and share file data sources.
CreateFileDataSource (string) --
The ability to create file data sources.
UpdateFileDataSource (string) --
The ability to update file data sources.
ShareFileDataSource (string) --
The ability to share file data sources.
S3DataSource (string) --
The ability to create, update, and share Amazon S3 data sources.
CreateS3DataSource (string) --
The ability to create Amazon S3 data sources.
UpdateS3DataSource (string) --
The ability to update Amazon S3 data sources.
ShareS3DataSource (string) --
The ability to share Amazon S3 data sources.
S3AnalyticsDataSource (string) --
The ability to create, update, and share Amazon S3 Analytics data sources.
CreateS3AnalyticsDataSource (string) --
The ability to create Amazon S3 Analytics data sources.
UpdateS3AnalyticsDataSource (string) --
The ability to update Amazon S3 Analytics data sources.
ShareS3AnalyticsDataSource (string) --
The ability to share Amazon S3 Analytics data sources.
S3TablesDataSource (string) --
The ability to create, update, and share Amazon S3 Tables data sources.
CreateS3TablesDataSource (string) --
The ability to create Amazon S3 Tables data sources.
UpdateS3TablesDataSource (string) --
The ability to update Amazon S3 Tables data sources.
ShareS3TablesDataSource (string) --
The ability to share Amazon S3 Tables data sources.
AthenaDataSource (string) --
The ability to create, update, and share Amazon Athena data sources.
CreateAthenaDataSource (string) --
The ability to create Amazon Athena data sources.
UpdateAthenaDataSource (string) --
The ability to update Amazon Athena data sources.
ShareAthenaDataSource (string) --
The ability to share Amazon Athena data sources.
RdsDataSource (string) --
The ability to create, update, and share auto-discovered Amazon RDS data sources.
CreateRdsDataSource (string) --
The ability to create auto-discovered Amazon RDS data sources.
UpdateRdsDataSource (string) --
The ability to update auto-discovered Amazon RDS data sources.
ShareRdsDataSource (string) --
The ability to share auto-discovered Amazon RDS data sources.
RedshiftAutoDiscoveredDataSource (string) --
The ability to create, update, and share auto-discovered Amazon Redshift data sources.
CreateRedshiftAutoDiscoveredDataSource (string) --
The ability to create auto-discovered Amazon Redshift data sources.
UpdateRedshiftAutoDiscoveredDataSource (string) --
The ability to update auto-discovered Amazon Redshift data sources.
ShareRedshiftAutoDiscoveredDataSource (string) --
The ability to share auto-discovered Amazon Redshift data sources.
RedshiftManualDataSource (string) --
The ability to create, update, and share manually configured Amazon Redshift data sources.
CreateRedshiftManualDataSource (string) --
The ability to create manually configured Amazon Redshift data sources.
UpdateRedshiftManualDataSource (string) --
The ability to update manually configured Amazon Redshift data sources.
ShareRedshiftManualDataSource (string) --
The ability to share manually configured Amazon Redshift data sources.
OpenSearchDataSource (string) --
The ability to create, update, and share Amazon OpenSearch Service data sources.
CreateOpenSearchDataSource (string) --
The ability to create Amazon OpenSearch Service data sources.
UpdateOpenSearchDataSource (string) --
The ability to update Amazon OpenSearch Service data sources.
ShareOpenSearchDataSource (string) --
The ability to share Amazon OpenSearch Service data sources.
TimestreamDataSource (string) --
The ability to create, update, and share Amazon Timestream data sources.
CreateTimestreamDataSource (string) --
The ability to create Amazon Timestream data sources.
UpdateTimestreamDataSource (string) --
The ability to update Amazon Timestream data sources.
ShareTimestreamDataSource (string) --
The ability to share Amazon Timestream data sources.
AuroraDataSource (string) --
The ability to create, update, and share Amazon Aurora data sources.
CreateAuroraDataSource (string) --
The ability to create Amazon Aurora data sources.
UpdateAuroraDataSource (string) --
The ability to update Amazon Aurora data sources.
ShareAuroraDataSource (string) --
The ability to share Amazon Aurora data sources.
MySqlDataSource (string) --
The ability to create, update, and share MySQL data sources.
CreateMySqlDataSource (string) --
The ability to create MySQL data sources.
UpdateMySqlDataSource (string) --
The ability to update MySQL data sources.
ShareMySqlDataSource (string) --
The ability to share MySQL data sources.
PostgreSqlDataSource (string) --
The ability to create, update, and share PostgreSQL data sources.
CreatePostgreSqlDataSource (string) --
The ability to create PostgreSQL data sources.
UpdatePostgreSqlDataSource (string) --
The ability to update PostgreSQL data sources.
SharePostgreSqlDataSource (string) --
The ability to share PostgreSQL data sources.
OracleDataSource (string) --
The ability to create, update, and share Oracle data sources.
CreateOracleDataSource (string) --
The ability to create Oracle data sources.
UpdateOracleDataSource (string) --
The ability to update Oracle data sources.
ShareOracleDataSource (string) --
The ability to share Oracle data sources.
SqlServerDataSource (string) --
The ability to create, update, and share SQL Server data sources.
CreateSqlServerDataSource (string) --
The ability to create SQL Server data sources.
UpdateSqlServerDataSource (string) --
The ability to update SQL Server data sources.
ShareSqlServerDataSource (string) --
The ability to share SQL Server data sources.
MariaDbDataSource (string) --
The ability to create, update, and share MariaDB data sources.
CreateMariaDbDataSource (string) --
The ability to create MariaDB data sources.
UpdateMariaDbDataSource (string) --
The ability to update MariaDB data sources.
ShareMariaDbDataSource (string) --
The ability to share MariaDB data sources.
SnowflakeDataSource (string) --
The ability to create, update, and share Snowflake data sources.
CreateSnowflakeDataSource (string) --
The ability to create Snowflake data sources.
UpdateSnowflakeDataSource (string) --
The ability to update Snowflake data sources.
ShareSnowflakeDataSource (string) --
The ability to share Snowflake data sources.
GoogleBigQueryDataSource (string) --
The ability to create, update, and share Google BigQuery data sources.
CreateGoogleBigQueryDataSource (string) --
The ability to create Google BigQuery data sources.
UpdateGoogleBigQueryDataSource (string) --
The ability to update Google BigQuery data sources.
ShareGoogleBigQueryDataSource (string) --
The ability to share Google BigQuery data sources.
DatabricksDataSource (string) --
The ability to create, update, and share Databricks data sources.
CreateDatabricksDataSource (string) --
The ability to create Databricks data sources.
UpdateDatabricksDataSource (string) --
The ability to update Databricks data sources.
ShareDatabricksDataSource (string) --
The ability to share Databricks data sources.
StarburstDataSource (string) --
The ability to create, update, and share Starburst data sources.
CreateStarburstDataSource (string) --
The ability to create Starburst data sources.
UpdateStarburstDataSource (string) --
The ability to update Starburst data sources.
ShareStarburstDataSource (string) --
The ability to share Starburst data sources.
TrinoDataSource (string) --
The ability to create, update, and share Trino data sources.
CreateTrinoDataSource (string) --
The ability to create Trino data sources.
UpdateTrinoDataSource (string) --
The ability to update Trino data sources.
ShareTrinoDataSource (string) --
The ability to share Trino data sources.
ImpalaDataSource (string) --
The ability to create, update, and share Impala data sources.
CreateImpalaDataSource (string) --
The ability to create Impala data sources.
UpdateImpalaDataSource (string) --
The ability to update Impala data sources.
ShareImpalaDataSource (string) --
The ability to share Impala data sources.
TeradataDataSource (string) --
The ability to create, update, and share Teradata data sources.
CreateTeradataDataSource (string) --
The ability to create Teradata data sources.
UpdateTeradataDataSource (string) --
The ability to update Teradata data sources.
ShareTeradataDataSource (string) --
The ability to share Teradata data sources.
PrestoDataSource (string) --
The ability to create, update, and share Presto data sources.
CreatePrestoDataSource (string) --
The ability to create Presto data sources.
UpdatePrestoDataSource (string) --
The ability to update Presto data sources.
SharePrestoDataSource (string) --
The ability to share Presto data sources.
SparkDataSource (string) --
The ability to create, update, and share Spark data sources.
CreateSparkDataSource (string) --
The ability to create Spark data sources.
UpdateSparkDataSource (string) --
The ability to update Spark data sources.
ShareSparkDataSource (string) --
The ability to share Spark data sources.
ExasolDataSource (string) --
The ability to create, update, and share Exasol data sources.
CreateExasolDataSource (string) --
The ability to create Exasol data sources.
UpdateExasolDataSource (string) --
The ability to update Exasol data sources.
ShareExasolDataSource (string) --
The ability to share Exasol data sources.
Db2DataSource (string) --
The ability to create, update, and share Db2 data sources.
CreateDb2DataSource (string) --
The ability to create Db2 data sources.
UpdateDb2DataSource (string) --
The ability to update Db2 data sources.
ShareDb2DataSource (string) --
The ability to share Db2 data sources.
SapHanaDataSource (string) --
The ability to create, update, and share SAP HANA data sources.
CreateSapHanaDataSource (string) --
The ability to create SAP HANA data sources.
UpdateSapHanaDataSource (string) --
The ability to update SAP HANA data sources.
ShareSapHanaDataSource (string) --
The ability to share SAP HANA data sources.
DenodoDataSource (string) --
The ability to create, update, and share Denodo data sources.
CreateDenodoDataSource (string) --
The ability to create Denodo data sources.
UpdateDenodoDataSource (string) --
The ability to update Denodo data sources.
ShareDenodoDataSource (string) --
The ability to share Denodo data sources.
DremioDataSource (string) --
The ability to create, update, and share Dremio data sources.
CreateDremioDataSource (string) --
The ability to create Dremio data sources.
UpdateDremioDataSource (string) --
The ability to update Dremio data sources.
ShareDremioDataSource (string) --
The ability to share Dremio data sources.
SalesforceDataSource (string) --
The ability to create, update, and share Salesforce data sources.
CreateSalesforceDataSource (string) --
The ability to create Salesforce data sources.
UpdateSalesforceDataSource (string) --
The ability to update Salesforce data sources.
ShareSalesforceDataSource (string) --
The ability to share Salesforce data sources.
RadiantDataSource (string) --
The ability to create, update, and share Amazon QuickSight data sources.
CreateRadiantDataSource (string) --
The ability to create Amazon QuickSight data sources.
UpdateRadiantDataSource (string) --
The ability to update Amazon QuickSight data sources.
ShareRadiantDataSource (string) --
The ability to share Amazon QuickSight data sources.
PayPalDataSource (string) --
The ability to create, update, and share PayPal data sources.
CreatePayPalDataSource (string) --
The ability to create PayPal data sources.
UpdatePayPalDataSource (string) --
The ability to update PayPal data sources.
SharePayPalDataSource (string) --
The ability to share PayPal data sources.
SquareDataSource (string) --
The ability to create, update, and share Square data sources.
CreateSquareDataSource (string) --
The ability to create Square data sources.
UpdateSquareDataSource (string) --
The ability to update Square data sources.
ShareSquareDataSource (string) --
The ability to share Square data sources.
GitHubDataSource (string) --
The ability to create, update, and share GitHub data sources.
CreateGitHubDataSource (string) --
The ability to create GitHub data sources.
UpdateGitHubDataSource (string) --
The ability to update GitHub data sources.
ShareGitHubDataSource (string) --
The ability to share GitHub data sources.
TwitterDataSource (string) --
The ability to create, update, and share Twitter data sources.
CreateTwitterDataSource (string) --
The ability to create Twitter data sources.
UpdateTwitterDataSource (string) --
The ability to update Twitter data sources.
ShareTwitterDataSource (string) --
The ability to share Twitter data sources.
JiraDataSource (string) --
The ability to create, update, and share Jira data sources.
CreateJiraDataSource (string) --
The ability to create Jira data sources.
UpdateJiraDataSource (string) --
The ability to update Jira data sources.
ShareJiraDataSource (string) --
The ability to share Jira data sources.
ServiceNowDataSource (string) --
The ability to create, update, and share ServiceNow data sources.
CreateServiceNowDataSource (string) --
The ability to create ServiceNow data sources.
UpdateServiceNowDataSource (string) --
The ability to update ServiceNow data sources.
ShareServiceNowDataSource (string) --
The ability to share ServiceNow data sources.
AdobeAnalyticsDataSource (string) --
The ability to create, update, and share Adobe Analytics data sources.
CreateAdobeAnalyticsDataSource (string) --
The ability to create Adobe Analytics data sources.
UpdateAdobeAnalyticsDataSource (string) --
The ability to update Adobe Analytics data sources.
ShareAdobeAnalyticsDataSource (string) --
The ability to share Adobe Analytics data sources.
GoogleAnalyticsDataSource (string) --
The ability to create, update, and share Google Analytics data sources.
CreateGoogleAnalyticsDataSource (string) --
The ability to create Google Analytics data sources.
UpdateGoogleAnalyticsDataSource (string) --
The ability to update Google Analytics data sources.
ShareGoogleAnalyticsDataSource (string) --
The ability to share Google Analytics data sources.
GoogleSheetsDataSource (string) --
The ability to create, update, and share Google Sheets data sources.
CreateGoogleSheetsDataSource (string) --
The ability to create Google Sheets data sources.
UpdateGoogleSheetsDataSource (string) --
The ability to update Google Sheets data sources.
ShareGoogleSheetsDataSource (string) --
The ability to share Google Sheets data sources.
DocumentDbDataSource (string) --
The ability to create, update, and share Amazon DocumentDB data sources.
CreateDocumentDbDataSource (string) --
The ability to create Amazon DocumentDB data sources.
UpdateDocumentDbDataSource (string) --
The ability to update Amazon DocumentDB data sources.
ShareDocumentDbDataSource (string) --
The ability to share Amazon DocumentDB data sources.
MongoDbDataSource (string) --
The ability to create, update, and share MongoDB data sources.
CreateMongoDbDataSource (string) --
The ability to create MongoDB data sources.
UpdateMongoDbDataSource (string) --
The ability to update MongoDB data sources.
ShareMongoDbDataSource (string) --
The ability to share MongoDB data sources.
MongoAtlasDataSource (string) --
The ability to create, update, and share MongoDB Atlas data sources.
CreateMongoAtlasDataSource (string) --
The ability to create MongoDB Atlas data sources.
UpdateMongoAtlasDataSource (string) --
The ability to update MongoDB Atlas data sources.
ShareMongoAtlasDataSource (string) --
The ability to share MongoDB Atlas data sources.
DynamoDbDataSource (string) --
The ability to create, update, and share Amazon DynamoDB data sources.
CreateDynamoDbDataSource (string) --
The ability to create Amazon DynamoDB data sources.
UpdateDynamoDbDataSource (string) --
The ability to update Amazon DynamoDB data sources.
ShareDynamoDbDataSource (string) --
The ability to share Amazon DynamoDB data sources.
dict
The governance configuration for the custom permissions profile. When governance controls are defined for a category, any capabilities in that category not explicitly set to ALLOW in Capabilities are denied. Even newly added capabilities in the category are implicitly disabled when Amazon Quick releases them.
DefaultCategoryEffects (dict) --
A map of DefaultCategoryEffects.
(string) --
The name of a governance category. A governance category groups related capabilities so that you can apply a default effect to all capabilities in the category at once. Valid values:
AI – Capabilities related to Amazon Quick AI features.
(string) --
The default effect that Amazon Quick applies to capabilities in a governed category when you do not explicitly list those capabilities in Capabilities. Valid values:
DENY_BY_DEFAULT – Amazon Quick denies any capability access in the given category that the profile does not explicitly set to ALLOW.
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.
{'UnmaterializedCalculatedColumns': [{'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'SubType': 'FLOAT | FIXED',
'Type': 'STRING | INTEGER | DECIMAL | '
'DATETIME'}]}
Creates a dataset.
See also: AWS API Documentation
Request Syntax
client.create_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'SaaSTable': {
'DataSourceArn': 'string',
'TablePath': [
{
'Name': 'string',
'Id': 'string'
},
],
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'FileSource': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'SheetIndex': 123,
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
'CreateColumnsOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
Permissions=[
{
'Principal': 'string',
'Actions': [
'string',
]
},
],
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
FolderArns=[
'string',
],
PerformanceConfiguration={
'UniqueKeys': [
{
'ColumnNames': [
'string',
]
},
]
},
UseAs='RLS_RULES',
DataPrepConfiguration={
'SourceTableMap': {
'string': {
'PhysicalTableId': 'string',
'DataSet': {
'DataSetArn': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'TransformStepMap': {
'string': {
'ImportTableStep': {
'Alias': 'string',
'Source': {
'SourceTableId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
}
},
'ProjectStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FiltersStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'FilterOperations': [
{
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
]
},
'CreateColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RenameColumnOperations': [
{
'ColumnName': 'string',
'NewColumnName': 'string'
},
]
},
'CastColumnTypesStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'CastColumnTypeOperations': [
{
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
]
},
'JoinStep': {
'Alias': 'string',
'LeftOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RightOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string',
'LeftOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
},
'RightOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
}
},
'AggregateStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'Aggregations': [
{
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
},
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
},
'PivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'ValueColumnConfiguration': {
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
}
},
'PivotConfiguration': {
'LabelColumnName': 'string',
'PivotedLabels': [
{
'LabelName': 'string',
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
}
},
'UnpivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ColumnsToUnpivot': [
{
'ColumnName': 'string',
'NewValue': 'string'
},
],
'UnpivotedLabelColumnName': 'string',
'UnpivotedLabelColumnId': 'string',
'UnpivotedValueColumnName': 'string',
'UnpivotedValueColumnId': 'string'
},
'AppendStep': {
'Alias': 'string',
'FirstSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'SecondSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'AppendedColumns': [
{
'ColumnName': 'string',
'NewColumnId': 'string'
},
]
}
}
},
'DestinationTableMap': {
'string': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string'
}
}
}
},
SemanticModelConfiguration={
'TableMap': {
'string': {
'Alias': 'string',
'DestinationTableId': 'string',
'RowLevelPermissionConfiguration': {
'TagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
}
},
'SemanticMetadata': {
'ColumnMetadata': [
{
'ColumnNames': [
'string',
],
'ColumnProperties': [
{
'Description': {
'Text': 'string'
},
'AdditionalNotes': {
'Text': 'string'
},
'SemanticType': {
'GeographicalRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
}
},
]
},
]
}
}
},
'SemanticMetadata': [
{
'Description': {
'Text': 'string'
},
'CustomInstructions': [
{
'InlineCustomInstruction': {
'InstructionText': 'string',
'UploadedDocumentMetadata': {
'Name': 'string'
}
}
},
]
},
]
},
UnmaterializedCalculatedColumns=[
{
'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for an S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
SaaSTable (dict) --
A physical table type for Software-as-a-Service (SaaS) sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the SaaS data source.
TablePath (list) -- [REQUIRED]
The hierarchical path to the table within the SaaS data source.
(dict) --
An element in the hierarchical path to a table within a data source, containing both name and identifier.
Name (string) --
The name of the path element.
Id (string) --
The unique identifier of the path element.
InputColumns (list) -- [REQUIRED]
The list of input columns available from the SaaS table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
FileSource (dict) --
A physical table type for a file data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the source file.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
SheetIndex (integer) -- [REQUIRED]
The zero-based index of the sheet to use within the file. For files that contain multiple sheets, this identifies which sheet to read. Files that contain a single sheet, or that have no concept of sheets, use sheet 0.
InputColumns (list) -- [REQUIRED]
The column schema of the file.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
dict
Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) -- [REQUIRED]
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
list
A list of resource permissions on the dataset.
(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
The row-level security configuration for the data that you want to create. This parameter is used with the legacy data preparation experience.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ``ColumnLevelPermissionRule ``.
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Quick Sight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
list
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
(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
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
list
When you create the dataset, Amazon Quick Sight adds the dataset to these folders.
(string) --
dict
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
UniqueKeys (list) --
A UniqueKey configuration.
(dict) --
A UniqueKey configuration that references a dataset column.
ColumnNames (list) -- [REQUIRED]
The name of the column that is referenced in the UniqueKey configuration.
(string) --
string
The usage of the dataset. RLS_RULES must be specified for RLS permission datasets.
dict
The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
SourceTableMap (dict) -- [REQUIRED]
A map of source tables that provide information about underlying sources.
(string) --
(dict) --
A source table that provides initial data from either a physical table or parent dataset.
PhysicalTableId (string) --
The identifier of the physical table that serves as the data source.
DataSet (dict) --
A parent dataset that serves as the data source instead of a physical table.
DataSetArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the parent dataset.
InputColumns (list) -- [REQUIRED]
The list of input columns available from the parent dataset.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
TransformStepMap (dict) -- [REQUIRED]
A map of transformation steps that process the data.
(string) --
(dict) --
A step in data preparation that performs a specific operation on the data.
ImportTableStep (dict) --
A transform step that brings data from a source table.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source configuration that specifies which source table to import and any column mappings.
SourceTableId (string) -- [REQUIRED]
The identifier of the source table to import data from.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers during the import.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectStep (dict) --
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FiltersStep (dict) --
A transform step that applies filter conditions.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for filtering.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
FilterOperations (list) -- [REQUIRED]
The list of filter operations to apply.
(dict) --
A transform operation that filters rows based on a condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) -- [REQUIRED]
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsStep (dict) --
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnsStep (dict) --
A transform step that changes the names of one or more columns.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for column renaming.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
RenameColumnOperations (list) -- [REQUIRED]
The list of column rename operations to perform, specifying old and new column names.
(dict) --
A transform operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypesStep (dict) --
A transform step that changes the data types of one or more columns.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for the type casting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
CastColumnTypeOperations (list) -- [REQUIRED]
The list of column type casting operations to perform.
(dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
JoinStep (dict) --
A transform step that combines data from two sources based on specified join conditions.
Alias (string) -- [REQUIRED]
Alias for this operation.
LeftOperand (dict) -- [REQUIRED]
The left operand for the join operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
RightOperand (dict) -- [REQUIRED]
The right operand for the join operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Type (string) -- [REQUIRED]
The type of join to perform, such as INNER, LEFT, RIGHT, or OUTER.
OnClause (string) -- [REQUIRED]
The join condition that specifies how to match rows between the left and right operands.
LeftOperandProperties (dict) --
Properties that control how the left operand's columns are handled in the join result.
OutputColumnNameOverrides (list) -- [REQUIRED]
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) -- [REQUIRED]
The new name to assign to the column in the output.
RightOperandProperties (dict) --
Properties that control how the right operand's columns are handled in the join result.
OutputColumnNameOverrides (list) -- [REQUIRED]
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) -- [REQUIRED]
The new name to assign to the column in the output.
AggregateStep (dict) --
A transform step that groups data and applies aggregation functions to calculate summary values.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for the aggregation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.
(string) --
Aggregations (list) -- [REQUIRED]
The list of aggregation functions to apply to the grouped data, such as SUM, COUNT, or AVERAGE.
(dict) --
Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.
AggregationFunction (dict) -- [REQUIRED]
The aggregation function to apply, such as SUM, COUNT, AVERAGE, MIN, MAX
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) -- [REQUIRED]
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) -- [REQUIRED]
The string used to separate values in the concatenated result.
Distinct (boolean) -- [REQUIRED]
Whether to include only distinct values in the concatenated result, removing duplicates.
NewColumnName (string) -- [REQUIRED]
The name for the new column that will contain the aggregated values.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the aggregated values.
PivotStep (dict) --
A transform step that converts row values into columns to reshape the data structure.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for pivoting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the pivot operation.
(string) --
ValueColumnConfiguration (dict) -- [REQUIRED]
Configuration for how to aggregate values when multiple rows map to the same pivoted column.
AggregationFunction (dict) --
The aggregation function to apply when multiple values map to the same pivoted cell.
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) -- [REQUIRED]
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) -- [REQUIRED]
The string used to separate values in the concatenated result.
Distinct (boolean) -- [REQUIRED]
Whether to include only distinct values in the concatenated result, removing duplicates.
PivotConfiguration (dict) -- [REQUIRED]
Configuration that specifies which labels to pivot and how to structure the resulting columns.
LabelColumnName (string) --
The name of the column that contains the labels to be pivoted into separate columns.
PivotedLabels (list) -- [REQUIRED]
The list of specific label values to pivot into separate columns.
(dict) --
Specifies a label value to be pivoted into a separate column, including the new column name and identifier.
LabelName (string) -- [REQUIRED]
The label value from the source data to be pivoted.
NewColumnName (string) -- [REQUIRED]
The name for the new column created from this pivoted label.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the new column created from this pivoted label.
UnpivotStep (dict) --
A transform step that converts columns into rows to normalize the data structure.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for unpivoting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ColumnsToUnpivot (list) -- [REQUIRED]
The list of columns to unpivot from the source data.
(dict) --
Specifies a column to be unpivoted, transforming it from a column into rows with associated values.
ColumnName (string) --
The name of the column to unpivot from the source data.
NewValue (string) --
The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.
UnpivotedLabelColumnName (string) -- [REQUIRED]
The name for the new column that will contain the unpivoted column names.
UnpivotedLabelColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the unpivoted column names.
UnpivotedValueColumnName (string) -- [REQUIRED]
The name for the new column that will contain the unpivoted values.
UnpivotedValueColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the unpivoted values.
AppendStep (dict) --
A transform step that combines rows from multiple sources by stacking them vertically.
Alias (string) -- [REQUIRED]
Alias for this operation.
FirstSource (dict) --
The first data source to be included in the append operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
SecondSource (dict) --
The second data source to be appended to the first source.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
AppendedColumns (list) -- [REQUIRED]
The list of columns to include in the appended result, mapping columns from both sources.
(dict) --
Represents a column that will be included in the result of an append operation, combining data from multiple sources.
ColumnName (string) -- [REQUIRED]
The name of the column to include in the appended result.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the column in the appended result.
DestinationTableMap (dict) -- [REQUIRED]
A map of destination tables that receive the final prepared data.
(string) --
(dict) --
Defines a destination table in data preparation that receives the final transformed data.
Alias (string) -- [REQUIRED]
Alias for the destination table.
Source (dict) -- [REQUIRED]
The source configuration that specifies which transform operation provides data to this destination table.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides data to the destination table.
dict
The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.
TableMap (dict) --
A map of semantic tables that define the analytical structure.
(string) --
(dict) --
A semantic table that represents the final analytical structure of the data.
Alias (string) -- [REQUIRED]
Alias for the semantic table.
DestinationTableId (string) -- [REQUIRED]
The identifier of the destination table from data preparation that provides data to this semantic table.
RowLevelPermissionConfiguration (dict) --
Configuration for row level security that control data access for this semantic table.
TagConfiguration (dict) --
The configuration of tags on a dataset to set row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
RowLevelPermissionDataSet (dict) --
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide.
The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
SemanticMetadata (dict) --
The column-level semantic metadata for this semantic table.
ColumnMetadata (list) --
A list of column semantic metadata entries.
(dict) --
Semantic metadata shared across one or more columns.
ColumnNames (list) --
The names of the columns this metadata applies to.
(string) --
ColumnProperties (list) -- [REQUIRED]
The semantic properties for the specified columns.
(dict) --
A semantic property for a column.
Description (dict) --
A description of the column.
Text (string) --
The text of a description for a column.
AdditionalNotes (dict) --
Additional notes for the column.
Text (string) --
The additional notes text.
SemanticType (dict) --
The semantic type of the column.
GeographicalRole (string) --
The geographical role of the column in the new data preparation experience.
SemanticMetadata (list) --
The dataset-level semantic metadata, including a description and custom instructions.
(dict) --
Semantic metadata for a dataset, including a description and custom instructions.
Description (dict) --
A description of the dataset.
Text (string) -- [REQUIRED]
The descriptive text for the dataset.
CustomInstructions (list) --
A list of custom instructions that guide how the dataset should be consumed.
(dict) --
A custom instruction that provides guidance on how the dataset should be consumed.
InlineCustomInstruction (dict) --
An inline custom instruction containing text and optional uploaded document metadata.
InstructionText (string) -- [REQUIRED]
The instruction text content.
UploadedDocumentMetadata (dict) --
Metadata about an uploaded document associated with this instruction.
Name (string) --
The name of the uploaded document.
list
A list of unmaterialized calculated columns for the dataset. These columns are computed at analysis time and are not stored in the prepared data. You can only use this with the new data preparation experience.
(dict) --
A calculated column that is not materialized in the prepared data. The column is computed at analysis time and can use aggregate expressions.
ColumnId (string) -- [REQUIRED]
A unique ID to identify the unmaterialized calculated column.
ColumnName (string) -- [REQUIRED]
The name of the unmaterialized calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the unmaterialized calculated column.
Type (string) --
The data type of the unmaterialized calculated column.
SubType (string) --
The sub data type of the unmaterialized calculated column.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}},
'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}
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'|'S3_TABLES'|'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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': 'string'
},
'ServiceAccountCredentials': {
'AdminAccountEmail': 'string',
'ServiceAccountPrivateKey': 'string',
'ClientEmail': 'string'
},
'SharePointClientCredentials': {
'KmsKeyArn': 'string',
'CertThumbprint': 'string'
},
'OneDriveClientCredentials': {
'KmsKeyArn': 'string',
'CertThumbprint': '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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
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.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
ServiceAccountCredentials (dict) --
The service account credentials for connecting to a data source that uses Google Workspace domain-wide delegation.
AdminAccountEmail (string) -- [REQUIRED]
The email address of the Google Workspace administrator account that the service account impersonates through domain-wide delegation. This field is required.
ServiceAccountPrivateKey (string) -- [REQUIRED]
The private key of the Google service account used for domain-wide delegation. This field is required.
ClientEmail (string) -- [REQUIRED]
The client email address of the Google service account used for domain-wide delegation. This field is required.
SharePointClientCredentials (dict) --
The client credentials for connecting to a Microsoft SharePoint data source using two-legged OAuth (2LO) certificate-based authentication.
KmsKeyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the SharePoint certificate credentials. This field is required.
CertThumbprint (string) -- [REQUIRED]
The thumbprint of the certificate used for two-legged OAuth (2LO) authentication to SharePoint. This field is required.
OneDriveClientCredentials (dict) --
The client credentials for connecting to a Microsoft OneDrive data source using two-legged OAuth (2LO) certificate-based authentication.
KmsKeyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the OneDrive certificate credentials. This field is required.
CertThumbprint (string) -- [REQUIRED]
The thumbprint of the certificate used for two-legged OAuth (2LO) authentication to OneDrive. This field is required.
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.
{'Policy': {'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}}
Describes an approval policy in Quick Sight.
See also: AWS API Documentation
Request Syntax
client.describe_approval_policy(
PolicyId='string'
)
string
[REQUIRED]
The unique identifier of the approval policy to describe.
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyArn': 'string',
'Name': 'string',
'Description': 'string',
'Actions': [
'SHARE'|'PUBLISH',
],
'AssetTypes': [
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
'ApplicableTo': {
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
'ApprovalGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Policy (dict) --
The approval policy.
PolicyId (string) --
The unique identifier of the approval policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the approval policy.
Name (string) --
The name of the approval policy.
Description (string) --
A description of the approval policy.
Actions (list) --
The list of governed actions that trigger the approval workflow.
(string) --
AssetTypes (list) --
The list of asset types that the approval policy applies to.
(string) --
ApplicableTo (dict) --
The scoping configuration that determines who the approval policy applies to.
Type (string) --
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
ApprovalGroups (list) --
The list of group ARNs whose members can approve requests.
(string) --
CreatedAt (datetime) --
The date and time that the approval policy was created.
UpdatedAt (datetime) --
The date and time that the approval policy was last updated.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}}}
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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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'
},
],
'TopicsV2': [
{
'TopicId': 'string',
'Name': 'string',
'Description': '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',
]
}
},
],
'TopicsV2': [
{
'TopicIds': [
'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'
},
]
},
],
'TopicsV2': [
{
'TopicIds': [
'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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
TopicsV2 (list) --
A list of overrides for any Topic resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single topic that is being imported.
TopicId (string) --
The ID of the topic that you want to apply overrides to.
Name (string) --
A new name for the topic.
Description (string) --
A new description for the topic.
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) --
TopicsV2 (list) --
A list of permissions for the topics that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of topic IDs.
TopicIds (list) --
A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle.
(string) --
Permissions (dict) --
A list of permissions for the topics 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) --
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.
TopicsV2 (list) --
A list of tag overrides for any Topic 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 topic IDs.
TopicIds (list) --
A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle.
(string) --
Tags (list) --
A list of tags for the topics 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.
{'CustomPermissions': {'Capabilities': {'CreateAndUpdateLocalMCPAction': 'DENY '
'| '
'ALLOW',
'LocalMCPAction': 'DENY | ALLOW',
'UseLocalMCPAction': 'DENY | ALLOW'}}}
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'|'ALLOW',
'ExportToExcel': 'DENY'|'ALLOW',
'ExportToPdf': 'DENY'|'ALLOW',
'PrintReports': 'DENY'|'ALLOW',
'CreateAndUpdateThemes': 'DENY'|'ALLOW',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY'|'ALLOW',
'ShareAnalyses': 'DENY'|'ALLOW',
'CreateAndUpdateDatasets': 'DENY'|'ALLOW',
'ShareDatasets': 'DENY'|'ALLOW',
'SubscribeDashboardEmailReports': 'DENY'|'ALLOW',
'CreateAndUpdateDashboardEmailReports': 'DENY'|'ALLOW',
'ShareDashboards': 'DENY'|'ALLOW',
'CreateAndUpdateThresholdAlerts': 'DENY'|'ALLOW',
'RenameSharedFolders': 'DENY'|'ALLOW',
'CreateSharedFolders': 'DENY'|'ALLOW',
'CreateAndUpdateDataSources': 'DENY'|'ALLOW',
'ShareDataSources': 'DENY'|'ALLOW',
'ViewAccountSPICECapacity': 'DENY'|'ALLOW',
'CreateSPICEDataset': 'DENY'|'ALLOW',
'ExportToPdfInScheduledReports': 'DENY'|'ALLOW',
'ExportToCsvInScheduledReports': 'DENY'|'ALLOW',
'ExportToExcelInScheduledReports': 'DENY'|'ALLOW',
'IncludeContentInScheduledReportsEmail': 'DENY'|'ALLOW',
'Dashboard': 'DENY'|'ALLOW',
'Analysis': 'DENY'|'ALLOW',
'Automate': 'DENY'|'ALLOW',
'Flow': 'DENY'|'ALLOW',
'Apps': 'DENY'|'ALLOW',
'CreateAndUpdateApps': 'DENY'|'ALLOW',
'ShareApps': 'DENY'|'ALLOW',
'InvokeAppsAIInference': 'DENY'|'ALLOW',
'AccessAppsNativeDataStore': 'DENY'|'ALLOW',
'PublishWithoutApproval': 'DENY'|'ALLOW',
'UseBedrockModels': 'DENY'|'ALLOW',
'PerformFlowUiTask': 'DENY'|'ALLOW',
'ApproveFlowShareRequests': 'DENY'|'ALLOW',
'UseAgentWebSearch': 'DENY'|'ALLOW',
'KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateKnowledgeBases': 'DENY'|'ALLOW',
'ShareKnowledgeBases': 'DENY'|'ALLOW',
'SharePointKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointKnowledgeBase': 'DENY'|'ALLOW',
'ShareSharePointKnowledgeBase': 'DENY'|'ALLOW',
'UseSharePointKnowledgeBase': 'DENY'|'ALLOW',
'GoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'WebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'ShareWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'UseWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'S3KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateS3KnowledgeBase': 'DENY'|'ALLOW',
'ShareS3KnowledgeBase': 'DENY'|'ALLOW',
'UseS3KnowledgeBase': 'DENY'|'ALLOW',
'ConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'ShareConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'UseConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'OneDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'QBusinessKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'ShareQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'UseQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'BedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'ShareBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'UseBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'BoxKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBoxKnowledgeBase': 'DENY'|'ALLOW',
'ShareBoxKnowledgeBase': 'DENY'|'ALLOW',
'UseBoxKnowledgeBase': 'DENY'|'ALLOW',
'IDCKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateIDCKnowledgeBase': 'DENY'|'ALLOW',
'ShareIDCKnowledgeBase': 'DENY'|'ALLOW',
'UseIDCKnowledgeBase': 'DENY'|'ALLOW',
'Action': 'DENY'|'ALLOW',
'GenericHTTPAction': 'DENY'|'ALLOW',
'CreateAndUpdateGenericHTTPAction': 'DENY'|'ALLOW',
'ShareGenericHTTPAction': 'DENY'|'ALLOW',
'UseGenericHTTPAction': 'DENY'|'ALLOW',
'AsanaAction': 'DENY'|'ALLOW',
'CreateAndUpdateAsanaAction': 'DENY'|'ALLOW',
'ShareAsanaAction': 'DENY'|'ALLOW',
'UseAsanaAction': 'DENY'|'ALLOW',
'SlackAction': 'DENY'|'ALLOW',
'CreateAndUpdateSlackAction': 'DENY'|'ALLOW',
'ShareSlackAction': 'DENY'|'ALLOW',
'UseSlackAction': 'DENY'|'ALLOW',
'ServiceNowAction': 'DENY'|'ALLOW',
'CreateAndUpdateServiceNowAction': 'DENY'|'ALLOW',
'ShareServiceNowAction': 'DENY'|'ALLOW',
'UseServiceNowAction': 'DENY'|'ALLOW',
'SalesforceAction': 'DENY'|'ALLOW',
'CreateAndUpdateSalesforceAction': 'DENY'|'ALLOW',
'ShareSalesforceAction': 'DENY'|'ALLOW',
'UseSalesforceAction': 'DENY'|'ALLOW',
'MSExchangeAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSExchangeAction': 'DENY'|'ALLOW',
'ShareMSExchangeAction': 'DENY'|'ALLOW',
'UseMSExchangeAction': 'DENY'|'ALLOW',
'PagerDutyAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAction': 'DENY'|'ALLOW',
'SharePagerDutyAction': 'DENY'|'ALLOW',
'UsePagerDutyAction': 'DENY'|'ALLOW',
'JiraAction': 'DENY'|'ALLOW',
'CreateAndUpdateJiraAction': 'DENY'|'ALLOW',
'ShareJiraAction': 'DENY'|'ALLOW',
'UseJiraAction': 'DENY'|'ALLOW',
'ConfluenceAction': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceAction': 'DENY'|'ALLOW',
'ShareConfluenceAction': 'DENY'|'ALLOW',
'UseConfluenceAction': 'DENY'|'ALLOW',
'OneDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveAction': 'DENY'|'ALLOW',
'ShareOneDriveAction': 'DENY'|'ALLOW',
'UseOneDriveAction': 'DENY'|'ALLOW',
'SharePointAction': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointAction': 'DENY'|'ALLOW',
'ShareSharePointAction': 'DENY'|'ALLOW',
'UseSharePointAction': 'DENY'|'ALLOW',
'MSTeamsAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSTeamsAction': 'DENY'|'ALLOW',
'ShareMSTeamsAction': 'DENY'|'ALLOW',
'UseMSTeamsAction': 'DENY'|'ALLOW',
'GoogleCalendarAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleCalendarAction': 'DENY'|'ALLOW',
'ShareGoogleCalendarAction': 'DENY'|'ALLOW',
'UseGoogleCalendarAction': 'DENY'|'ALLOW',
'ZendeskAction': 'DENY'|'ALLOW',
'CreateAndUpdateZendeskAction': 'DENY'|'ALLOW',
'ShareZendeskAction': 'DENY'|'ALLOW',
'UseZendeskAction': 'DENY'|'ALLOW',
'SmartsheetAction': 'DENY'|'ALLOW',
'CreateAndUpdateSmartsheetAction': 'DENY'|'ALLOW',
'ShareSmartsheetAction': 'DENY'|'ALLOW',
'UseSmartsheetAction': 'DENY'|'ALLOW',
'SAPBusinessPartnerAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'ShareSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'UseSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'SAPProductMasterDataAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY'|'ALLOW',
'ShareSAPProductMasterDataAction': 'DENY'|'ALLOW',
'UseSAPProductMasterDataAction': 'DENY'|'ALLOW',
'SAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'ShareSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'UseSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'SAPBillOfMaterialAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'ShareSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'UseSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'SAPMaterialStockAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPMaterialStockAction': 'DENY'|'ALLOW',
'ShareSAPMaterialStockAction': 'DENY'|'ALLOW',
'UseSAPMaterialStockAction': 'DENY'|'ALLOW',
'FactSetAction': 'DENY'|'ALLOW',
'CreateAndUpdateFactSetAction': 'DENY'|'ALLOW',
'ShareFactSetAction': 'DENY'|'ALLOW',
'UseFactSetAction': 'DENY'|'ALLOW',
'AmazonSThreeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonSThreeAction': 'DENY'|'ALLOW',
'ShareAmazonSThreeAction': 'DENY'|'ALLOW',
'UseAmazonSThreeAction': 'DENY'|'ALLOW',
'TextractAction': 'DENY'|'ALLOW',
'CreateAndUpdateTextractAction': 'DENY'|'ALLOW',
'ShareTextractAction': 'DENY'|'ALLOW',
'UseTextractAction': 'DENY'|'ALLOW',
'ComprehendAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendAction': 'DENY'|'ALLOW',
'ShareComprehendAction': 'DENY'|'ALLOW',
'UseComprehendAction': 'DENY'|'ALLOW',
'ComprehendMedicalAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendMedicalAction': 'DENY'|'ALLOW',
'ShareComprehendMedicalAction': 'DENY'|'ALLOW',
'UseComprehendMedicalAction': 'DENY'|'ALLOW',
'AmazonBedrockARSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockARSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockARSAction': 'DENY'|'ALLOW',
'AmazonBedrockFSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockFSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockFSAction': 'DENY'|'ALLOW',
'AmazonBedrockKRSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'MCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateMCPAction': 'DENY'|'ALLOW',
'ShareMCPAction': 'DENY'|'ALLOW',
'UseMCPAction': 'DENY'|'ALLOW',
'LocalMCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateLocalMCPAction': 'DENY'|'ALLOW',
'UseLocalMCPAction': 'DENY'|'ALLOW',
'OpenAPIAction': 'DENY'|'ALLOW',
'CreateAndUpdateOpenAPIAction': 'DENY'|'ALLOW',
'ShareOpenAPIAction': 'DENY'|'ALLOW',
'UseOpenAPIAction': 'DENY'|'ALLOW',
'SandPGMIAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGMIAction': 'DENY'|'ALLOW',
'ShareSandPGMIAction': 'DENY'|'ALLOW',
'UseSandPGMIAction': 'DENY'|'ALLOW',
'SandPGlobalEnergyAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'ShareSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'UseSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'BambooHRAction': 'DENY'|'ALLOW',
'CreateAndUpdateBambooHRAction': 'DENY'|'ALLOW',
'ShareBambooHRAction': 'DENY'|'ALLOW',
'UseBambooHRAction': 'DENY'|'ALLOW',
'BoxAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateBoxAgentAction': 'DENY'|'ALLOW',
'ShareBoxAgentAction': 'DENY'|'ALLOW',
'UseBoxAgentAction': 'DENY'|'ALLOW',
'CanvaAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateCanvaAgentAction': 'DENY'|'ALLOW',
'ShareCanvaAgentAction': 'DENY'|'ALLOW',
'UseCanvaAgentAction': 'DENY'|'ALLOW',
'GithubAction': 'DENY'|'ALLOW',
'CreateAndUpdateGithubAction': 'DENY'|'ALLOW',
'ShareGithubAction': 'DENY'|'ALLOW',
'UseGithubAction': 'DENY'|'ALLOW',
'NotionAction': 'DENY'|'ALLOW',
'CreateAndUpdateNotionAction': 'DENY'|'ALLOW',
'ShareNotionAction': 'DENY'|'ALLOW',
'UseNotionAction': 'DENY'|'ALLOW',
'LinearAction': 'DENY'|'ALLOW',
'CreateAndUpdateLinearAction': 'DENY'|'ALLOW',
'ShareLinearAction': 'DENY'|'ALLOW',
'UseLinearAction': 'DENY'|'ALLOW',
'HuggingFaceAction': 'DENY'|'ALLOW',
'CreateAndUpdateHuggingFaceAction': 'DENY'|'ALLOW',
'ShareHuggingFaceAction': 'DENY'|'ALLOW',
'UseHuggingFaceAction': 'DENY'|'ALLOW',
'MondayAction': 'DENY'|'ALLOW',
'CreateAndUpdateMondayAction': 'DENY'|'ALLOW',
'ShareMondayAction': 'DENY'|'ALLOW',
'UseMondayAction': 'DENY'|'ALLOW',
'HubspotAction': 'DENY'|'ALLOW',
'CreateAndUpdateHubspotAction': 'DENY'|'ALLOW',
'ShareHubspotAction': 'DENY'|'ALLOW',
'UseHubspotAction': 'DENY'|'ALLOW',
'IntercomAction': 'DENY'|'ALLOW',
'CreateAndUpdateIntercomAction': 'DENY'|'ALLOW',
'ShareIntercomAction': 'DENY'|'ALLOW',
'UseIntercomAction': 'DENY'|'ALLOW',
'NewRelicAction': 'DENY'|'ALLOW',
'CreateAndUpdateNewRelicAction': 'DENY'|'ALLOW',
'ShareNewRelicAction': 'DENY'|'ALLOW',
'UseNewRelicAction': 'DENY'|'ALLOW',
'PagerDutyAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAgentAction': 'DENY'|'ALLOW',
'SharePagerDutyAgentAction': 'DENY'|'ALLOW',
'UsePagerDutyAgentAction': 'DENY'|'ALLOW',
'VisierAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateVisierAgentAction': 'DENY'|'ALLOW',
'ShareVisierAgentAction': 'DENY'|'ALLOW',
'UseVisierAgentAction': 'DENY'|'ALLOW',
'ZoomAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomAction': 'DENY'|'ALLOW',
'ShareZoomAction': 'DENY'|'ALLOW',
'UseZoomAction': 'DENY'|'ALLOW',
'SnowFlakeAction': 'DENY'|'ALLOW',
'CreateAndUpdateSnowFlakeAction': 'DENY'|'ALLOW',
'ShareSnowFlakeAction': 'DENY'|'ALLOW',
'UseSnowFlakeAction': 'DENY'|'ALLOW',
'ZapierAction': 'DENY'|'ALLOW',
'CreateAndUpdateZapierAction': 'DENY'|'ALLOW',
'ShareZapierAction': 'DENY'|'ALLOW',
'UseZapierAction': 'DENY'|'ALLOW',
'AirtableAction': 'DENY'|'ALLOW',
'CreateAndUpdateAirtableAction': 'DENY'|'ALLOW',
'ShareAirtableAction': 'DENY'|'ALLOW',
'UseAirtableAction': 'DENY'|'ALLOW',
'DropboxAction': 'DENY'|'ALLOW',
'CreateAndUpdateDropboxAction': 'DENY'|'ALLOW',
'ShareDropboxAction': 'DENY'|'ALLOW',
'UseDropboxAction': 'DENY'|'ALLOW',
'GmailAction': 'DENY'|'ALLOW',
'CreateAndUpdateGmailAction': 'DENY'|'ALLOW',
'ShareGmailAction': 'DENY'|'ALLOW',
'UseGmailAction': 'DENY'|'ALLOW',
'GoogleAnalyticsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleAnalyticsAction': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsAction': 'DENY'|'ALLOW',
'UseGoogleAnalyticsAction': 'DENY'|'ALLOW',
'GoogleDocsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDocsAction': 'DENY'|'ALLOW',
'ShareGoogleDocsAction': 'DENY'|'ALLOW',
'UseGoogleDocsAction': 'DENY'|'ALLOW',
'GoogleDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveAction': 'DENY'|'ALLOW',
'ShareGoogleDriveAction': 'DENY'|'ALLOW',
'UseGoogleDriveAction': 'DENY'|'ALLOW',
'GoogleMeetAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleMeetAction': 'DENY'|'ALLOW',
'ShareGoogleMeetAction': 'DENY'|'ALLOW',
'UseGoogleMeetAction': 'DENY'|'ALLOW',
'GoogleSheetsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSheetsAction': 'DENY'|'ALLOW',
'ShareGoogleSheetsAction': 'DENY'|'ALLOW',
'UseGoogleSheetsAction': 'DENY'|'ALLOW',
'GoogleSlidesAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSlidesAction': 'DENY'|'ALLOW',
'ShareGoogleSlidesAction': 'DENY'|'ALLOW',
'UseGoogleSlidesAction': 'DENY'|'ALLOW',
'QuickBooksAction': 'DENY'|'ALLOW',
'CreateAndUpdateQuickBooksAction': 'DENY'|'ALLOW',
'ShareQuickBooksAction': 'DENY'|'ALLOW',
'UseQuickBooksAction': 'DENY'|'ALLOW',
'FigmaAction': 'DENY'|'ALLOW',
'CreateAndUpdateFigmaAction': 'DENY'|'ALLOW',
'ShareFigmaAction': 'DENY'|'ALLOW',
'UseFigmaAction': 'DENY'|'ALLOW',
'WhatsAppAction': 'DENY'|'ALLOW',
'CreateAndUpdateWhatsAppAction': 'DENY'|'ALLOW',
'ShareWhatsAppAction': 'DENY'|'ALLOW',
'UseWhatsAppAction': 'DENY'|'ALLOW',
'GoogleChatAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleChatAction': 'DENY'|'ALLOW',
'ShareGoogleChatAction': 'DENY'|'ALLOW',
'UseGoogleChatAction': 'DENY'|'ALLOW',
'OneNoteAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneNoteAction': 'DENY'|'ALLOW',
'ShareOneNoteAction': 'DENY'|'ALLOW',
'UseOneNoteAction': 'DENY'|'ALLOW',
'ShopifyAction': 'DENY'|'ALLOW',
'CreateAndUpdateShopifyAction': 'DENY'|'ALLOW',
'ShareShopifyAction': 'DENY'|'ALLOW',
'UseShopifyAction': 'DENY'|'ALLOW',
'AdobeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAdobeAction': 'DENY'|'ALLOW',
'ShareAdobeAction': 'DENY'|'ALLOW',
'UseAdobeAction': 'DENY'|'ALLOW',
'CiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'ShareCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'UseCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'ShareCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'UseCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'DunAndBradstreetAction': 'DENY'|'ALLOW',
'CreateAndUpdateDunAndBradstreetAction': 'DENY'|'ALLOW',
'ShareDunAndBradstreetAction': 'DENY'|'ALLOW',
'UseDunAndBradstreetAction': 'DENY'|'ALLOW',
'HGInsightsAction': 'DENY'|'ALLOW',
'CreateAndUpdateHGInsightsAction': 'DENY'|'ALLOW',
'ShareHGInsightsAction': 'DENY'|'ALLOW',
'UseHGInsightsAction': 'DENY'|'ALLOW',
'ZoomInfoAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomInfoAction': 'DENY'|'ALLOW',
'ShareZoomInfoAction': 'DENY'|'ALLOW',
'UseZoomInfoAction': 'DENY'|'ALLOW',
'MoodysAction': 'DENY'|'ALLOW',
'CreateAndUpdateMoodysAction': 'DENY'|'ALLOW',
'ShareMoodysAction': 'DENY'|'ALLOW',
'UseMoodysAction': 'DENY'|'ALLOW',
'BeeAction': 'DENY'|'ALLOW',
'CreateAndUpdateBeeAction': 'DENY'|'ALLOW',
'ShareBeeAction': 'DENY'|'ALLOW',
'UseBeeAction': 'DENY'|'ALLOW',
'GongAction': 'DENY'|'ALLOW',
'CreateAndUpdateGongAction': 'DENY'|'ALLOW',
'ShareGongAction': 'DENY'|'ALLOW',
'UseGongAction': 'DENY'|'ALLOW',
'Topic': 'DENY'|'ALLOW',
'EditVisualWithQ': 'DENY'|'ALLOW',
'BuildCalculatedFieldWithQ': 'DENY'|'ALLOW',
'CreateDashboardExecutiveSummaryWithQ': 'DENY'|'ALLOW',
'Space': 'DENY'|'ALLOW',
'CreateSpaces': 'DENY'|'ALLOW',
'ShareSpaces': 'DENY'|'ALLOW',
'ChatAgent': 'DENY'|'ALLOW',
'CreateChatAgents': 'DENY'|'ALLOW',
'ShareChatAgents': 'DENY'|'ALLOW',
'Research': 'DENY'|'ALLOW',
'SelfUpgradeUserRole': 'DENY'|'ALLOW',
'Extension': 'DENY'|'ALLOW',
'UseBrowserExtension': 'DENY'|'ALLOW',
'UseWordAddInExtension': 'DENY'|'ALLOW',
'UseOutlookAddInExtension': 'DENY'|'ALLOW',
'UseExcelAddInExtension': 'DENY'|'ALLOW',
'UsePowerpointAddInExtension': 'DENY'|'ALLOW',
'ManageSharedFolders': 'DENY'|'ALLOW',
'GenerateAnalyses': 'DENY'|'ALLOW',
'Story': 'DENY'|'ALLOW',
'Scenario': 'DENY'|'ALLOW',
'Trigger': 'DENY'|'ALLOW',
'ScheduleTrigger': 'DENY'|'ALLOW',
'InboundEmailTrigger': 'DENY'|'ALLOW',
'QuickEventTrigger': 'DENY'|'ALLOW',
'FileDataSource': 'DENY'|'ALLOW',
'CreateFileDataSource': 'DENY'|'ALLOW',
'UpdateFileDataSource': 'DENY'|'ALLOW',
'ShareFileDataSource': 'DENY'|'ALLOW',
'S3DataSource': 'DENY'|'ALLOW',
'CreateS3DataSource': 'DENY'|'ALLOW',
'UpdateS3DataSource': 'DENY'|'ALLOW',
'ShareS3DataSource': 'DENY'|'ALLOW',
'S3AnalyticsDataSource': 'DENY'|'ALLOW',
'CreateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'ShareS3AnalyticsDataSource': 'DENY'|'ALLOW',
'S3TablesDataSource': 'DENY'|'ALLOW',
'CreateS3TablesDataSource': 'DENY'|'ALLOW',
'UpdateS3TablesDataSource': 'DENY'|'ALLOW',
'ShareS3TablesDataSource': 'DENY'|'ALLOW',
'AthenaDataSource': 'DENY'|'ALLOW',
'CreateAthenaDataSource': 'DENY'|'ALLOW',
'UpdateAthenaDataSource': 'DENY'|'ALLOW',
'ShareAthenaDataSource': 'DENY'|'ALLOW',
'RdsDataSource': 'DENY'|'ALLOW',
'CreateRdsDataSource': 'DENY'|'ALLOW',
'UpdateRdsDataSource': 'DENY'|'ALLOW',
'ShareRdsDataSource': 'DENY'|'ALLOW',
'RedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'CreateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'ShareRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'RedshiftManualDataSource': 'DENY'|'ALLOW',
'CreateRedshiftManualDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftManualDataSource': 'DENY'|'ALLOW',
'ShareRedshiftManualDataSource': 'DENY'|'ALLOW',
'OpenSearchDataSource': 'DENY'|'ALLOW',
'CreateOpenSearchDataSource': 'DENY'|'ALLOW',
'UpdateOpenSearchDataSource': 'DENY'|'ALLOW',
'ShareOpenSearchDataSource': 'DENY'|'ALLOW',
'TimestreamDataSource': 'DENY'|'ALLOW',
'CreateTimestreamDataSource': 'DENY'|'ALLOW',
'UpdateTimestreamDataSource': 'DENY'|'ALLOW',
'ShareTimestreamDataSource': 'DENY'|'ALLOW',
'AuroraDataSource': 'DENY'|'ALLOW',
'CreateAuroraDataSource': 'DENY'|'ALLOW',
'UpdateAuroraDataSource': 'DENY'|'ALLOW',
'ShareAuroraDataSource': 'DENY'|'ALLOW',
'MySqlDataSource': 'DENY'|'ALLOW',
'CreateMySqlDataSource': 'DENY'|'ALLOW',
'UpdateMySqlDataSource': 'DENY'|'ALLOW',
'ShareMySqlDataSource': 'DENY'|'ALLOW',
'PostgreSqlDataSource': 'DENY'|'ALLOW',
'CreatePostgreSqlDataSource': 'DENY'|'ALLOW',
'UpdatePostgreSqlDataSource': 'DENY'|'ALLOW',
'SharePostgreSqlDataSource': 'DENY'|'ALLOW',
'OracleDataSource': 'DENY'|'ALLOW',
'CreateOracleDataSource': 'DENY'|'ALLOW',
'UpdateOracleDataSource': 'DENY'|'ALLOW',
'ShareOracleDataSource': 'DENY'|'ALLOW',
'SqlServerDataSource': 'DENY'|'ALLOW',
'CreateSqlServerDataSource': 'DENY'|'ALLOW',
'UpdateSqlServerDataSource': 'DENY'|'ALLOW',
'ShareSqlServerDataSource': 'DENY'|'ALLOW',
'MariaDbDataSource': 'DENY'|'ALLOW',
'CreateMariaDbDataSource': 'DENY'|'ALLOW',
'UpdateMariaDbDataSource': 'DENY'|'ALLOW',
'ShareMariaDbDataSource': 'DENY'|'ALLOW',
'SnowflakeDataSource': 'DENY'|'ALLOW',
'CreateSnowflakeDataSource': 'DENY'|'ALLOW',
'UpdateSnowflakeDataSource': 'DENY'|'ALLOW',
'ShareSnowflakeDataSource': 'DENY'|'ALLOW',
'GoogleBigQueryDataSource': 'DENY'|'ALLOW',
'CreateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'UpdateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'ShareGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'DatabricksDataSource': 'DENY'|'ALLOW',
'CreateDatabricksDataSource': 'DENY'|'ALLOW',
'UpdateDatabricksDataSource': 'DENY'|'ALLOW',
'ShareDatabricksDataSource': 'DENY'|'ALLOW',
'StarburstDataSource': 'DENY'|'ALLOW',
'CreateStarburstDataSource': 'DENY'|'ALLOW',
'UpdateStarburstDataSource': 'DENY'|'ALLOW',
'ShareStarburstDataSource': 'DENY'|'ALLOW',
'TrinoDataSource': 'DENY'|'ALLOW',
'CreateTrinoDataSource': 'DENY'|'ALLOW',
'UpdateTrinoDataSource': 'DENY'|'ALLOW',
'ShareTrinoDataSource': 'DENY'|'ALLOW',
'ImpalaDataSource': 'DENY'|'ALLOW',
'CreateImpalaDataSource': 'DENY'|'ALLOW',
'UpdateImpalaDataSource': 'DENY'|'ALLOW',
'ShareImpalaDataSource': 'DENY'|'ALLOW',
'TeradataDataSource': 'DENY'|'ALLOW',
'CreateTeradataDataSource': 'DENY'|'ALLOW',
'UpdateTeradataDataSource': 'DENY'|'ALLOW',
'ShareTeradataDataSource': 'DENY'|'ALLOW',
'PrestoDataSource': 'DENY'|'ALLOW',
'CreatePrestoDataSource': 'DENY'|'ALLOW',
'UpdatePrestoDataSource': 'DENY'|'ALLOW',
'SharePrestoDataSource': 'DENY'|'ALLOW',
'SparkDataSource': 'DENY'|'ALLOW',
'CreateSparkDataSource': 'DENY'|'ALLOW',
'UpdateSparkDataSource': 'DENY'|'ALLOW',
'ShareSparkDataSource': 'DENY'|'ALLOW',
'ExasolDataSource': 'DENY'|'ALLOW',
'CreateExasolDataSource': 'DENY'|'ALLOW',
'UpdateExasolDataSource': 'DENY'|'ALLOW',
'ShareExasolDataSource': 'DENY'|'ALLOW',
'Db2DataSource': 'DENY'|'ALLOW',
'CreateDb2DataSource': 'DENY'|'ALLOW',
'UpdateDb2DataSource': 'DENY'|'ALLOW',
'ShareDb2DataSource': 'DENY'|'ALLOW',
'SapHanaDataSource': 'DENY'|'ALLOW',
'CreateSapHanaDataSource': 'DENY'|'ALLOW',
'UpdateSapHanaDataSource': 'DENY'|'ALLOW',
'ShareSapHanaDataSource': 'DENY'|'ALLOW',
'DenodoDataSource': 'DENY'|'ALLOW',
'CreateDenodoDataSource': 'DENY'|'ALLOW',
'UpdateDenodoDataSource': 'DENY'|'ALLOW',
'ShareDenodoDataSource': 'DENY'|'ALLOW',
'DremioDataSource': 'DENY'|'ALLOW',
'CreateDremioDataSource': 'DENY'|'ALLOW',
'UpdateDremioDataSource': 'DENY'|'ALLOW',
'ShareDremioDataSource': 'DENY'|'ALLOW',
'SalesforceDataSource': 'DENY'|'ALLOW',
'CreateSalesforceDataSource': 'DENY'|'ALLOW',
'UpdateSalesforceDataSource': 'DENY'|'ALLOW',
'ShareSalesforceDataSource': 'DENY'|'ALLOW',
'RadiantDataSource': 'DENY'|'ALLOW',
'CreateRadiantDataSource': 'DENY'|'ALLOW',
'UpdateRadiantDataSource': 'DENY'|'ALLOW',
'ShareRadiantDataSource': 'DENY'|'ALLOW',
'PayPalDataSource': 'DENY'|'ALLOW',
'CreatePayPalDataSource': 'DENY'|'ALLOW',
'UpdatePayPalDataSource': 'DENY'|'ALLOW',
'SharePayPalDataSource': 'DENY'|'ALLOW',
'SquareDataSource': 'DENY'|'ALLOW',
'CreateSquareDataSource': 'DENY'|'ALLOW',
'UpdateSquareDataSource': 'DENY'|'ALLOW',
'ShareSquareDataSource': 'DENY'|'ALLOW',
'GitHubDataSource': 'DENY'|'ALLOW',
'CreateGitHubDataSource': 'DENY'|'ALLOW',
'UpdateGitHubDataSource': 'DENY'|'ALLOW',
'ShareGitHubDataSource': 'DENY'|'ALLOW',
'TwitterDataSource': 'DENY'|'ALLOW',
'CreateTwitterDataSource': 'DENY'|'ALLOW',
'UpdateTwitterDataSource': 'DENY'|'ALLOW',
'ShareTwitterDataSource': 'DENY'|'ALLOW',
'JiraDataSource': 'DENY'|'ALLOW',
'CreateJiraDataSource': 'DENY'|'ALLOW',
'UpdateJiraDataSource': 'DENY'|'ALLOW',
'ShareJiraDataSource': 'DENY'|'ALLOW',
'ServiceNowDataSource': 'DENY'|'ALLOW',
'CreateServiceNowDataSource': 'DENY'|'ALLOW',
'UpdateServiceNowDataSource': 'DENY'|'ALLOW',
'ShareServiceNowDataSource': 'DENY'|'ALLOW',
'AdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleSheetsDataSource': 'DENY'|'ALLOW',
'CreateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'ShareGoogleSheetsDataSource': 'DENY'|'ALLOW',
'DocumentDbDataSource': 'DENY'|'ALLOW',
'CreateDocumentDbDataSource': 'DENY'|'ALLOW',
'UpdateDocumentDbDataSource': 'DENY'|'ALLOW',
'ShareDocumentDbDataSource': 'DENY'|'ALLOW',
'MongoDbDataSource': 'DENY'|'ALLOW',
'CreateMongoDbDataSource': 'DENY'|'ALLOW',
'UpdateMongoDbDataSource': 'DENY'|'ALLOW',
'ShareMongoDbDataSource': 'DENY'|'ALLOW',
'MongoAtlasDataSource': 'DENY'|'ALLOW',
'CreateMongoAtlasDataSource': 'DENY'|'ALLOW',
'UpdateMongoAtlasDataSource': 'DENY'|'ALLOW',
'ShareMongoAtlasDataSource': 'DENY'|'ALLOW',
'DynamoDbDataSource': 'DENY'|'ALLOW',
'CreateDynamoDbDataSource': 'DENY'|'ALLOW',
'UpdateDynamoDbDataSource': 'DENY'|'ALLOW',
'ShareDynamoDbDataSource': 'DENY'|'ALLOW'
},
'Governance': {
'DefaultCategoryEffects': {
'string': 'DENY_BY_DEFAULT'
}
}
},
'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.
Apps (string) --
The ability to perform apps-related actions.
CreateAndUpdateApps (string) --
The ability to create or update apps.
ShareApps (string) --
The ability to share apps with other users.
InvokeAppsAIInference (string) --
The ability to add and invoke AI inference in new and existing apps.
AccessAppsNativeDataStore (string) --
The ability to access the native data store for new and existing apps.
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.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
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.
CreateAndUpdateKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
SharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
GoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
WebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
S3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
OneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
QBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
IDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
LocalMCPAction (string) --
The ability to create, update, and use local Model Context Protocol (MCP) actions. This capability includes CreateAndUpdateLocalMCPAction and UseLocalMCPAction.
CreateAndUpdateLocalMCPAction (string) --
The ability to create and update local Model Context Protocol (MCP) server configurations. Denying this capability does not by itself deny use of previously configured local MCP servers.
UseLocalMCPAction (string) --
The ability to start local Model Context Protocol (MCP) servers and use their actions, including actions from previously configured local MCP servers.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
PagerDutyAgentAction (string) --
The ability to perform actions using PagerDuty Agent connectors.
CreateAndUpdatePagerDutyAgentAction (string) --
The ability to create and update PagerDuty Agent actions.
SharePagerDutyAgentAction (string) --
The ability to share PagerDuty Agent actions.
UsePagerDutyAgentAction (string) --
The ability to use PagerDuty Agent actions.
VisierAgentAction (string) --
The ability to perform actions using Visier Agent connectors.
CreateAndUpdateVisierAgentAction (string) --
The ability to create and update Visier Agent actions.
ShareVisierAgentAction (string) --
The ability to share Visier Agent actions.
UseVisierAgentAction (string) --
The ability to use Visier Agent actions.
ZoomAction (string) --
The ability to perform actions using Zoom connectors.
CreateAndUpdateZoomAction (string) --
The ability to create and update Zoom actions.
ShareZoomAction (string) --
The ability to share Zoom actions.
UseZoomAction (string) --
The ability to use Zoom actions.
SnowFlakeAction (string) --
The ability to perform actions using Snowflake Cortex Agent connectors.
CreateAndUpdateSnowFlakeAction (string) --
The ability to create and update Snowflake Cortex Agent actions.
ShareSnowFlakeAction (string) --
The ability to share Snowflake Cortex Agent actions.
UseSnowFlakeAction (string) --
The ability to use Snowflake Cortex Agent actions.
ZapierAction (string) --
The ability to perform actions using Zapier Agent connectors.
CreateAndUpdateZapierAction (string) --
The ability to create and update Zapier Agent actions.
ShareZapierAction (string) --
The ability to share Zapier Agent actions.
UseZapierAction (string) --
The ability to use Zapier Agent actions.
AirtableAction (string) --
The ability to perform actions using Airtable connectors.
CreateAndUpdateAirtableAction (string) --
The ability to create and update Airtable actions.
ShareAirtableAction (string) --
The ability to share Airtable actions.
UseAirtableAction (string) --
The ability to use Airtable actions.
DropboxAction (string) --
The ability to perform actions using Dropbox connectors.
CreateAndUpdateDropboxAction (string) --
The ability to create and update Dropbox actions.
ShareDropboxAction (string) --
The ability to share Dropbox actions.
UseDropboxAction (string) --
The ability to use Dropbox actions.
GmailAction (string) --
The ability to perform actions using Gmail connectors.
CreateAndUpdateGmailAction (string) --
The ability to create and update Gmail actions.
ShareGmailAction (string) --
The ability to share Gmail actions.
UseGmailAction (string) --
The ability to use Gmail actions.
GoogleAnalyticsAction (string) --
The ability to perform actions using Google Analytics connectors.
CreateAndUpdateGoogleAnalyticsAction (string) --
The ability to create and update Google Analytics actions.
ShareGoogleAnalyticsAction (string) --
The ability to share Google Analytics actions.
UseGoogleAnalyticsAction (string) --
The ability to use Google Analytics actions.
GoogleDocsAction (string) --
The ability to perform actions using Google Docs connectors.
CreateAndUpdateGoogleDocsAction (string) --
The ability to create and update Google Docs actions.
ShareGoogleDocsAction (string) --
The ability to share Google Docs actions.
UseGoogleDocsAction (string) --
The ability to use Google Docs actions.
GoogleDriveAction (string) --
The ability to perform actions using Google Drive connectors.
CreateAndUpdateGoogleDriveAction (string) --
The ability to create and update Google Drive actions.
ShareGoogleDriveAction (string) --
The ability to share Google Drive actions.
UseGoogleDriveAction (string) --
The ability to use Google Drive actions.
GoogleMeetAction (string) --
The ability to perform actions using Google Meet connectors.
CreateAndUpdateGoogleMeetAction (string) --
The ability to create and update Google Meet actions.
ShareGoogleMeetAction (string) --
The ability to share Google Meet actions.
UseGoogleMeetAction (string) --
The ability to use Google Meet actions.
GoogleSheetsAction (string) --
The ability to perform actions using Google Sheets connectors.
CreateAndUpdateGoogleSheetsAction (string) --
The ability to create and update Google Sheets actions.
ShareGoogleSheetsAction (string) --
The ability to share Google Sheets actions.
UseGoogleSheetsAction (string) --
The ability to use Google Sheets actions.
GoogleSlidesAction (string) --
The ability to perform actions using Google Slides connectors.
CreateAndUpdateGoogleSlidesAction (string) --
The ability to create and update Google Slides actions.
ShareGoogleSlidesAction (string) --
The ability to share Google Slides actions.
UseGoogleSlidesAction (string) --
The ability to use Google Slides actions.
QuickBooksAction (string) --
The ability to perform actions using QuickBooks connectors.
CreateAndUpdateQuickBooksAction (string) --
The ability to create and update QuickBooks actions.
ShareQuickBooksAction (string) --
The ability to share QuickBooks actions.
UseQuickBooksAction (string) --
The ability to use QuickBooks actions.
FigmaAction (string) --
The ability to perform actions using Figma connectors.
CreateAndUpdateFigmaAction (string) --
The ability to create and update Figma actions.
ShareFigmaAction (string) --
The ability to share Figma actions.
UseFigmaAction (string) --
The ability to use Figma actions.
WhatsAppAction (string) --
The ability to perform actions using WhatsApp connectors.
CreateAndUpdateWhatsAppAction (string) --
The ability to create and update WhatsApp actions.
ShareWhatsAppAction (string) --
The ability to share WhatsApp actions.
UseWhatsAppAction (string) --
The ability to use WhatsApp actions.
GoogleChatAction (string) --
The ability to perform actions using Google Chat connectors.
CreateAndUpdateGoogleChatAction (string) --
The ability to create and update Google Chat actions.
ShareGoogleChatAction (string) --
The ability to share Google Chat actions.
UseGoogleChatAction (string) --
The ability to use Google Chat actions.
OneNoteAction (string) --
The ability to perform actions using Microsoft OneNote connectors.
CreateAndUpdateOneNoteAction (string) --
The ability to create and update Microsoft OneNote actions.
ShareOneNoteAction (string) --
The ability to share Microsoft OneNote actions.
UseOneNoteAction (string) --
The ability to use Microsoft OneNote actions.
ShopifyAction (string) --
The ability to perform actions using Shopify connectors.
CreateAndUpdateShopifyAction (string) --
The ability to create and update Shopify actions.
ShareShopifyAction (string) --
The ability to share Shopify actions.
UseShopifyAction (string) --
The ability to use Shopify actions.
AdobeAction (string) --
The ability to perform actions using Adobe Marketing Agent connectors.
CreateAndUpdateAdobeAction (string) --
The ability to create and update Adobe Marketing Agent actions.
ShareAdobeAction (string) --
The ability to share Adobe Marketing Agent actions.
UseAdobeAction (string) --
The ability to use Adobe Marketing Agent actions.
CiscoWebexVidcastAction (string) --
The ability to perform actions using Cisco Webex Video Messaging Agent connectors.
CreateAndUpdateCiscoWebexVidcastAction (string) --
The ability to create and update Cisco Webex Video Messaging Agent actions.
ShareCiscoWebexVidcastAction (string) --
The ability to share Cisco Webex Video Messaging Agent actions.
UseCiscoWebexVidcastAction (string) --
The ability to use Cisco Webex Video Messaging Agent actions.
CiscoWebexMeetingsAction (string) --
The ability to perform actions using Cisco Webex Meetings connectors.
CreateAndUpdateCiscoWebexMeetingsAction (string) --
The ability to create and update Cisco Webex Meetings actions.
ShareCiscoWebexMeetingsAction (string) --
The ability to share Cisco Webex Meetings actions.
UseCiscoWebexMeetingsAction (string) --
The ability to use Cisco Webex Meetings actions.
DunAndBradstreetAction (string) --
The ability to perform actions using Dun and Bradstreet connectors.
CreateAndUpdateDunAndBradstreetAction (string) --
The ability to create and update Dun and Bradstreet actions.
ShareDunAndBradstreetAction (string) --
The ability to share Dun and Bradstreet actions.
UseDunAndBradstreetAction (string) --
The ability to use Dun and Bradstreet actions.
HGInsightsAction (string) --
The ability to perform actions using HG Insights Agent connectors.
CreateAndUpdateHGInsightsAction (string) --
The ability to create and update HG Insights Agent actions.
ShareHGInsightsAction (string) --
The ability to share HG Insights Agent actions.
UseHGInsightsAction (string) --
The ability to use HG Insights Agent actions.
ZoomInfoAction (string) --
The ability to perform actions using ZoomInfo Agent connectors.
CreateAndUpdateZoomInfoAction (string) --
The ability to create and update ZoomInfo Agent actions.
ShareZoomInfoAction (string) --
The ability to share ZoomInfo Agent actions.
UseZoomInfoAction (string) --
The ability to use ZoomInfo Agent actions.
MoodysAction (string) --
The ability to perform actions using Moody's GenAI Ready Data connectors.
CreateAndUpdateMoodysAction (string) --
The ability to create and update Moody's GenAI Ready Data actions.
ShareMoodysAction (string) --
The ability to share Moody's GenAI Ready Data actions.
UseMoodysAction (string) --
The ability to use Moody's GenAI Ready Data actions.
BeeAction (string) --
The ability to perform actions using Bee connectors.
CreateAndUpdateBeeAction (string) --
The ability to create and update Bee actions.
ShareBeeAction (string) --
The ability to share Bee actions.
UseBeeAction (string) --
The ability to use Bee actions.
GongAction (string) --
The ability to perform actions using Gong connectors.
CreateAndUpdateGongAction (string) --
The ability to create and update Gong actions.
ShareGongAction (string) --
The ability to share Gong actions.
UseGongAction (string) --
The ability to use Gong actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
UseBrowserExtension (string) --
The ability to use Amazon Quick through the browser extension for Chrome, Firefox, and Edge.
UseWordAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Word add-in.
UseOutlookAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Outlook add-in.
UseExcelAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Excel add-in.
UsePowerpointAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft PowerPoint add-in.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
Story (string) --
The ability to perform Story-related actions.
Scenario (string) --
The ability to perform Scenario-related actions.
Trigger (string) --
The ability to manage trigger-related settings for flows and automations.
ScheduleTrigger (string) --
The ability to create, view, edit, delete, and run schedule triggers for flows and automations.
InboundEmailTrigger (string) --
The ability to create, view, edit, delete, and run inbound email triggers for flows and automations.
QuickEventTrigger (string) --
The ability to create, view, edit, delete, and run Quick event triggers for flows and automations.
FileDataSource (string) --
The ability to create, update, and share file data sources.
CreateFileDataSource (string) --
The ability to create file data sources.
UpdateFileDataSource (string) --
The ability to update file data sources.
ShareFileDataSource (string) --
The ability to share file data sources.
S3DataSource (string) --
The ability to create, update, and share Amazon S3 data sources.
CreateS3DataSource (string) --
The ability to create Amazon S3 data sources.
UpdateS3DataSource (string) --
The ability to update Amazon S3 data sources.
ShareS3DataSource (string) --
The ability to share Amazon S3 data sources.
S3AnalyticsDataSource (string) --
The ability to create, update, and share Amazon S3 Analytics data sources.
CreateS3AnalyticsDataSource (string) --
The ability to create Amazon S3 Analytics data sources.
UpdateS3AnalyticsDataSource (string) --
The ability to update Amazon S3 Analytics data sources.
ShareS3AnalyticsDataSource (string) --
The ability to share Amazon S3 Analytics data sources.
S3TablesDataSource (string) --
The ability to create, update, and share Amazon S3 Tables data sources.
CreateS3TablesDataSource (string) --
The ability to create Amazon S3 Tables data sources.
UpdateS3TablesDataSource (string) --
The ability to update Amazon S3 Tables data sources.
ShareS3TablesDataSource (string) --
The ability to share Amazon S3 Tables data sources.
AthenaDataSource (string) --
The ability to create, update, and share Amazon Athena data sources.
CreateAthenaDataSource (string) --
The ability to create Amazon Athena data sources.
UpdateAthenaDataSource (string) --
The ability to update Amazon Athena data sources.
ShareAthenaDataSource (string) --
The ability to share Amazon Athena data sources.
RdsDataSource (string) --
The ability to create, update, and share auto-discovered Amazon RDS data sources.
CreateRdsDataSource (string) --
The ability to create auto-discovered Amazon RDS data sources.
UpdateRdsDataSource (string) --
The ability to update auto-discovered Amazon RDS data sources.
ShareRdsDataSource (string) --
The ability to share auto-discovered Amazon RDS data sources.
RedshiftAutoDiscoveredDataSource (string) --
The ability to create, update, and share auto-discovered Amazon Redshift data sources.
CreateRedshiftAutoDiscoveredDataSource (string) --
The ability to create auto-discovered Amazon Redshift data sources.
UpdateRedshiftAutoDiscoveredDataSource (string) --
The ability to update auto-discovered Amazon Redshift data sources.
ShareRedshiftAutoDiscoveredDataSource (string) --
The ability to share auto-discovered Amazon Redshift data sources.
RedshiftManualDataSource (string) --
The ability to create, update, and share manually configured Amazon Redshift data sources.
CreateRedshiftManualDataSource (string) --
The ability to create manually configured Amazon Redshift data sources.
UpdateRedshiftManualDataSource (string) --
The ability to update manually configured Amazon Redshift data sources.
ShareRedshiftManualDataSource (string) --
The ability to share manually configured Amazon Redshift data sources.
OpenSearchDataSource (string) --
The ability to create, update, and share Amazon OpenSearch Service data sources.
CreateOpenSearchDataSource (string) --
The ability to create Amazon OpenSearch Service data sources.
UpdateOpenSearchDataSource (string) --
The ability to update Amazon OpenSearch Service data sources.
ShareOpenSearchDataSource (string) --
The ability to share Amazon OpenSearch Service data sources.
TimestreamDataSource (string) --
The ability to create, update, and share Amazon Timestream data sources.
CreateTimestreamDataSource (string) --
The ability to create Amazon Timestream data sources.
UpdateTimestreamDataSource (string) --
The ability to update Amazon Timestream data sources.
ShareTimestreamDataSource (string) --
The ability to share Amazon Timestream data sources.
AuroraDataSource (string) --
The ability to create, update, and share Amazon Aurora data sources.
CreateAuroraDataSource (string) --
The ability to create Amazon Aurora data sources.
UpdateAuroraDataSource (string) --
The ability to update Amazon Aurora data sources.
ShareAuroraDataSource (string) --
The ability to share Amazon Aurora data sources.
MySqlDataSource (string) --
The ability to create, update, and share MySQL data sources.
CreateMySqlDataSource (string) --
The ability to create MySQL data sources.
UpdateMySqlDataSource (string) --
The ability to update MySQL data sources.
ShareMySqlDataSource (string) --
The ability to share MySQL data sources.
PostgreSqlDataSource (string) --
The ability to create, update, and share PostgreSQL data sources.
CreatePostgreSqlDataSource (string) --
The ability to create PostgreSQL data sources.
UpdatePostgreSqlDataSource (string) --
The ability to update PostgreSQL data sources.
SharePostgreSqlDataSource (string) --
The ability to share PostgreSQL data sources.
OracleDataSource (string) --
The ability to create, update, and share Oracle data sources.
CreateOracleDataSource (string) --
The ability to create Oracle data sources.
UpdateOracleDataSource (string) --
The ability to update Oracle data sources.
ShareOracleDataSource (string) --
The ability to share Oracle data sources.
SqlServerDataSource (string) --
The ability to create, update, and share SQL Server data sources.
CreateSqlServerDataSource (string) --
The ability to create SQL Server data sources.
UpdateSqlServerDataSource (string) --
The ability to update SQL Server data sources.
ShareSqlServerDataSource (string) --
The ability to share SQL Server data sources.
MariaDbDataSource (string) --
The ability to create, update, and share MariaDB data sources.
CreateMariaDbDataSource (string) --
The ability to create MariaDB data sources.
UpdateMariaDbDataSource (string) --
The ability to update MariaDB data sources.
ShareMariaDbDataSource (string) --
The ability to share MariaDB data sources.
SnowflakeDataSource (string) --
The ability to create, update, and share Snowflake data sources.
CreateSnowflakeDataSource (string) --
The ability to create Snowflake data sources.
UpdateSnowflakeDataSource (string) --
The ability to update Snowflake data sources.
ShareSnowflakeDataSource (string) --
The ability to share Snowflake data sources.
GoogleBigQueryDataSource (string) --
The ability to create, update, and share Google BigQuery data sources.
CreateGoogleBigQueryDataSource (string) --
The ability to create Google BigQuery data sources.
UpdateGoogleBigQueryDataSource (string) --
The ability to update Google BigQuery data sources.
ShareGoogleBigQueryDataSource (string) --
The ability to share Google BigQuery data sources.
DatabricksDataSource (string) --
The ability to create, update, and share Databricks data sources.
CreateDatabricksDataSource (string) --
The ability to create Databricks data sources.
UpdateDatabricksDataSource (string) --
The ability to update Databricks data sources.
ShareDatabricksDataSource (string) --
The ability to share Databricks data sources.
StarburstDataSource (string) --
The ability to create, update, and share Starburst data sources.
CreateStarburstDataSource (string) --
The ability to create Starburst data sources.
UpdateStarburstDataSource (string) --
The ability to update Starburst data sources.
ShareStarburstDataSource (string) --
The ability to share Starburst data sources.
TrinoDataSource (string) --
The ability to create, update, and share Trino data sources.
CreateTrinoDataSource (string) --
The ability to create Trino data sources.
UpdateTrinoDataSource (string) --
The ability to update Trino data sources.
ShareTrinoDataSource (string) --
The ability to share Trino data sources.
ImpalaDataSource (string) --
The ability to create, update, and share Impala data sources.
CreateImpalaDataSource (string) --
The ability to create Impala data sources.
UpdateImpalaDataSource (string) --
The ability to update Impala data sources.
ShareImpalaDataSource (string) --
The ability to share Impala data sources.
TeradataDataSource (string) --
The ability to create, update, and share Teradata data sources.
CreateTeradataDataSource (string) --
The ability to create Teradata data sources.
UpdateTeradataDataSource (string) --
The ability to update Teradata data sources.
ShareTeradataDataSource (string) --
The ability to share Teradata data sources.
PrestoDataSource (string) --
The ability to create, update, and share Presto data sources.
CreatePrestoDataSource (string) --
The ability to create Presto data sources.
UpdatePrestoDataSource (string) --
The ability to update Presto data sources.
SharePrestoDataSource (string) --
The ability to share Presto data sources.
SparkDataSource (string) --
The ability to create, update, and share Spark data sources.
CreateSparkDataSource (string) --
The ability to create Spark data sources.
UpdateSparkDataSource (string) --
The ability to update Spark data sources.
ShareSparkDataSource (string) --
The ability to share Spark data sources.
ExasolDataSource (string) --
The ability to create, update, and share Exasol data sources.
CreateExasolDataSource (string) --
The ability to create Exasol data sources.
UpdateExasolDataSource (string) --
The ability to update Exasol data sources.
ShareExasolDataSource (string) --
The ability to share Exasol data sources.
Db2DataSource (string) --
The ability to create, update, and share Db2 data sources.
CreateDb2DataSource (string) --
The ability to create Db2 data sources.
UpdateDb2DataSource (string) --
The ability to update Db2 data sources.
ShareDb2DataSource (string) --
The ability to share Db2 data sources.
SapHanaDataSource (string) --
The ability to create, update, and share SAP HANA data sources.
CreateSapHanaDataSource (string) --
The ability to create SAP HANA data sources.
UpdateSapHanaDataSource (string) --
The ability to update SAP HANA data sources.
ShareSapHanaDataSource (string) --
The ability to share SAP HANA data sources.
DenodoDataSource (string) --
The ability to create, update, and share Denodo data sources.
CreateDenodoDataSource (string) --
The ability to create Denodo data sources.
UpdateDenodoDataSource (string) --
The ability to update Denodo data sources.
ShareDenodoDataSource (string) --
The ability to share Denodo data sources.
DremioDataSource (string) --
The ability to create, update, and share Dremio data sources.
CreateDremioDataSource (string) --
The ability to create Dremio data sources.
UpdateDremioDataSource (string) --
The ability to update Dremio data sources.
ShareDremioDataSource (string) --
The ability to share Dremio data sources.
SalesforceDataSource (string) --
The ability to create, update, and share Salesforce data sources.
CreateSalesforceDataSource (string) --
The ability to create Salesforce data sources.
UpdateSalesforceDataSource (string) --
The ability to update Salesforce data sources.
ShareSalesforceDataSource (string) --
The ability to share Salesforce data sources.
RadiantDataSource (string) --
The ability to create, update, and share Amazon QuickSight data sources.
CreateRadiantDataSource (string) --
The ability to create Amazon QuickSight data sources.
UpdateRadiantDataSource (string) --
The ability to update Amazon QuickSight data sources.
ShareRadiantDataSource (string) --
The ability to share Amazon QuickSight data sources.
PayPalDataSource (string) --
The ability to create, update, and share PayPal data sources.
CreatePayPalDataSource (string) --
The ability to create PayPal data sources.
UpdatePayPalDataSource (string) --
The ability to update PayPal data sources.
SharePayPalDataSource (string) --
The ability to share PayPal data sources.
SquareDataSource (string) --
The ability to create, update, and share Square data sources.
CreateSquareDataSource (string) --
The ability to create Square data sources.
UpdateSquareDataSource (string) --
The ability to update Square data sources.
ShareSquareDataSource (string) --
The ability to share Square data sources.
GitHubDataSource (string) --
The ability to create, update, and share GitHub data sources.
CreateGitHubDataSource (string) --
The ability to create GitHub data sources.
UpdateGitHubDataSource (string) --
The ability to update GitHub data sources.
ShareGitHubDataSource (string) --
The ability to share GitHub data sources.
TwitterDataSource (string) --
The ability to create, update, and share Twitter data sources.
CreateTwitterDataSource (string) --
The ability to create Twitter data sources.
UpdateTwitterDataSource (string) --
The ability to update Twitter data sources.
ShareTwitterDataSource (string) --
The ability to share Twitter data sources.
JiraDataSource (string) --
The ability to create, update, and share Jira data sources.
CreateJiraDataSource (string) --
The ability to create Jira data sources.
UpdateJiraDataSource (string) --
The ability to update Jira data sources.
ShareJiraDataSource (string) --
The ability to share Jira data sources.
ServiceNowDataSource (string) --
The ability to create, update, and share ServiceNow data sources.
CreateServiceNowDataSource (string) --
The ability to create ServiceNow data sources.
UpdateServiceNowDataSource (string) --
The ability to update ServiceNow data sources.
ShareServiceNowDataSource (string) --
The ability to share ServiceNow data sources.
AdobeAnalyticsDataSource (string) --
The ability to create, update, and share Adobe Analytics data sources.
CreateAdobeAnalyticsDataSource (string) --
The ability to create Adobe Analytics data sources.
UpdateAdobeAnalyticsDataSource (string) --
The ability to update Adobe Analytics data sources.
ShareAdobeAnalyticsDataSource (string) --
The ability to share Adobe Analytics data sources.
GoogleAnalyticsDataSource (string) --
The ability to create, update, and share Google Analytics data sources.
CreateGoogleAnalyticsDataSource (string) --
The ability to create Google Analytics data sources.
UpdateGoogleAnalyticsDataSource (string) --
The ability to update Google Analytics data sources.
ShareGoogleAnalyticsDataSource (string) --
The ability to share Google Analytics data sources.
GoogleSheetsDataSource (string) --
The ability to create, update, and share Google Sheets data sources.
CreateGoogleSheetsDataSource (string) --
The ability to create Google Sheets data sources.
UpdateGoogleSheetsDataSource (string) --
The ability to update Google Sheets data sources.
ShareGoogleSheetsDataSource (string) --
The ability to share Google Sheets data sources.
DocumentDbDataSource (string) --
The ability to create, update, and share Amazon DocumentDB data sources.
CreateDocumentDbDataSource (string) --
The ability to create Amazon DocumentDB data sources.
UpdateDocumentDbDataSource (string) --
The ability to update Amazon DocumentDB data sources.
ShareDocumentDbDataSource (string) --
The ability to share Amazon DocumentDB data sources.
MongoDbDataSource (string) --
The ability to create, update, and share MongoDB data sources.
CreateMongoDbDataSource (string) --
The ability to create MongoDB data sources.
UpdateMongoDbDataSource (string) --
The ability to update MongoDB data sources.
ShareMongoDbDataSource (string) --
The ability to share MongoDB data sources.
MongoAtlasDataSource (string) --
The ability to create, update, and share MongoDB Atlas data sources.
CreateMongoAtlasDataSource (string) --
The ability to create MongoDB Atlas data sources.
UpdateMongoAtlasDataSource (string) --
The ability to update MongoDB Atlas data sources.
ShareMongoAtlasDataSource (string) --
The ability to share MongoDB Atlas data sources.
DynamoDbDataSource (string) --
The ability to create, update, and share Amazon DynamoDB data sources.
CreateDynamoDbDataSource (string) --
The ability to create Amazon DynamoDB data sources.
UpdateDynamoDbDataSource (string) --
The ability to update Amazon DynamoDB data sources.
ShareDynamoDbDataSource (string) --
The ability to share Amazon DynamoDB data sources.
Governance (dict) --
The governance configuration for the custom permissions profile. When you enable governance for a category, Amazon Quick denies access to any current or new capability in that category unless you explicitly set that capability to ALLOW in Capabilities.
DefaultCategoryEffects (dict) --
A map of DefaultCategoryEffects.
(string) --
The name of a governance category. A governance category groups related capabilities so that you can apply a default effect to all capabilities in the category at once. Valid values:
AI – Capabilities related to Amazon Quick AI features.
(string) --
The default effect that Amazon Quick applies to capabilities in a governed category when you do not explicitly list those capabilities in Capabilities. Valid values:
DENY_BY_DEFAULT – Amazon Quick denies any capability access in the given category that the profile does not explicitly set to ALLOW.
RequestId (string) --
The Amazon Web Services request ID for this operation.
{'DataSet': {'UnmaterializedCalculatedColumns': [{'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'SubType': 'FLOAT | FIXED',
'Type': 'STRING | INTEGER | '
'DECIMAL | '
'DATETIME'}]}}
Describes a dataset.
See also: AWS API Documentation
Request Syntax
client.describe_data_set(
AwsAccountId='string',
DataSetId='string'
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID for the dataset that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
dict
Response Syntax
{
'DataSet': {
'Arn': 'string',
'DataSetId': 'string',
'Name': 'string',
'CreatedTime': datetime(2015, 1, 1),
'LastUpdatedTime': datetime(2015, 1, 1),
'PhysicalTableMap': {
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'SaaSTable': {
'DataSourceArn': 'string',
'TablePath': [
{
'Name': 'string',
'Id': 'string'
},
],
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'FileSource': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'SheetIndex': 123,
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'LogicalTableMap': {
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
'CreateColumnsOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
'OutputColumns': [
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
],
'ImportMode': 'SPICE'|'DIRECT_QUERY',
'ConsumedSpiceCapacityInBytes': 123,
'ColumnGroups': [
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
'FieldFolders': {
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
'RowLevelPermissionTagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'ColumnLevelPermissionRules': [
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
'DataSetUsageConfiguration': {
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
'DatasetParameters': [
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
'PerformanceConfiguration': {
'UniqueKeys': [
{
'ColumnNames': [
'string',
]
},
]
},
'UseAs': 'RLS_RULES',
'DataPrepConfiguration': {
'SourceTableMap': {
'string': {
'PhysicalTableId': 'string',
'DataSet': {
'DataSetArn': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'TransformStepMap': {
'string': {
'ImportTableStep': {
'Alias': 'string',
'Source': {
'SourceTableId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
}
},
'ProjectStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FiltersStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'FilterOperations': [
{
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
]
},
'CreateColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RenameColumnOperations': [
{
'ColumnName': 'string',
'NewColumnName': 'string'
},
]
},
'CastColumnTypesStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'CastColumnTypeOperations': [
{
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
]
},
'JoinStep': {
'Alias': 'string',
'LeftOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RightOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string',
'LeftOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
},
'RightOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
}
},
'AggregateStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'Aggregations': [
{
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
},
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
},
'PivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'ValueColumnConfiguration': {
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
}
},
'PivotConfiguration': {
'LabelColumnName': 'string',
'PivotedLabels': [
{
'LabelName': 'string',
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
}
},
'UnpivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ColumnsToUnpivot': [
{
'ColumnName': 'string',
'NewValue': 'string'
},
],
'UnpivotedLabelColumnName': 'string',
'UnpivotedLabelColumnId': 'string',
'UnpivotedValueColumnName': 'string',
'UnpivotedValueColumnId': 'string'
},
'AppendStep': {
'Alias': 'string',
'FirstSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'SecondSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'AppendedColumns': [
{
'ColumnName': 'string',
'NewColumnId': 'string'
},
]
}
}
},
'DestinationTableMap': {
'string': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string'
}
}
}
},
'SemanticModelConfiguration': {
'TableMap': {
'string': {
'Alias': 'string',
'DestinationTableId': 'string',
'RowLevelPermissionConfiguration': {
'TagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
}
},
'SemanticMetadata': {
'ColumnMetadata': [
{
'ColumnNames': [
'string',
],
'ColumnProperties': [
{
'Description': {
'Text': 'string'
},
'AdditionalNotes': {
'Text': 'string'
},
'SemanticType': {
'GeographicalRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
}
},
]
},
]
}
}
},
'SemanticMetadata': [
{
'Description': {
'Text': 'string'
},
'CustomInstructions': [
{
'InlineCustomInstruction': {
'InstructionText': 'string',
'UploadedDocumentMetadata': {
'Name': 'string'
}
}
},
]
},
]
},
'UnmaterializedCalculatedColumns': [
{
'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
DataSet (dict) --
Information on the dataset.
Arn (string) --
The Amazon Resource Name (ARN) of the resource.
DataSetId (string) --
The ID of the dataset. Limited to 96 characters.
Name (string) --
A display name for the dataset.
CreatedTime (datetime) --
The time that this dataset was created.
LastUpdatedTime (datetime) --
The last time that this dataset was updated.
PhysicalTableMap (dict) --
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) --
The name of the relational table.
InputColumns (list) --
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) --
The Amazon Resource Name (ARN) of the data source.
Name (string) --
A display name for the SQL query result.
SqlQuery (string) --
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for an S3 data source.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
InputColumns (list) --
A physical table type for an S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
SaaSTable (dict) --
A physical table type for Software-as-a-Service (SaaS) sources.
DataSourceArn (string) --
The Amazon Resource Name (ARN) of the SaaS data source.
TablePath (list) --
The hierarchical path to the table within the SaaS data source.
(dict) --
An element in the hierarchical path to a table within a data source, containing both name and identifier.
Name (string) --
The name of the path element.
Id (string) --
The unique identifier of the path element.
InputColumns (list) --
The list of input columns available from the SaaS table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
FileSource (dict) --
A physical table type for a file data source.
DataSourceArn (string) --
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the source file.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
SheetIndex (integer) --
The zero-based index of the sheet to use within the file. For files that contain multiple sheets, this identifies which sheet to read. Files that contain a single sheet, or that have no concept of sheets, use sheet 0.
InputColumns (list) --
The column schema of the file.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
LogicalTableMap (dict) --
Configures the combination and transformation of the data from the physical tables.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) --
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
ProjectedColumns (list) --
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) --
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) --
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) --
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) --
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
Columns (list) --
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) --
Column name.
ColumnId (string) --
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) --
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) --
The name of the column to be renamed.
NewColumnName (string) --
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) --
Column name.
NewColumnType (string) --
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) --
The column that this operation acts on.
Tags (list) --
The dataset column tag, currently only used for geospatial type tagging.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) --
The column that this operation acts on.
TagNames (list) --
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) --
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) --
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) --
The operand on the left side of a join.
RightOperand (string) --
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
Type (string) --
The type of join that it is.
OnClause (string) --
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
OutputColumns (list) --
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
(dict) --
Output column.
Name (string) --
The display name of the column..
Id (string) --
A unique identifier for the output column.
Description (string) --
A description for a column.
Type (string) --
The data type of the column.
SubType (string) --
The sub data type of the column.
ImportMode (string) --
A value that indicates whether you want to import the data into SPICE.
ConsumedSpiceCapacityInBytes (integer) --
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
ColumnGroups (list) --
Groupings of columns that work together in certain Quick Sight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) --
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) --
Columns in this hierarchy.
(string) --
FieldFolders (dict) --
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
RowLevelPermissionDataSet (dict) --
The row-level security configuration for the dataset.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
RowLevelPermissionTagConfiguration (dict) --
The element you can use to define tags for row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) --
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) --
The unique key for a tag.
ColumnName (string) --
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
ColumnLevelPermissionRules (list) --
A set of one or more definitions of a ``ColumnLevelPermissionRule ``.
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Quick Sight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
DataSetUsageConfiguration (dict) --
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.
DatasetParameters (list) --
The parameters that are declared in a dataset.
(dict) --
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) --
An identifier for the string parameter that is created in the dataset.
Name (string) --
The name of the string parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) --
An identifier for the decimal parameter created in the dataset.
Name (string) --
The name of the decimal parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) --
An identifier for the integer parameter created in the dataset.
Name (string) --
The name of the integer parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) --
An identifier for the parameter that is created in the dataset.
Name (string) --
The name of the date time parameter that is created in the dataset.
ValueType (string) --
The value type of the dataset parameter. Valid values are single value or multi value.
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
PerformanceConfiguration (dict) --
The performance optimization configuration of a dataset.
UniqueKeys (list) --
A UniqueKey configuration.
(dict) --
A UniqueKey configuration that references a dataset column.
ColumnNames (list) --
The name of the column that is referenced in the UniqueKey configuration.
(string) --
UseAs (string) --
The usage of the dataset.
DataPrepConfiguration (dict) --
The data preparation configuration associated with this dataset.
SourceTableMap (dict) --
A map of source tables that provide information about underlying sources.
(string) --
(dict) --
A source table that provides initial data from either a physical table or parent dataset.
PhysicalTableId (string) --
The identifier of the physical table that serves as the data source.
DataSet (dict) --
A parent dataset that serves as the data source instead of a physical table.
DataSetArn (string) --
The Amazon Resource Name (ARN) of the parent dataset.
InputColumns (list) --
The list of input columns available from the parent dataset.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) --
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) --
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
TransformStepMap (dict) --
A map of transformation steps that process the data.
(string) --
(dict) --
A step in data preparation that performs a specific operation on the data.
ImportTableStep (dict) --
A transform step that brings data from a source table.
Alias (string) --
Alias for this operation.
Source (dict) --
The source configuration that specifies which source table to import and any column mappings.
SourceTableId (string) --
The identifier of the source table to import data from.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers during the import.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
ProjectStep (dict) --
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
ProjectedColumns (list) --
Projected columns.
(string) --
FiltersStep (dict) --
A transform step that applies filter conditions.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for filtering.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
FilterOperations (list) --
The list of filter operations to apply.
(dict) --
A transform operation that filters rows based on a condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) --
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) --
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) --
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) --
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsStep (dict) --
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
Columns (list) --
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) --
Column name.
ColumnId (string) --
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) --
An expression that defines the calculated column.
RenameColumnsStep (dict) --
A transform step that changes the names of one or more columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column renaming.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
RenameColumnOperations (list) --
The list of column rename operations to perform, specifying old and new column names.
(dict) --
A transform operation that renames a column.
ColumnName (string) --
The name of the column to be renamed.
NewColumnName (string) --
The new name for the column.
CastColumnTypesStep (dict) --
A transform step that changes the data types of one or more columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for the type casting.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
CastColumnTypeOperations (list) --
The list of column type casting operations to perform.
(dict) --
A transform operation that casts a column to a different type.
ColumnName (string) --
Column name.
NewColumnType (string) --
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
JoinStep (dict) --
A transform step that combines data from two sources based on specified join conditions.
Alias (string) --
Alias for this operation.
LeftOperand (dict) --
The left operand for the join operation.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
RightOperand (dict) --
The right operand for the join operation.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
Type (string) --
The type of join to perform, such as INNER, LEFT, RIGHT, or OUTER.
OnClause (string) --
The join condition that specifies how to match rows between the left and right operands.
LeftOperandProperties (dict) --
Properties that control how the left operand's columns are handled in the join result.
OutputColumnNameOverrides (list) --
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) --
The new name to assign to the column in the output.
RightOperandProperties (dict) --
Properties that control how the right operand's columns are handled in the join result.
OutputColumnNameOverrides (list) --
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) --
The new name to assign to the column in the output.
AggregateStep (dict) --
A transform step that groups data and applies aggregation functions to calculate summary values.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for the aggregation.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.
(string) --
Aggregations (list) --
The list of aggregation functions to apply to the grouped data, such as SUM, COUNT, or AVERAGE.
(dict) --
Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.
AggregationFunction (dict) --
The aggregation function to apply, such as SUM, COUNT, AVERAGE, MIN, MAX
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) --
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) --
The string used to separate values in the concatenated result.
Distinct (boolean) --
Whether to include only distinct values in the concatenated result, removing duplicates.
NewColumnName (string) --
The name for the new column that will contain the aggregated values.
NewColumnId (string) --
A unique identifier for the new column that will contain the aggregated values.
PivotStep (dict) --
A transform step that converts row values into columns to reshape the data structure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for pivoting.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the pivot operation.
(string) --
ValueColumnConfiguration (dict) --
Configuration for how to aggregate values when multiple rows map to the same pivoted column.
AggregationFunction (dict) --
The aggregation function to apply when multiple values map to the same pivoted cell.
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) --
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) --
The string used to separate values in the concatenated result.
Distinct (boolean) --
Whether to include only distinct values in the concatenated result, removing duplicates.
PivotConfiguration (dict) --
Configuration that specifies which labels to pivot and how to structure the resulting columns.
LabelColumnName (string) --
The name of the column that contains the labels to be pivoted into separate columns.
PivotedLabels (list) --
The list of specific label values to pivot into separate columns.
(dict) --
Specifies a label value to be pivoted into a separate column, including the new column name and identifier.
LabelName (string) --
The label value from the source data to be pivoted.
NewColumnName (string) --
The name for the new column created from this pivoted label.
NewColumnId (string) --
A unique identifier for the new column created from this pivoted label.
UnpivotStep (dict) --
A transform step that converts columns into rows to normalize the data structure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for unpivoting.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
ColumnsToUnpivot (list) --
The list of columns to unpivot from the source data.
(dict) --
Specifies a column to be unpivoted, transforming it from a column into rows with associated values.
ColumnName (string) --
The name of the column to unpivot from the source data.
NewValue (string) --
The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.
UnpivotedLabelColumnName (string) --
The name for the new column that will contain the unpivoted column names.
UnpivotedLabelColumnId (string) --
A unique identifier for the new column that will contain the unpivoted column names.
UnpivotedValueColumnName (string) --
The name for the new column that will contain the unpivoted values.
UnpivotedValueColumnId (string) --
A unique identifier for the new column that will contain the unpivoted values.
AppendStep (dict) --
A transform step that combines rows from multiple sources by stacking them vertically.
Alias (string) --
Alias for this operation.
FirstSource (dict) --
The first data source to be included in the append operation.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
SecondSource (dict) --
The second data source to be appended to the first source.
TransformOperationId (string) --
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) --
Source column ID.
TargetColumnId (string) --
Target column ID.
AppendedColumns (list) --
The list of columns to include in the appended result, mapping columns from both sources.
(dict) --
Represents a column that will be included in the result of an append operation, combining data from multiple sources.
ColumnName (string) --
The name of the column to include in the appended result.
NewColumnId (string) --
A unique identifier for the column in the appended result.
DestinationTableMap (dict) --
A map of destination tables that receive the final prepared data.
(string) --
(dict) --
Defines a destination table in data preparation that receives the final transformed data.
Alias (string) --
Alias for the destination table.
Source (dict) --
The source configuration that specifies which transform operation provides data to this destination table.
TransformOperationId (string) --
The identifier of the transform operation that provides data to the destination table.
SemanticModelConfiguration (dict) --
The semantic model configuration associated with this dataset.
TableMap (dict) --
A map of semantic tables that define the analytical structure.
(string) --
(dict) --
A semantic table that represents the final analytical structure of the data.
Alias (string) --
Alias for the semantic table.
DestinationTableId (string) --
The identifier of the destination table from data preparation that provides data to this semantic table.
RowLevelPermissionConfiguration (dict) --
Configuration for row level security that control data access for this semantic table.
TagConfiguration (dict) --
The configuration of tags on a dataset to set row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) --
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) --
The unique key for a tag.
ColumnName (string) --
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
RowLevelPermissionDataSet (dict) --
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide.
The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) --
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) --
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
SemanticMetadata (dict) --
The column-level semantic metadata for this semantic table.
ColumnMetadata (list) --
A list of column semantic metadata entries.
(dict) --
Semantic metadata shared across one or more columns.
ColumnNames (list) --
The names of the columns this metadata applies to.
(string) --
ColumnProperties (list) --
The semantic properties for the specified columns.
(dict) --
A semantic property for a column.
Description (dict) --
A description of the column.
Text (string) --
The text of a description for a column.
AdditionalNotes (dict) --
Additional notes for the column.
Text (string) --
The additional notes text.
SemanticType (dict) --
The semantic type of the column.
GeographicalRole (string) --
The geographical role of the column in the new data preparation experience.
SemanticMetadata (list) --
The dataset-level semantic metadata, including a description and custom instructions.
(dict) --
Semantic metadata for a dataset, including a description and custom instructions.
Description (dict) --
A description of the dataset.
Text (string) --
The descriptive text for the dataset.
CustomInstructions (list) --
A list of custom instructions that guide how the dataset should be consumed.
(dict) --
A custom instruction that provides guidance on how the dataset should be consumed.
InlineCustomInstruction (dict) --
An inline custom instruction containing text and optional uploaded document metadata.
InstructionText (string) --
The instruction text content.
UploadedDocumentMetadata (dict) --
Metadata about an uploaded document associated with this instruction.
Name (string) --
The name of the uploaded document.
UnmaterializedCalculatedColumns (list) --
The unmaterialized calculated columns associated with this dataset. You can only use this with the new data preparation experience.
(dict) --
A calculated column that is not materialized in the prepared data. The column is computed at analysis time and can use aggregate expressions.
ColumnId (string) --
A unique ID to identify the unmaterialized calculated column.
ColumnName (string) --
The name of the unmaterialized calculated column.
Expression (string) --
An expression that defines the unmaterialized calculated column.
Type (string) --
The data type of the unmaterialized calculated column.
SubType (string) --
The sub data type of the unmaterialized calculated column.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'DataSource': {'AlternateDataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}},
'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}}
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'|'S3_TABLES'|'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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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',
'CredentialStatus': 'CONNECTED'|'AUTH_FAILED'|'NOT_VERIFIED',
'LastCredentialVerifiedAt': datetime(2015, 1, 1)
},
'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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
CredentialStatus (string) --
The credential verification status of the data source. Valid values include:
CONNECTED – Credential validation succeeded.
AUTH_FAILED – Credential validation failed.
NOT_VERIFIED – Credential validation has not been performed.
LastCredentialVerifiedAt (datetime) --
The time that the credentials were last verified.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Policies': {'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}}
Lists all approval policies in the specified Quick Sight account. The results are paginated. If the response includes a NextToken value, pass it in a subsequent call to retrieve the next set of results.
See also: AWS API Documentation
Request Syntax
client.list_approval_policies(
NextToken='string',
MaxResults=123
)
string
The token for the next set of results, or null if there are no more results.
integer
The maximum number of results to return in a single call. If you don't specify a value, the service returns a default number of results. Use the NextToken value in the response to retrieve additional results.
dict
Response Syntax
{
'Policies': [
{
'PolicyId': 'string',
'PolicyArn': 'string',
'Name': 'string',
'Description': 'string',
'Actions': [
'SHARE'|'PUBLISH',
],
'AssetTypes': [
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
'ApplicableTo': {
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
'ApprovalGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Policies (list) --
The list of approval policies.
(dict) --
A governance approval policy that specifies which principals and governed actions require approval, and which assets the policy applies to.
PolicyId (string) --
The unique identifier of the approval policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the approval policy.
Name (string) --
The name of the approval policy.
Description (string) --
A description of the approval policy.
Actions (list) --
The list of governed actions that trigger the approval workflow.
(string) --
AssetTypes (list) --
The list of asset types that the approval policy applies to.
(string) --
ApplicableTo (dict) --
The scoping configuration that determines who the approval policy applies to.
Type (string) --
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
ApprovalGroups (list) --
The list of group ARNs whose members can approve requests.
(string) --
CreatedAt (datetime) --
The date and time that the approval policy was created.
UpdatedAt (datetime) --
The date and time that the approval policy was last updated.
NextToken (string) --
The token for the next set of results, or null if there are no more results.
{'CustomPermissionsList': {'Capabilities': {'CreateAndUpdateLocalMCPAction': 'DENY '
'| '
'ALLOW',
'LocalMCPAction': 'DENY | ALLOW',
'UseLocalMCPAction': 'DENY | '
'ALLOW'}}}
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'|'ALLOW',
'ExportToExcel': 'DENY'|'ALLOW',
'ExportToPdf': 'DENY'|'ALLOW',
'PrintReports': 'DENY'|'ALLOW',
'CreateAndUpdateThemes': 'DENY'|'ALLOW',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY'|'ALLOW',
'ShareAnalyses': 'DENY'|'ALLOW',
'CreateAndUpdateDatasets': 'DENY'|'ALLOW',
'ShareDatasets': 'DENY'|'ALLOW',
'SubscribeDashboardEmailReports': 'DENY'|'ALLOW',
'CreateAndUpdateDashboardEmailReports': 'DENY'|'ALLOW',
'ShareDashboards': 'DENY'|'ALLOW',
'CreateAndUpdateThresholdAlerts': 'DENY'|'ALLOW',
'RenameSharedFolders': 'DENY'|'ALLOW',
'CreateSharedFolders': 'DENY'|'ALLOW',
'CreateAndUpdateDataSources': 'DENY'|'ALLOW',
'ShareDataSources': 'DENY'|'ALLOW',
'ViewAccountSPICECapacity': 'DENY'|'ALLOW',
'CreateSPICEDataset': 'DENY'|'ALLOW',
'ExportToPdfInScheduledReports': 'DENY'|'ALLOW',
'ExportToCsvInScheduledReports': 'DENY'|'ALLOW',
'ExportToExcelInScheduledReports': 'DENY'|'ALLOW',
'IncludeContentInScheduledReportsEmail': 'DENY'|'ALLOW',
'Dashboard': 'DENY'|'ALLOW',
'Analysis': 'DENY'|'ALLOW',
'Automate': 'DENY'|'ALLOW',
'Flow': 'DENY'|'ALLOW',
'Apps': 'DENY'|'ALLOW',
'CreateAndUpdateApps': 'DENY'|'ALLOW',
'ShareApps': 'DENY'|'ALLOW',
'InvokeAppsAIInference': 'DENY'|'ALLOW',
'AccessAppsNativeDataStore': 'DENY'|'ALLOW',
'PublishWithoutApproval': 'DENY'|'ALLOW',
'UseBedrockModels': 'DENY'|'ALLOW',
'PerformFlowUiTask': 'DENY'|'ALLOW',
'ApproveFlowShareRequests': 'DENY'|'ALLOW',
'UseAgentWebSearch': 'DENY'|'ALLOW',
'KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateKnowledgeBases': 'DENY'|'ALLOW',
'ShareKnowledgeBases': 'DENY'|'ALLOW',
'SharePointKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointKnowledgeBase': 'DENY'|'ALLOW',
'ShareSharePointKnowledgeBase': 'DENY'|'ALLOW',
'UseSharePointKnowledgeBase': 'DENY'|'ALLOW',
'GoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'WebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'ShareWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'UseWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'S3KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateS3KnowledgeBase': 'DENY'|'ALLOW',
'ShareS3KnowledgeBase': 'DENY'|'ALLOW',
'UseS3KnowledgeBase': 'DENY'|'ALLOW',
'ConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'ShareConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'UseConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'OneDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'QBusinessKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'ShareQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'UseQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'BedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'ShareBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'UseBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'BoxKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBoxKnowledgeBase': 'DENY'|'ALLOW',
'ShareBoxKnowledgeBase': 'DENY'|'ALLOW',
'UseBoxKnowledgeBase': 'DENY'|'ALLOW',
'IDCKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateIDCKnowledgeBase': 'DENY'|'ALLOW',
'ShareIDCKnowledgeBase': 'DENY'|'ALLOW',
'UseIDCKnowledgeBase': 'DENY'|'ALLOW',
'Action': 'DENY'|'ALLOW',
'GenericHTTPAction': 'DENY'|'ALLOW',
'CreateAndUpdateGenericHTTPAction': 'DENY'|'ALLOW',
'ShareGenericHTTPAction': 'DENY'|'ALLOW',
'UseGenericHTTPAction': 'DENY'|'ALLOW',
'AsanaAction': 'DENY'|'ALLOW',
'CreateAndUpdateAsanaAction': 'DENY'|'ALLOW',
'ShareAsanaAction': 'DENY'|'ALLOW',
'UseAsanaAction': 'DENY'|'ALLOW',
'SlackAction': 'DENY'|'ALLOW',
'CreateAndUpdateSlackAction': 'DENY'|'ALLOW',
'ShareSlackAction': 'DENY'|'ALLOW',
'UseSlackAction': 'DENY'|'ALLOW',
'ServiceNowAction': 'DENY'|'ALLOW',
'CreateAndUpdateServiceNowAction': 'DENY'|'ALLOW',
'ShareServiceNowAction': 'DENY'|'ALLOW',
'UseServiceNowAction': 'DENY'|'ALLOW',
'SalesforceAction': 'DENY'|'ALLOW',
'CreateAndUpdateSalesforceAction': 'DENY'|'ALLOW',
'ShareSalesforceAction': 'DENY'|'ALLOW',
'UseSalesforceAction': 'DENY'|'ALLOW',
'MSExchangeAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSExchangeAction': 'DENY'|'ALLOW',
'ShareMSExchangeAction': 'DENY'|'ALLOW',
'UseMSExchangeAction': 'DENY'|'ALLOW',
'PagerDutyAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAction': 'DENY'|'ALLOW',
'SharePagerDutyAction': 'DENY'|'ALLOW',
'UsePagerDutyAction': 'DENY'|'ALLOW',
'JiraAction': 'DENY'|'ALLOW',
'CreateAndUpdateJiraAction': 'DENY'|'ALLOW',
'ShareJiraAction': 'DENY'|'ALLOW',
'UseJiraAction': 'DENY'|'ALLOW',
'ConfluenceAction': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceAction': 'DENY'|'ALLOW',
'ShareConfluenceAction': 'DENY'|'ALLOW',
'UseConfluenceAction': 'DENY'|'ALLOW',
'OneDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveAction': 'DENY'|'ALLOW',
'ShareOneDriveAction': 'DENY'|'ALLOW',
'UseOneDriveAction': 'DENY'|'ALLOW',
'SharePointAction': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointAction': 'DENY'|'ALLOW',
'ShareSharePointAction': 'DENY'|'ALLOW',
'UseSharePointAction': 'DENY'|'ALLOW',
'MSTeamsAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSTeamsAction': 'DENY'|'ALLOW',
'ShareMSTeamsAction': 'DENY'|'ALLOW',
'UseMSTeamsAction': 'DENY'|'ALLOW',
'GoogleCalendarAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleCalendarAction': 'DENY'|'ALLOW',
'ShareGoogleCalendarAction': 'DENY'|'ALLOW',
'UseGoogleCalendarAction': 'DENY'|'ALLOW',
'ZendeskAction': 'DENY'|'ALLOW',
'CreateAndUpdateZendeskAction': 'DENY'|'ALLOW',
'ShareZendeskAction': 'DENY'|'ALLOW',
'UseZendeskAction': 'DENY'|'ALLOW',
'SmartsheetAction': 'DENY'|'ALLOW',
'CreateAndUpdateSmartsheetAction': 'DENY'|'ALLOW',
'ShareSmartsheetAction': 'DENY'|'ALLOW',
'UseSmartsheetAction': 'DENY'|'ALLOW',
'SAPBusinessPartnerAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'ShareSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'UseSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'SAPProductMasterDataAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY'|'ALLOW',
'ShareSAPProductMasterDataAction': 'DENY'|'ALLOW',
'UseSAPProductMasterDataAction': 'DENY'|'ALLOW',
'SAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'ShareSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'UseSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'SAPBillOfMaterialAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'ShareSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'UseSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'SAPMaterialStockAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPMaterialStockAction': 'DENY'|'ALLOW',
'ShareSAPMaterialStockAction': 'DENY'|'ALLOW',
'UseSAPMaterialStockAction': 'DENY'|'ALLOW',
'FactSetAction': 'DENY'|'ALLOW',
'CreateAndUpdateFactSetAction': 'DENY'|'ALLOW',
'ShareFactSetAction': 'DENY'|'ALLOW',
'UseFactSetAction': 'DENY'|'ALLOW',
'AmazonSThreeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonSThreeAction': 'DENY'|'ALLOW',
'ShareAmazonSThreeAction': 'DENY'|'ALLOW',
'UseAmazonSThreeAction': 'DENY'|'ALLOW',
'TextractAction': 'DENY'|'ALLOW',
'CreateAndUpdateTextractAction': 'DENY'|'ALLOW',
'ShareTextractAction': 'DENY'|'ALLOW',
'UseTextractAction': 'DENY'|'ALLOW',
'ComprehendAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendAction': 'DENY'|'ALLOW',
'ShareComprehendAction': 'DENY'|'ALLOW',
'UseComprehendAction': 'DENY'|'ALLOW',
'ComprehendMedicalAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendMedicalAction': 'DENY'|'ALLOW',
'ShareComprehendMedicalAction': 'DENY'|'ALLOW',
'UseComprehendMedicalAction': 'DENY'|'ALLOW',
'AmazonBedrockARSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockARSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockARSAction': 'DENY'|'ALLOW',
'AmazonBedrockFSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockFSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockFSAction': 'DENY'|'ALLOW',
'AmazonBedrockKRSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'MCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateMCPAction': 'DENY'|'ALLOW',
'ShareMCPAction': 'DENY'|'ALLOW',
'UseMCPAction': 'DENY'|'ALLOW',
'LocalMCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateLocalMCPAction': 'DENY'|'ALLOW',
'UseLocalMCPAction': 'DENY'|'ALLOW',
'OpenAPIAction': 'DENY'|'ALLOW',
'CreateAndUpdateOpenAPIAction': 'DENY'|'ALLOW',
'ShareOpenAPIAction': 'DENY'|'ALLOW',
'UseOpenAPIAction': 'DENY'|'ALLOW',
'SandPGMIAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGMIAction': 'DENY'|'ALLOW',
'ShareSandPGMIAction': 'DENY'|'ALLOW',
'UseSandPGMIAction': 'DENY'|'ALLOW',
'SandPGlobalEnergyAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'ShareSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'UseSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'BambooHRAction': 'DENY'|'ALLOW',
'CreateAndUpdateBambooHRAction': 'DENY'|'ALLOW',
'ShareBambooHRAction': 'DENY'|'ALLOW',
'UseBambooHRAction': 'DENY'|'ALLOW',
'BoxAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateBoxAgentAction': 'DENY'|'ALLOW',
'ShareBoxAgentAction': 'DENY'|'ALLOW',
'UseBoxAgentAction': 'DENY'|'ALLOW',
'CanvaAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateCanvaAgentAction': 'DENY'|'ALLOW',
'ShareCanvaAgentAction': 'DENY'|'ALLOW',
'UseCanvaAgentAction': 'DENY'|'ALLOW',
'GithubAction': 'DENY'|'ALLOW',
'CreateAndUpdateGithubAction': 'DENY'|'ALLOW',
'ShareGithubAction': 'DENY'|'ALLOW',
'UseGithubAction': 'DENY'|'ALLOW',
'NotionAction': 'DENY'|'ALLOW',
'CreateAndUpdateNotionAction': 'DENY'|'ALLOW',
'ShareNotionAction': 'DENY'|'ALLOW',
'UseNotionAction': 'DENY'|'ALLOW',
'LinearAction': 'DENY'|'ALLOW',
'CreateAndUpdateLinearAction': 'DENY'|'ALLOW',
'ShareLinearAction': 'DENY'|'ALLOW',
'UseLinearAction': 'DENY'|'ALLOW',
'HuggingFaceAction': 'DENY'|'ALLOW',
'CreateAndUpdateHuggingFaceAction': 'DENY'|'ALLOW',
'ShareHuggingFaceAction': 'DENY'|'ALLOW',
'UseHuggingFaceAction': 'DENY'|'ALLOW',
'MondayAction': 'DENY'|'ALLOW',
'CreateAndUpdateMondayAction': 'DENY'|'ALLOW',
'ShareMondayAction': 'DENY'|'ALLOW',
'UseMondayAction': 'DENY'|'ALLOW',
'HubspotAction': 'DENY'|'ALLOW',
'CreateAndUpdateHubspotAction': 'DENY'|'ALLOW',
'ShareHubspotAction': 'DENY'|'ALLOW',
'UseHubspotAction': 'DENY'|'ALLOW',
'IntercomAction': 'DENY'|'ALLOW',
'CreateAndUpdateIntercomAction': 'DENY'|'ALLOW',
'ShareIntercomAction': 'DENY'|'ALLOW',
'UseIntercomAction': 'DENY'|'ALLOW',
'NewRelicAction': 'DENY'|'ALLOW',
'CreateAndUpdateNewRelicAction': 'DENY'|'ALLOW',
'ShareNewRelicAction': 'DENY'|'ALLOW',
'UseNewRelicAction': 'DENY'|'ALLOW',
'PagerDutyAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAgentAction': 'DENY'|'ALLOW',
'SharePagerDutyAgentAction': 'DENY'|'ALLOW',
'UsePagerDutyAgentAction': 'DENY'|'ALLOW',
'VisierAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateVisierAgentAction': 'DENY'|'ALLOW',
'ShareVisierAgentAction': 'DENY'|'ALLOW',
'UseVisierAgentAction': 'DENY'|'ALLOW',
'ZoomAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomAction': 'DENY'|'ALLOW',
'ShareZoomAction': 'DENY'|'ALLOW',
'UseZoomAction': 'DENY'|'ALLOW',
'SnowFlakeAction': 'DENY'|'ALLOW',
'CreateAndUpdateSnowFlakeAction': 'DENY'|'ALLOW',
'ShareSnowFlakeAction': 'DENY'|'ALLOW',
'UseSnowFlakeAction': 'DENY'|'ALLOW',
'ZapierAction': 'DENY'|'ALLOW',
'CreateAndUpdateZapierAction': 'DENY'|'ALLOW',
'ShareZapierAction': 'DENY'|'ALLOW',
'UseZapierAction': 'DENY'|'ALLOW',
'AirtableAction': 'DENY'|'ALLOW',
'CreateAndUpdateAirtableAction': 'DENY'|'ALLOW',
'ShareAirtableAction': 'DENY'|'ALLOW',
'UseAirtableAction': 'DENY'|'ALLOW',
'DropboxAction': 'DENY'|'ALLOW',
'CreateAndUpdateDropboxAction': 'DENY'|'ALLOW',
'ShareDropboxAction': 'DENY'|'ALLOW',
'UseDropboxAction': 'DENY'|'ALLOW',
'GmailAction': 'DENY'|'ALLOW',
'CreateAndUpdateGmailAction': 'DENY'|'ALLOW',
'ShareGmailAction': 'DENY'|'ALLOW',
'UseGmailAction': 'DENY'|'ALLOW',
'GoogleAnalyticsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleAnalyticsAction': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsAction': 'DENY'|'ALLOW',
'UseGoogleAnalyticsAction': 'DENY'|'ALLOW',
'GoogleDocsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDocsAction': 'DENY'|'ALLOW',
'ShareGoogleDocsAction': 'DENY'|'ALLOW',
'UseGoogleDocsAction': 'DENY'|'ALLOW',
'GoogleDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveAction': 'DENY'|'ALLOW',
'ShareGoogleDriveAction': 'DENY'|'ALLOW',
'UseGoogleDriveAction': 'DENY'|'ALLOW',
'GoogleMeetAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleMeetAction': 'DENY'|'ALLOW',
'ShareGoogleMeetAction': 'DENY'|'ALLOW',
'UseGoogleMeetAction': 'DENY'|'ALLOW',
'GoogleSheetsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSheetsAction': 'DENY'|'ALLOW',
'ShareGoogleSheetsAction': 'DENY'|'ALLOW',
'UseGoogleSheetsAction': 'DENY'|'ALLOW',
'GoogleSlidesAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSlidesAction': 'DENY'|'ALLOW',
'ShareGoogleSlidesAction': 'DENY'|'ALLOW',
'UseGoogleSlidesAction': 'DENY'|'ALLOW',
'QuickBooksAction': 'DENY'|'ALLOW',
'CreateAndUpdateQuickBooksAction': 'DENY'|'ALLOW',
'ShareQuickBooksAction': 'DENY'|'ALLOW',
'UseQuickBooksAction': 'DENY'|'ALLOW',
'FigmaAction': 'DENY'|'ALLOW',
'CreateAndUpdateFigmaAction': 'DENY'|'ALLOW',
'ShareFigmaAction': 'DENY'|'ALLOW',
'UseFigmaAction': 'DENY'|'ALLOW',
'WhatsAppAction': 'DENY'|'ALLOW',
'CreateAndUpdateWhatsAppAction': 'DENY'|'ALLOW',
'ShareWhatsAppAction': 'DENY'|'ALLOW',
'UseWhatsAppAction': 'DENY'|'ALLOW',
'GoogleChatAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleChatAction': 'DENY'|'ALLOW',
'ShareGoogleChatAction': 'DENY'|'ALLOW',
'UseGoogleChatAction': 'DENY'|'ALLOW',
'OneNoteAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneNoteAction': 'DENY'|'ALLOW',
'ShareOneNoteAction': 'DENY'|'ALLOW',
'UseOneNoteAction': 'DENY'|'ALLOW',
'ShopifyAction': 'DENY'|'ALLOW',
'CreateAndUpdateShopifyAction': 'DENY'|'ALLOW',
'ShareShopifyAction': 'DENY'|'ALLOW',
'UseShopifyAction': 'DENY'|'ALLOW',
'AdobeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAdobeAction': 'DENY'|'ALLOW',
'ShareAdobeAction': 'DENY'|'ALLOW',
'UseAdobeAction': 'DENY'|'ALLOW',
'CiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'ShareCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'UseCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'ShareCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'UseCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'DunAndBradstreetAction': 'DENY'|'ALLOW',
'CreateAndUpdateDunAndBradstreetAction': 'DENY'|'ALLOW',
'ShareDunAndBradstreetAction': 'DENY'|'ALLOW',
'UseDunAndBradstreetAction': 'DENY'|'ALLOW',
'HGInsightsAction': 'DENY'|'ALLOW',
'CreateAndUpdateHGInsightsAction': 'DENY'|'ALLOW',
'ShareHGInsightsAction': 'DENY'|'ALLOW',
'UseHGInsightsAction': 'DENY'|'ALLOW',
'ZoomInfoAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomInfoAction': 'DENY'|'ALLOW',
'ShareZoomInfoAction': 'DENY'|'ALLOW',
'UseZoomInfoAction': 'DENY'|'ALLOW',
'MoodysAction': 'DENY'|'ALLOW',
'CreateAndUpdateMoodysAction': 'DENY'|'ALLOW',
'ShareMoodysAction': 'DENY'|'ALLOW',
'UseMoodysAction': 'DENY'|'ALLOW',
'BeeAction': 'DENY'|'ALLOW',
'CreateAndUpdateBeeAction': 'DENY'|'ALLOW',
'ShareBeeAction': 'DENY'|'ALLOW',
'UseBeeAction': 'DENY'|'ALLOW',
'GongAction': 'DENY'|'ALLOW',
'CreateAndUpdateGongAction': 'DENY'|'ALLOW',
'ShareGongAction': 'DENY'|'ALLOW',
'UseGongAction': 'DENY'|'ALLOW',
'Topic': 'DENY'|'ALLOW',
'EditVisualWithQ': 'DENY'|'ALLOW',
'BuildCalculatedFieldWithQ': 'DENY'|'ALLOW',
'CreateDashboardExecutiveSummaryWithQ': 'DENY'|'ALLOW',
'Space': 'DENY'|'ALLOW',
'CreateSpaces': 'DENY'|'ALLOW',
'ShareSpaces': 'DENY'|'ALLOW',
'ChatAgent': 'DENY'|'ALLOW',
'CreateChatAgents': 'DENY'|'ALLOW',
'ShareChatAgents': 'DENY'|'ALLOW',
'Research': 'DENY'|'ALLOW',
'SelfUpgradeUserRole': 'DENY'|'ALLOW',
'Extension': 'DENY'|'ALLOW',
'UseBrowserExtension': 'DENY'|'ALLOW',
'UseWordAddInExtension': 'DENY'|'ALLOW',
'UseOutlookAddInExtension': 'DENY'|'ALLOW',
'UseExcelAddInExtension': 'DENY'|'ALLOW',
'UsePowerpointAddInExtension': 'DENY'|'ALLOW',
'ManageSharedFolders': 'DENY'|'ALLOW',
'GenerateAnalyses': 'DENY'|'ALLOW',
'Story': 'DENY'|'ALLOW',
'Scenario': 'DENY'|'ALLOW',
'Trigger': 'DENY'|'ALLOW',
'ScheduleTrigger': 'DENY'|'ALLOW',
'InboundEmailTrigger': 'DENY'|'ALLOW',
'QuickEventTrigger': 'DENY'|'ALLOW',
'FileDataSource': 'DENY'|'ALLOW',
'CreateFileDataSource': 'DENY'|'ALLOW',
'UpdateFileDataSource': 'DENY'|'ALLOW',
'ShareFileDataSource': 'DENY'|'ALLOW',
'S3DataSource': 'DENY'|'ALLOW',
'CreateS3DataSource': 'DENY'|'ALLOW',
'UpdateS3DataSource': 'DENY'|'ALLOW',
'ShareS3DataSource': 'DENY'|'ALLOW',
'S3AnalyticsDataSource': 'DENY'|'ALLOW',
'CreateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'ShareS3AnalyticsDataSource': 'DENY'|'ALLOW',
'S3TablesDataSource': 'DENY'|'ALLOW',
'CreateS3TablesDataSource': 'DENY'|'ALLOW',
'UpdateS3TablesDataSource': 'DENY'|'ALLOW',
'ShareS3TablesDataSource': 'DENY'|'ALLOW',
'AthenaDataSource': 'DENY'|'ALLOW',
'CreateAthenaDataSource': 'DENY'|'ALLOW',
'UpdateAthenaDataSource': 'DENY'|'ALLOW',
'ShareAthenaDataSource': 'DENY'|'ALLOW',
'RdsDataSource': 'DENY'|'ALLOW',
'CreateRdsDataSource': 'DENY'|'ALLOW',
'UpdateRdsDataSource': 'DENY'|'ALLOW',
'ShareRdsDataSource': 'DENY'|'ALLOW',
'RedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'CreateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'ShareRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'RedshiftManualDataSource': 'DENY'|'ALLOW',
'CreateRedshiftManualDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftManualDataSource': 'DENY'|'ALLOW',
'ShareRedshiftManualDataSource': 'DENY'|'ALLOW',
'OpenSearchDataSource': 'DENY'|'ALLOW',
'CreateOpenSearchDataSource': 'DENY'|'ALLOW',
'UpdateOpenSearchDataSource': 'DENY'|'ALLOW',
'ShareOpenSearchDataSource': 'DENY'|'ALLOW',
'TimestreamDataSource': 'DENY'|'ALLOW',
'CreateTimestreamDataSource': 'DENY'|'ALLOW',
'UpdateTimestreamDataSource': 'DENY'|'ALLOW',
'ShareTimestreamDataSource': 'DENY'|'ALLOW',
'AuroraDataSource': 'DENY'|'ALLOW',
'CreateAuroraDataSource': 'DENY'|'ALLOW',
'UpdateAuroraDataSource': 'DENY'|'ALLOW',
'ShareAuroraDataSource': 'DENY'|'ALLOW',
'MySqlDataSource': 'DENY'|'ALLOW',
'CreateMySqlDataSource': 'DENY'|'ALLOW',
'UpdateMySqlDataSource': 'DENY'|'ALLOW',
'ShareMySqlDataSource': 'DENY'|'ALLOW',
'PostgreSqlDataSource': 'DENY'|'ALLOW',
'CreatePostgreSqlDataSource': 'DENY'|'ALLOW',
'UpdatePostgreSqlDataSource': 'DENY'|'ALLOW',
'SharePostgreSqlDataSource': 'DENY'|'ALLOW',
'OracleDataSource': 'DENY'|'ALLOW',
'CreateOracleDataSource': 'DENY'|'ALLOW',
'UpdateOracleDataSource': 'DENY'|'ALLOW',
'ShareOracleDataSource': 'DENY'|'ALLOW',
'SqlServerDataSource': 'DENY'|'ALLOW',
'CreateSqlServerDataSource': 'DENY'|'ALLOW',
'UpdateSqlServerDataSource': 'DENY'|'ALLOW',
'ShareSqlServerDataSource': 'DENY'|'ALLOW',
'MariaDbDataSource': 'DENY'|'ALLOW',
'CreateMariaDbDataSource': 'DENY'|'ALLOW',
'UpdateMariaDbDataSource': 'DENY'|'ALLOW',
'ShareMariaDbDataSource': 'DENY'|'ALLOW',
'SnowflakeDataSource': 'DENY'|'ALLOW',
'CreateSnowflakeDataSource': 'DENY'|'ALLOW',
'UpdateSnowflakeDataSource': 'DENY'|'ALLOW',
'ShareSnowflakeDataSource': 'DENY'|'ALLOW',
'GoogleBigQueryDataSource': 'DENY'|'ALLOW',
'CreateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'UpdateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'ShareGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'DatabricksDataSource': 'DENY'|'ALLOW',
'CreateDatabricksDataSource': 'DENY'|'ALLOW',
'UpdateDatabricksDataSource': 'DENY'|'ALLOW',
'ShareDatabricksDataSource': 'DENY'|'ALLOW',
'StarburstDataSource': 'DENY'|'ALLOW',
'CreateStarburstDataSource': 'DENY'|'ALLOW',
'UpdateStarburstDataSource': 'DENY'|'ALLOW',
'ShareStarburstDataSource': 'DENY'|'ALLOW',
'TrinoDataSource': 'DENY'|'ALLOW',
'CreateTrinoDataSource': 'DENY'|'ALLOW',
'UpdateTrinoDataSource': 'DENY'|'ALLOW',
'ShareTrinoDataSource': 'DENY'|'ALLOW',
'ImpalaDataSource': 'DENY'|'ALLOW',
'CreateImpalaDataSource': 'DENY'|'ALLOW',
'UpdateImpalaDataSource': 'DENY'|'ALLOW',
'ShareImpalaDataSource': 'DENY'|'ALLOW',
'TeradataDataSource': 'DENY'|'ALLOW',
'CreateTeradataDataSource': 'DENY'|'ALLOW',
'UpdateTeradataDataSource': 'DENY'|'ALLOW',
'ShareTeradataDataSource': 'DENY'|'ALLOW',
'PrestoDataSource': 'DENY'|'ALLOW',
'CreatePrestoDataSource': 'DENY'|'ALLOW',
'UpdatePrestoDataSource': 'DENY'|'ALLOW',
'SharePrestoDataSource': 'DENY'|'ALLOW',
'SparkDataSource': 'DENY'|'ALLOW',
'CreateSparkDataSource': 'DENY'|'ALLOW',
'UpdateSparkDataSource': 'DENY'|'ALLOW',
'ShareSparkDataSource': 'DENY'|'ALLOW',
'ExasolDataSource': 'DENY'|'ALLOW',
'CreateExasolDataSource': 'DENY'|'ALLOW',
'UpdateExasolDataSource': 'DENY'|'ALLOW',
'ShareExasolDataSource': 'DENY'|'ALLOW',
'Db2DataSource': 'DENY'|'ALLOW',
'CreateDb2DataSource': 'DENY'|'ALLOW',
'UpdateDb2DataSource': 'DENY'|'ALLOW',
'ShareDb2DataSource': 'DENY'|'ALLOW',
'SapHanaDataSource': 'DENY'|'ALLOW',
'CreateSapHanaDataSource': 'DENY'|'ALLOW',
'UpdateSapHanaDataSource': 'DENY'|'ALLOW',
'ShareSapHanaDataSource': 'DENY'|'ALLOW',
'DenodoDataSource': 'DENY'|'ALLOW',
'CreateDenodoDataSource': 'DENY'|'ALLOW',
'UpdateDenodoDataSource': 'DENY'|'ALLOW',
'ShareDenodoDataSource': 'DENY'|'ALLOW',
'DremioDataSource': 'DENY'|'ALLOW',
'CreateDremioDataSource': 'DENY'|'ALLOW',
'UpdateDremioDataSource': 'DENY'|'ALLOW',
'ShareDremioDataSource': 'DENY'|'ALLOW',
'SalesforceDataSource': 'DENY'|'ALLOW',
'CreateSalesforceDataSource': 'DENY'|'ALLOW',
'UpdateSalesforceDataSource': 'DENY'|'ALLOW',
'ShareSalesforceDataSource': 'DENY'|'ALLOW',
'RadiantDataSource': 'DENY'|'ALLOW',
'CreateRadiantDataSource': 'DENY'|'ALLOW',
'UpdateRadiantDataSource': 'DENY'|'ALLOW',
'ShareRadiantDataSource': 'DENY'|'ALLOW',
'PayPalDataSource': 'DENY'|'ALLOW',
'CreatePayPalDataSource': 'DENY'|'ALLOW',
'UpdatePayPalDataSource': 'DENY'|'ALLOW',
'SharePayPalDataSource': 'DENY'|'ALLOW',
'SquareDataSource': 'DENY'|'ALLOW',
'CreateSquareDataSource': 'DENY'|'ALLOW',
'UpdateSquareDataSource': 'DENY'|'ALLOW',
'ShareSquareDataSource': 'DENY'|'ALLOW',
'GitHubDataSource': 'DENY'|'ALLOW',
'CreateGitHubDataSource': 'DENY'|'ALLOW',
'UpdateGitHubDataSource': 'DENY'|'ALLOW',
'ShareGitHubDataSource': 'DENY'|'ALLOW',
'TwitterDataSource': 'DENY'|'ALLOW',
'CreateTwitterDataSource': 'DENY'|'ALLOW',
'UpdateTwitterDataSource': 'DENY'|'ALLOW',
'ShareTwitterDataSource': 'DENY'|'ALLOW',
'JiraDataSource': 'DENY'|'ALLOW',
'CreateJiraDataSource': 'DENY'|'ALLOW',
'UpdateJiraDataSource': 'DENY'|'ALLOW',
'ShareJiraDataSource': 'DENY'|'ALLOW',
'ServiceNowDataSource': 'DENY'|'ALLOW',
'CreateServiceNowDataSource': 'DENY'|'ALLOW',
'UpdateServiceNowDataSource': 'DENY'|'ALLOW',
'ShareServiceNowDataSource': 'DENY'|'ALLOW',
'AdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleSheetsDataSource': 'DENY'|'ALLOW',
'CreateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'ShareGoogleSheetsDataSource': 'DENY'|'ALLOW',
'DocumentDbDataSource': 'DENY'|'ALLOW',
'CreateDocumentDbDataSource': 'DENY'|'ALLOW',
'UpdateDocumentDbDataSource': 'DENY'|'ALLOW',
'ShareDocumentDbDataSource': 'DENY'|'ALLOW',
'MongoDbDataSource': 'DENY'|'ALLOW',
'CreateMongoDbDataSource': 'DENY'|'ALLOW',
'UpdateMongoDbDataSource': 'DENY'|'ALLOW',
'ShareMongoDbDataSource': 'DENY'|'ALLOW',
'MongoAtlasDataSource': 'DENY'|'ALLOW',
'CreateMongoAtlasDataSource': 'DENY'|'ALLOW',
'UpdateMongoAtlasDataSource': 'DENY'|'ALLOW',
'ShareMongoAtlasDataSource': 'DENY'|'ALLOW',
'DynamoDbDataSource': 'DENY'|'ALLOW',
'CreateDynamoDbDataSource': 'DENY'|'ALLOW',
'UpdateDynamoDbDataSource': 'DENY'|'ALLOW',
'ShareDynamoDbDataSource': 'DENY'|'ALLOW'
},
'Governance': {
'DefaultCategoryEffects': {
'string': 'DENY_BY_DEFAULT'
}
}
},
],
'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.
Apps (string) --
The ability to perform apps-related actions.
CreateAndUpdateApps (string) --
The ability to create or update apps.
ShareApps (string) --
The ability to share apps with other users.
InvokeAppsAIInference (string) --
The ability to add and invoke AI inference in new and existing apps.
AccessAppsNativeDataStore (string) --
The ability to access the native data store for new and existing apps.
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.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
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.
CreateAndUpdateKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
SharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
GoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
WebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
S3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
OneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
QBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
IDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
LocalMCPAction (string) --
The ability to create, update, and use local Model Context Protocol (MCP) actions. This capability includes CreateAndUpdateLocalMCPAction and UseLocalMCPAction.
CreateAndUpdateLocalMCPAction (string) --
The ability to create and update local Model Context Protocol (MCP) server configurations. Denying this capability does not by itself deny use of previously configured local MCP servers.
UseLocalMCPAction (string) --
The ability to start local Model Context Protocol (MCP) servers and use their actions, including actions from previously configured local MCP servers.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
PagerDutyAgentAction (string) --
The ability to perform actions using PagerDuty Agent connectors.
CreateAndUpdatePagerDutyAgentAction (string) --
The ability to create and update PagerDuty Agent actions.
SharePagerDutyAgentAction (string) --
The ability to share PagerDuty Agent actions.
UsePagerDutyAgentAction (string) --
The ability to use PagerDuty Agent actions.
VisierAgentAction (string) --
The ability to perform actions using Visier Agent connectors.
CreateAndUpdateVisierAgentAction (string) --
The ability to create and update Visier Agent actions.
ShareVisierAgentAction (string) --
The ability to share Visier Agent actions.
UseVisierAgentAction (string) --
The ability to use Visier Agent actions.
ZoomAction (string) --
The ability to perform actions using Zoom connectors.
CreateAndUpdateZoomAction (string) --
The ability to create and update Zoom actions.
ShareZoomAction (string) --
The ability to share Zoom actions.
UseZoomAction (string) --
The ability to use Zoom actions.
SnowFlakeAction (string) --
The ability to perform actions using Snowflake Cortex Agent connectors.
CreateAndUpdateSnowFlakeAction (string) --
The ability to create and update Snowflake Cortex Agent actions.
ShareSnowFlakeAction (string) --
The ability to share Snowflake Cortex Agent actions.
UseSnowFlakeAction (string) --
The ability to use Snowflake Cortex Agent actions.
ZapierAction (string) --
The ability to perform actions using Zapier Agent connectors.
CreateAndUpdateZapierAction (string) --
The ability to create and update Zapier Agent actions.
ShareZapierAction (string) --
The ability to share Zapier Agent actions.
UseZapierAction (string) --
The ability to use Zapier Agent actions.
AirtableAction (string) --
The ability to perform actions using Airtable connectors.
CreateAndUpdateAirtableAction (string) --
The ability to create and update Airtable actions.
ShareAirtableAction (string) --
The ability to share Airtable actions.
UseAirtableAction (string) --
The ability to use Airtable actions.
DropboxAction (string) --
The ability to perform actions using Dropbox connectors.
CreateAndUpdateDropboxAction (string) --
The ability to create and update Dropbox actions.
ShareDropboxAction (string) --
The ability to share Dropbox actions.
UseDropboxAction (string) --
The ability to use Dropbox actions.
GmailAction (string) --
The ability to perform actions using Gmail connectors.
CreateAndUpdateGmailAction (string) --
The ability to create and update Gmail actions.
ShareGmailAction (string) --
The ability to share Gmail actions.
UseGmailAction (string) --
The ability to use Gmail actions.
GoogleAnalyticsAction (string) --
The ability to perform actions using Google Analytics connectors.
CreateAndUpdateGoogleAnalyticsAction (string) --
The ability to create and update Google Analytics actions.
ShareGoogleAnalyticsAction (string) --
The ability to share Google Analytics actions.
UseGoogleAnalyticsAction (string) --
The ability to use Google Analytics actions.
GoogleDocsAction (string) --
The ability to perform actions using Google Docs connectors.
CreateAndUpdateGoogleDocsAction (string) --
The ability to create and update Google Docs actions.
ShareGoogleDocsAction (string) --
The ability to share Google Docs actions.
UseGoogleDocsAction (string) --
The ability to use Google Docs actions.
GoogleDriveAction (string) --
The ability to perform actions using Google Drive connectors.
CreateAndUpdateGoogleDriveAction (string) --
The ability to create and update Google Drive actions.
ShareGoogleDriveAction (string) --
The ability to share Google Drive actions.
UseGoogleDriveAction (string) --
The ability to use Google Drive actions.
GoogleMeetAction (string) --
The ability to perform actions using Google Meet connectors.
CreateAndUpdateGoogleMeetAction (string) --
The ability to create and update Google Meet actions.
ShareGoogleMeetAction (string) --
The ability to share Google Meet actions.
UseGoogleMeetAction (string) --
The ability to use Google Meet actions.
GoogleSheetsAction (string) --
The ability to perform actions using Google Sheets connectors.
CreateAndUpdateGoogleSheetsAction (string) --
The ability to create and update Google Sheets actions.
ShareGoogleSheetsAction (string) --
The ability to share Google Sheets actions.
UseGoogleSheetsAction (string) --
The ability to use Google Sheets actions.
GoogleSlidesAction (string) --
The ability to perform actions using Google Slides connectors.
CreateAndUpdateGoogleSlidesAction (string) --
The ability to create and update Google Slides actions.
ShareGoogleSlidesAction (string) --
The ability to share Google Slides actions.
UseGoogleSlidesAction (string) --
The ability to use Google Slides actions.
QuickBooksAction (string) --
The ability to perform actions using QuickBooks connectors.
CreateAndUpdateQuickBooksAction (string) --
The ability to create and update QuickBooks actions.
ShareQuickBooksAction (string) --
The ability to share QuickBooks actions.
UseQuickBooksAction (string) --
The ability to use QuickBooks actions.
FigmaAction (string) --
The ability to perform actions using Figma connectors.
CreateAndUpdateFigmaAction (string) --
The ability to create and update Figma actions.
ShareFigmaAction (string) --
The ability to share Figma actions.
UseFigmaAction (string) --
The ability to use Figma actions.
WhatsAppAction (string) --
The ability to perform actions using WhatsApp connectors.
CreateAndUpdateWhatsAppAction (string) --
The ability to create and update WhatsApp actions.
ShareWhatsAppAction (string) --
The ability to share WhatsApp actions.
UseWhatsAppAction (string) --
The ability to use WhatsApp actions.
GoogleChatAction (string) --
The ability to perform actions using Google Chat connectors.
CreateAndUpdateGoogleChatAction (string) --
The ability to create and update Google Chat actions.
ShareGoogleChatAction (string) --
The ability to share Google Chat actions.
UseGoogleChatAction (string) --
The ability to use Google Chat actions.
OneNoteAction (string) --
The ability to perform actions using Microsoft OneNote connectors.
CreateAndUpdateOneNoteAction (string) --
The ability to create and update Microsoft OneNote actions.
ShareOneNoteAction (string) --
The ability to share Microsoft OneNote actions.
UseOneNoteAction (string) --
The ability to use Microsoft OneNote actions.
ShopifyAction (string) --
The ability to perform actions using Shopify connectors.
CreateAndUpdateShopifyAction (string) --
The ability to create and update Shopify actions.
ShareShopifyAction (string) --
The ability to share Shopify actions.
UseShopifyAction (string) --
The ability to use Shopify actions.
AdobeAction (string) --
The ability to perform actions using Adobe Marketing Agent connectors.
CreateAndUpdateAdobeAction (string) --
The ability to create and update Adobe Marketing Agent actions.
ShareAdobeAction (string) --
The ability to share Adobe Marketing Agent actions.
UseAdobeAction (string) --
The ability to use Adobe Marketing Agent actions.
CiscoWebexVidcastAction (string) --
The ability to perform actions using Cisco Webex Video Messaging Agent connectors.
CreateAndUpdateCiscoWebexVidcastAction (string) --
The ability to create and update Cisco Webex Video Messaging Agent actions.
ShareCiscoWebexVidcastAction (string) --
The ability to share Cisco Webex Video Messaging Agent actions.
UseCiscoWebexVidcastAction (string) --
The ability to use Cisco Webex Video Messaging Agent actions.
CiscoWebexMeetingsAction (string) --
The ability to perform actions using Cisco Webex Meetings connectors.
CreateAndUpdateCiscoWebexMeetingsAction (string) --
The ability to create and update Cisco Webex Meetings actions.
ShareCiscoWebexMeetingsAction (string) --
The ability to share Cisco Webex Meetings actions.
UseCiscoWebexMeetingsAction (string) --
The ability to use Cisco Webex Meetings actions.
DunAndBradstreetAction (string) --
The ability to perform actions using Dun and Bradstreet connectors.
CreateAndUpdateDunAndBradstreetAction (string) --
The ability to create and update Dun and Bradstreet actions.
ShareDunAndBradstreetAction (string) --
The ability to share Dun and Bradstreet actions.
UseDunAndBradstreetAction (string) --
The ability to use Dun and Bradstreet actions.
HGInsightsAction (string) --
The ability to perform actions using HG Insights Agent connectors.
CreateAndUpdateHGInsightsAction (string) --
The ability to create and update HG Insights Agent actions.
ShareHGInsightsAction (string) --
The ability to share HG Insights Agent actions.
UseHGInsightsAction (string) --
The ability to use HG Insights Agent actions.
ZoomInfoAction (string) --
The ability to perform actions using ZoomInfo Agent connectors.
CreateAndUpdateZoomInfoAction (string) --
The ability to create and update ZoomInfo Agent actions.
ShareZoomInfoAction (string) --
The ability to share ZoomInfo Agent actions.
UseZoomInfoAction (string) --
The ability to use ZoomInfo Agent actions.
MoodysAction (string) --
The ability to perform actions using Moody's GenAI Ready Data connectors.
CreateAndUpdateMoodysAction (string) --
The ability to create and update Moody's GenAI Ready Data actions.
ShareMoodysAction (string) --
The ability to share Moody's GenAI Ready Data actions.
UseMoodysAction (string) --
The ability to use Moody's GenAI Ready Data actions.
BeeAction (string) --
The ability to perform actions using Bee connectors.
CreateAndUpdateBeeAction (string) --
The ability to create and update Bee actions.
ShareBeeAction (string) --
The ability to share Bee actions.
UseBeeAction (string) --
The ability to use Bee actions.
GongAction (string) --
The ability to perform actions using Gong connectors.
CreateAndUpdateGongAction (string) --
The ability to create and update Gong actions.
ShareGongAction (string) --
The ability to share Gong actions.
UseGongAction (string) --
The ability to use Gong actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
UseBrowserExtension (string) --
The ability to use Amazon Quick through the browser extension for Chrome, Firefox, and Edge.
UseWordAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Word add-in.
UseOutlookAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Outlook add-in.
UseExcelAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Excel add-in.
UsePowerpointAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft PowerPoint add-in.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
Story (string) --
The ability to perform Story-related actions.
Scenario (string) --
The ability to perform Scenario-related actions.
Trigger (string) --
The ability to manage trigger-related settings for flows and automations.
ScheduleTrigger (string) --
The ability to create, view, edit, delete, and run schedule triggers for flows and automations.
InboundEmailTrigger (string) --
The ability to create, view, edit, delete, and run inbound email triggers for flows and automations.
QuickEventTrigger (string) --
The ability to create, view, edit, delete, and run Quick event triggers for flows and automations.
FileDataSource (string) --
The ability to create, update, and share file data sources.
CreateFileDataSource (string) --
The ability to create file data sources.
UpdateFileDataSource (string) --
The ability to update file data sources.
ShareFileDataSource (string) --
The ability to share file data sources.
S3DataSource (string) --
The ability to create, update, and share Amazon S3 data sources.
CreateS3DataSource (string) --
The ability to create Amazon S3 data sources.
UpdateS3DataSource (string) --
The ability to update Amazon S3 data sources.
ShareS3DataSource (string) --
The ability to share Amazon S3 data sources.
S3AnalyticsDataSource (string) --
The ability to create, update, and share Amazon S3 Analytics data sources.
CreateS3AnalyticsDataSource (string) --
The ability to create Amazon S3 Analytics data sources.
UpdateS3AnalyticsDataSource (string) --
The ability to update Amazon S3 Analytics data sources.
ShareS3AnalyticsDataSource (string) --
The ability to share Amazon S3 Analytics data sources.
S3TablesDataSource (string) --
The ability to create, update, and share Amazon S3 Tables data sources.
CreateS3TablesDataSource (string) --
The ability to create Amazon S3 Tables data sources.
UpdateS3TablesDataSource (string) --
The ability to update Amazon S3 Tables data sources.
ShareS3TablesDataSource (string) --
The ability to share Amazon S3 Tables data sources.
AthenaDataSource (string) --
The ability to create, update, and share Amazon Athena data sources.
CreateAthenaDataSource (string) --
The ability to create Amazon Athena data sources.
UpdateAthenaDataSource (string) --
The ability to update Amazon Athena data sources.
ShareAthenaDataSource (string) --
The ability to share Amazon Athena data sources.
RdsDataSource (string) --
The ability to create, update, and share auto-discovered Amazon RDS data sources.
CreateRdsDataSource (string) --
The ability to create auto-discovered Amazon RDS data sources.
UpdateRdsDataSource (string) --
The ability to update auto-discovered Amazon RDS data sources.
ShareRdsDataSource (string) --
The ability to share auto-discovered Amazon RDS data sources.
RedshiftAutoDiscoveredDataSource (string) --
The ability to create, update, and share auto-discovered Amazon Redshift data sources.
CreateRedshiftAutoDiscoveredDataSource (string) --
The ability to create auto-discovered Amazon Redshift data sources.
UpdateRedshiftAutoDiscoveredDataSource (string) --
The ability to update auto-discovered Amazon Redshift data sources.
ShareRedshiftAutoDiscoveredDataSource (string) --
The ability to share auto-discovered Amazon Redshift data sources.
RedshiftManualDataSource (string) --
The ability to create, update, and share manually configured Amazon Redshift data sources.
CreateRedshiftManualDataSource (string) --
The ability to create manually configured Amazon Redshift data sources.
UpdateRedshiftManualDataSource (string) --
The ability to update manually configured Amazon Redshift data sources.
ShareRedshiftManualDataSource (string) --
The ability to share manually configured Amazon Redshift data sources.
OpenSearchDataSource (string) --
The ability to create, update, and share Amazon OpenSearch Service data sources.
CreateOpenSearchDataSource (string) --
The ability to create Amazon OpenSearch Service data sources.
UpdateOpenSearchDataSource (string) --
The ability to update Amazon OpenSearch Service data sources.
ShareOpenSearchDataSource (string) --
The ability to share Amazon OpenSearch Service data sources.
TimestreamDataSource (string) --
The ability to create, update, and share Amazon Timestream data sources.
CreateTimestreamDataSource (string) --
The ability to create Amazon Timestream data sources.
UpdateTimestreamDataSource (string) --
The ability to update Amazon Timestream data sources.
ShareTimestreamDataSource (string) --
The ability to share Amazon Timestream data sources.
AuroraDataSource (string) --
The ability to create, update, and share Amazon Aurora data sources.
CreateAuroraDataSource (string) --
The ability to create Amazon Aurora data sources.
UpdateAuroraDataSource (string) --
The ability to update Amazon Aurora data sources.
ShareAuroraDataSource (string) --
The ability to share Amazon Aurora data sources.
MySqlDataSource (string) --
The ability to create, update, and share MySQL data sources.
CreateMySqlDataSource (string) --
The ability to create MySQL data sources.
UpdateMySqlDataSource (string) --
The ability to update MySQL data sources.
ShareMySqlDataSource (string) --
The ability to share MySQL data sources.
PostgreSqlDataSource (string) --
The ability to create, update, and share PostgreSQL data sources.
CreatePostgreSqlDataSource (string) --
The ability to create PostgreSQL data sources.
UpdatePostgreSqlDataSource (string) --
The ability to update PostgreSQL data sources.
SharePostgreSqlDataSource (string) --
The ability to share PostgreSQL data sources.
OracleDataSource (string) --
The ability to create, update, and share Oracle data sources.
CreateOracleDataSource (string) --
The ability to create Oracle data sources.
UpdateOracleDataSource (string) --
The ability to update Oracle data sources.
ShareOracleDataSource (string) --
The ability to share Oracle data sources.
SqlServerDataSource (string) --
The ability to create, update, and share SQL Server data sources.
CreateSqlServerDataSource (string) --
The ability to create SQL Server data sources.
UpdateSqlServerDataSource (string) --
The ability to update SQL Server data sources.
ShareSqlServerDataSource (string) --
The ability to share SQL Server data sources.
MariaDbDataSource (string) --
The ability to create, update, and share MariaDB data sources.
CreateMariaDbDataSource (string) --
The ability to create MariaDB data sources.
UpdateMariaDbDataSource (string) --
The ability to update MariaDB data sources.
ShareMariaDbDataSource (string) --
The ability to share MariaDB data sources.
SnowflakeDataSource (string) --
The ability to create, update, and share Snowflake data sources.
CreateSnowflakeDataSource (string) --
The ability to create Snowflake data sources.
UpdateSnowflakeDataSource (string) --
The ability to update Snowflake data sources.
ShareSnowflakeDataSource (string) --
The ability to share Snowflake data sources.
GoogleBigQueryDataSource (string) --
The ability to create, update, and share Google BigQuery data sources.
CreateGoogleBigQueryDataSource (string) --
The ability to create Google BigQuery data sources.
UpdateGoogleBigQueryDataSource (string) --
The ability to update Google BigQuery data sources.
ShareGoogleBigQueryDataSource (string) --
The ability to share Google BigQuery data sources.
DatabricksDataSource (string) --
The ability to create, update, and share Databricks data sources.
CreateDatabricksDataSource (string) --
The ability to create Databricks data sources.
UpdateDatabricksDataSource (string) --
The ability to update Databricks data sources.
ShareDatabricksDataSource (string) --
The ability to share Databricks data sources.
StarburstDataSource (string) --
The ability to create, update, and share Starburst data sources.
CreateStarburstDataSource (string) --
The ability to create Starburst data sources.
UpdateStarburstDataSource (string) --
The ability to update Starburst data sources.
ShareStarburstDataSource (string) --
The ability to share Starburst data sources.
TrinoDataSource (string) --
The ability to create, update, and share Trino data sources.
CreateTrinoDataSource (string) --
The ability to create Trino data sources.
UpdateTrinoDataSource (string) --
The ability to update Trino data sources.
ShareTrinoDataSource (string) --
The ability to share Trino data sources.
ImpalaDataSource (string) --
The ability to create, update, and share Impala data sources.
CreateImpalaDataSource (string) --
The ability to create Impala data sources.
UpdateImpalaDataSource (string) --
The ability to update Impala data sources.
ShareImpalaDataSource (string) --
The ability to share Impala data sources.
TeradataDataSource (string) --
The ability to create, update, and share Teradata data sources.
CreateTeradataDataSource (string) --
The ability to create Teradata data sources.
UpdateTeradataDataSource (string) --
The ability to update Teradata data sources.
ShareTeradataDataSource (string) --
The ability to share Teradata data sources.
PrestoDataSource (string) --
The ability to create, update, and share Presto data sources.
CreatePrestoDataSource (string) --
The ability to create Presto data sources.
UpdatePrestoDataSource (string) --
The ability to update Presto data sources.
SharePrestoDataSource (string) --
The ability to share Presto data sources.
SparkDataSource (string) --
The ability to create, update, and share Spark data sources.
CreateSparkDataSource (string) --
The ability to create Spark data sources.
UpdateSparkDataSource (string) --
The ability to update Spark data sources.
ShareSparkDataSource (string) --
The ability to share Spark data sources.
ExasolDataSource (string) --
The ability to create, update, and share Exasol data sources.
CreateExasolDataSource (string) --
The ability to create Exasol data sources.
UpdateExasolDataSource (string) --
The ability to update Exasol data sources.
ShareExasolDataSource (string) --
The ability to share Exasol data sources.
Db2DataSource (string) --
The ability to create, update, and share Db2 data sources.
CreateDb2DataSource (string) --
The ability to create Db2 data sources.
UpdateDb2DataSource (string) --
The ability to update Db2 data sources.
ShareDb2DataSource (string) --
The ability to share Db2 data sources.
SapHanaDataSource (string) --
The ability to create, update, and share SAP HANA data sources.
CreateSapHanaDataSource (string) --
The ability to create SAP HANA data sources.
UpdateSapHanaDataSource (string) --
The ability to update SAP HANA data sources.
ShareSapHanaDataSource (string) --
The ability to share SAP HANA data sources.
DenodoDataSource (string) --
The ability to create, update, and share Denodo data sources.
CreateDenodoDataSource (string) --
The ability to create Denodo data sources.
UpdateDenodoDataSource (string) --
The ability to update Denodo data sources.
ShareDenodoDataSource (string) --
The ability to share Denodo data sources.
DremioDataSource (string) --
The ability to create, update, and share Dremio data sources.
CreateDremioDataSource (string) --
The ability to create Dremio data sources.
UpdateDremioDataSource (string) --
The ability to update Dremio data sources.
ShareDremioDataSource (string) --
The ability to share Dremio data sources.
SalesforceDataSource (string) --
The ability to create, update, and share Salesforce data sources.
CreateSalesforceDataSource (string) --
The ability to create Salesforce data sources.
UpdateSalesforceDataSource (string) --
The ability to update Salesforce data sources.
ShareSalesforceDataSource (string) --
The ability to share Salesforce data sources.
RadiantDataSource (string) --
The ability to create, update, and share Amazon QuickSight data sources.
CreateRadiantDataSource (string) --
The ability to create Amazon QuickSight data sources.
UpdateRadiantDataSource (string) --
The ability to update Amazon QuickSight data sources.
ShareRadiantDataSource (string) --
The ability to share Amazon QuickSight data sources.
PayPalDataSource (string) --
The ability to create, update, and share PayPal data sources.
CreatePayPalDataSource (string) --
The ability to create PayPal data sources.
UpdatePayPalDataSource (string) --
The ability to update PayPal data sources.
SharePayPalDataSource (string) --
The ability to share PayPal data sources.
SquareDataSource (string) --
The ability to create, update, and share Square data sources.
CreateSquareDataSource (string) --
The ability to create Square data sources.
UpdateSquareDataSource (string) --
The ability to update Square data sources.
ShareSquareDataSource (string) --
The ability to share Square data sources.
GitHubDataSource (string) --
The ability to create, update, and share GitHub data sources.
CreateGitHubDataSource (string) --
The ability to create GitHub data sources.
UpdateGitHubDataSource (string) --
The ability to update GitHub data sources.
ShareGitHubDataSource (string) --
The ability to share GitHub data sources.
TwitterDataSource (string) --
The ability to create, update, and share Twitter data sources.
CreateTwitterDataSource (string) --
The ability to create Twitter data sources.
UpdateTwitterDataSource (string) --
The ability to update Twitter data sources.
ShareTwitterDataSource (string) --
The ability to share Twitter data sources.
JiraDataSource (string) --
The ability to create, update, and share Jira data sources.
CreateJiraDataSource (string) --
The ability to create Jira data sources.
UpdateJiraDataSource (string) --
The ability to update Jira data sources.
ShareJiraDataSource (string) --
The ability to share Jira data sources.
ServiceNowDataSource (string) --
The ability to create, update, and share ServiceNow data sources.
CreateServiceNowDataSource (string) --
The ability to create ServiceNow data sources.
UpdateServiceNowDataSource (string) --
The ability to update ServiceNow data sources.
ShareServiceNowDataSource (string) --
The ability to share ServiceNow data sources.
AdobeAnalyticsDataSource (string) --
The ability to create, update, and share Adobe Analytics data sources.
CreateAdobeAnalyticsDataSource (string) --
The ability to create Adobe Analytics data sources.
UpdateAdobeAnalyticsDataSource (string) --
The ability to update Adobe Analytics data sources.
ShareAdobeAnalyticsDataSource (string) --
The ability to share Adobe Analytics data sources.
GoogleAnalyticsDataSource (string) --
The ability to create, update, and share Google Analytics data sources.
CreateGoogleAnalyticsDataSource (string) --
The ability to create Google Analytics data sources.
UpdateGoogleAnalyticsDataSource (string) --
The ability to update Google Analytics data sources.
ShareGoogleAnalyticsDataSource (string) --
The ability to share Google Analytics data sources.
GoogleSheetsDataSource (string) --
The ability to create, update, and share Google Sheets data sources.
CreateGoogleSheetsDataSource (string) --
The ability to create Google Sheets data sources.
UpdateGoogleSheetsDataSource (string) --
The ability to update Google Sheets data sources.
ShareGoogleSheetsDataSource (string) --
The ability to share Google Sheets data sources.
DocumentDbDataSource (string) --
The ability to create, update, and share Amazon DocumentDB data sources.
CreateDocumentDbDataSource (string) --
The ability to create Amazon DocumentDB data sources.
UpdateDocumentDbDataSource (string) --
The ability to update Amazon DocumentDB data sources.
ShareDocumentDbDataSource (string) --
The ability to share Amazon DocumentDB data sources.
MongoDbDataSource (string) --
The ability to create, update, and share MongoDB data sources.
CreateMongoDbDataSource (string) --
The ability to create MongoDB data sources.
UpdateMongoDbDataSource (string) --
The ability to update MongoDB data sources.
ShareMongoDbDataSource (string) --
The ability to share MongoDB data sources.
MongoAtlasDataSource (string) --
The ability to create, update, and share MongoDB Atlas data sources.
CreateMongoAtlasDataSource (string) --
The ability to create MongoDB Atlas data sources.
UpdateMongoAtlasDataSource (string) --
The ability to update MongoDB Atlas data sources.
ShareMongoAtlasDataSource (string) --
The ability to share MongoDB Atlas data sources.
DynamoDbDataSource (string) --
The ability to create, update, and share Amazon DynamoDB data sources.
CreateDynamoDbDataSource (string) --
The ability to create Amazon DynamoDB data sources.
UpdateDynamoDbDataSource (string) --
The ability to update Amazon DynamoDB data sources.
ShareDynamoDbDataSource (string) --
The ability to share Amazon DynamoDB data sources.
Governance (dict) --
The governance configuration for the custom permissions profile. When you enable governance for a category, Amazon Quick denies access to any current or new capability in that category unless you explicitly set that capability to ALLOW in Capabilities.
DefaultCategoryEffects (dict) --
A map of DefaultCategoryEffects.
(string) --
The name of a governance category. A governance category groups related capabilities so that you can apply a default effect to all capabilities in the category at once. Valid values:
AI – Capabilities related to Amazon Quick AI features.
(string) --
The default effect that Amazon Quick applies to capabilities in a governed category when you do not explicitly list those capabilities in Capabilities. Valid values:
DENY_BY_DEFAULT – Amazon Quick denies any capability access in the given category that the profile does not explicitly set to ALLOW.
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': {'RedshiftParameters': {'FederatedCatalog': 'string'}},
'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}}
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'|'S3_TABLES'|'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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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',
'CredentialStatus': 'CONNECTED'|'AUTH_FAILED'|'NOT_VERIFIED',
'LastCredentialVerifiedAt': datetime(2015, 1, 1)
},
],
'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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) --
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) --
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
CredentialStatus (string) --
The credential verification status of the data source. Valid values include:
CONNECTED – Credential validation succeeded.
AUTH_FAILED – Credential validation failed.
NOT_VERIFIED – Credential validation has not been performed.
LastCredentialVerifiedAt (datetime) --
The time that the credentials were last verified.
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.
{'OverrideParameters': {'DataSources': {'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}}}
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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'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'
},
],
'TopicsV2': [
{
'TopicId': 'string',
'Name': 'string',
'Description': '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',
]
}
},
],
'TopicsV2': [
{
'TopicIds': [
'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'
},
]
},
],
'TopicsV2': [
{
'TopicIds': [
'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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
TopicsV2 (list) --
A list of overrides for any Topic resources that are present in the asset bundle that is imported.
(dict) --
The override parameters for a single topic that is being imported.
TopicId (string) -- [REQUIRED]
The ID of the topic that you want to apply overrides to.
Name (string) --
A new name for the topic.
Description (string) --
A new description for the topic.
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) --
TopicsV2 (list) --
A list of permissions for the topics that you want to apply overrides to.
(dict) --
An object that contains a list of permissions to be applied to a list of topic IDs.
TopicIds (list) -- [REQUIRED]
A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle.
(string) --
Permissions (dict) -- [REQUIRED]
A list of permissions for the topics 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) --
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.
TopicsV2 (list) --
A list of tag overrides for any Topic 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 topic IDs.
TopicIds (list) -- [REQUIRED]
A list of topic IDs that you want to apply overrides to. You can use * to override all topics in this asset bundle.
(string) --
Tags (list) -- [REQUIRED]
A list of tags for the topics 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.
{'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}
Response {'Policy': {'Actions': {'PUBLISH'}, 'AssetTypes': {'FLOW'}}}
Updates an approval policy in Quick Sight.
See also: AWS API Documentation
Request Syntax
client.update_approval_policy(
PolicyId='string',
Name='string',
Description='string',
Actions=[
'SHARE'|'PUBLISH',
],
AssetTypes=[
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
ApplicableTo={
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
ApprovalGroups=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the approval policy to update.
string
The name of the approval policy.
string
A description of the approval policy.
list
The list of governed actions that trigger the approval workflow.
(string) --
list
The list of asset types that the approval policy applies to.
(string) --
dict
The scoping configuration that determines who the approval policy applies to.
Type (string) -- [REQUIRED]
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
list
The list of group ARNs whose members can approve requests.
(string) --
dict
Response Syntax
{
'Policy': {
'PolicyId': 'string',
'PolicyArn': 'string',
'Name': 'string',
'Description': 'string',
'Actions': [
'SHARE'|'PUBLISH',
],
'AssetTypes': [
'AGENT'|'SPACE'|'KNOWLEDGE_BASE'|'FLOW',
],
'ApplicableTo': {
'Type': 'GROUP',
'GroupArns': [
'string',
]
},
'ApprovalGroups': [
'string',
],
'CreatedAt': datetime(2015, 1, 1),
'UpdatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Policy (dict) --
The updated approval policy.
PolicyId (string) --
The unique identifier of the approval policy.
PolicyArn (string) --
The Amazon Resource Name (ARN) of the approval policy.
Name (string) --
The name of the approval policy.
Description (string) --
A description of the approval policy.
Actions (list) --
The list of governed actions that trigger the approval workflow.
(string) --
AssetTypes (list) --
The list of asset types that the approval policy applies to.
(string) --
ApplicableTo (dict) --
The scoping configuration that determines who the approval policy applies to.
Type (string) --
The type of scoping that determines which principals the approval policy applies to. Valid values are defined as follows:
GROUP: The policy applies only to principals in the groups specified by GroupArns. When you use GROUP, you must also provide a value for GroupArns.
GroupArns (list) --
The list of group ARNs that the policy applies to. Required when type is GROUP.
(string) --
ApprovalGroups (list) --
The list of group ARNs whose members can approve requests.
(string) --
CreatedAt (datetime) --
The date and time that the approval policy was created.
UpdatedAt (datetime) --
The date and time that the approval policy was last updated.
{'Capabilities': {'CreateAndUpdateLocalMCPAction': 'DENY | ALLOW',
'LocalMCPAction': 'DENY | ALLOW',
'UseLocalMCPAction': 'DENY | ALLOW'}}
Updates a custom permissions profile.
See also: AWS API Documentation
Request Syntax
client.update_custom_permissions(
AwsAccountId='string',
CustomPermissionsName='string',
Capabilities={
'ExportToCsv': 'DENY'|'ALLOW',
'ExportToExcel': 'DENY'|'ALLOW',
'ExportToPdf': 'DENY'|'ALLOW',
'PrintReports': 'DENY'|'ALLOW',
'CreateAndUpdateThemes': 'DENY'|'ALLOW',
'AddOrRunAnomalyDetectionForAnalyses': 'DENY'|'ALLOW',
'ShareAnalyses': 'DENY'|'ALLOW',
'CreateAndUpdateDatasets': 'DENY'|'ALLOW',
'ShareDatasets': 'DENY'|'ALLOW',
'SubscribeDashboardEmailReports': 'DENY'|'ALLOW',
'CreateAndUpdateDashboardEmailReports': 'DENY'|'ALLOW',
'ShareDashboards': 'DENY'|'ALLOW',
'CreateAndUpdateThresholdAlerts': 'DENY'|'ALLOW',
'RenameSharedFolders': 'DENY'|'ALLOW',
'CreateSharedFolders': 'DENY'|'ALLOW',
'CreateAndUpdateDataSources': 'DENY'|'ALLOW',
'ShareDataSources': 'DENY'|'ALLOW',
'ViewAccountSPICECapacity': 'DENY'|'ALLOW',
'CreateSPICEDataset': 'DENY'|'ALLOW',
'ExportToPdfInScheduledReports': 'DENY'|'ALLOW',
'ExportToCsvInScheduledReports': 'DENY'|'ALLOW',
'ExportToExcelInScheduledReports': 'DENY'|'ALLOW',
'IncludeContentInScheduledReportsEmail': 'DENY'|'ALLOW',
'Dashboard': 'DENY'|'ALLOW',
'Analysis': 'DENY'|'ALLOW',
'Automate': 'DENY'|'ALLOW',
'Flow': 'DENY'|'ALLOW',
'Apps': 'DENY'|'ALLOW',
'CreateAndUpdateApps': 'DENY'|'ALLOW',
'ShareApps': 'DENY'|'ALLOW',
'InvokeAppsAIInference': 'DENY'|'ALLOW',
'AccessAppsNativeDataStore': 'DENY'|'ALLOW',
'PublishWithoutApproval': 'DENY'|'ALLOW',
'UseBedrockModels': 'DENY'|'ALLOW',
'PerformFlowUiTask': 'DENY'|'ALLOW',
'ApproveFlowShareRequests': 'DENY'|'ALLOW',
'UseAgentWebSearch': 'DENY'|'ALLOW',
'KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateKnowledgeBases': 'DENY'|'ALLOW',
'ShareKnowledgeBases': 'DENY'|'ALLOW',
'SharePointKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointKnowledgeBase': 'DENY'|'ALLOW',
'ShareSharePointKnowledgeBase': 'DENY'|'ALLOW',
'UseSharePointKnowledgeBase': 'DENY'|'ALLOW',
'GoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseGoogleDriveKnowledgeBase': 'DENY'|'ALLOW',
'WebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'ShareWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'UseWebCrawlerKnowledgeBase': 'DENY'|'ALLOW',
'S3KnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateS3KnowledgeBase': 'DENY'|'ALLOW',
'ShareS3KnowledgeBase': 'DENY'|'ALLOW',
'UseS3KnowledgeBase': 'DENY'|'ALLOW',
'ConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'ShareConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'UseConfluenceKnowledgeBase': 'DENY'|'ALLOW',
'OneDriveKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'ShareOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'UseOneDriveKnowledgeBase': 'DENY'|'ALLOW',
'QBusinessKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'ShareQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'UseQBusinessKnowledgeBase': 'DENY'|'ALLOW',
'BedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'ShareBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'UseBedrockManagedKnowledgeBase': 'DENY'|'ALLOW',
'BoxKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateBoxKnowledgeBase': 'DENY'|'ALLOW',
'ShareBoxKnowledgeBase': 'DENY'|'ALLOW',
'UseBoxKnowledgeBase': 'DENY'|'ALLOW',
'IDCKnowledgeBase': 'DENY'|'ALLOW',
'CreateAndUpdateIDCKnowledgeBase': 'DENY'|'ALLOW',
'ShareIDCKnowledgeBase': 'DENY'|'ALLOW',
'UseIDCKnowledgeBase': 'DENY'|'ALLOW',
'Action': 'DENY'|'ALLOW',
'GenericHTTPAction': 'DENY'|'ALLOW',
'CreateAndUpdateGenericHTTPAction': 'DENY'|'ALLOW',
'ShareGenericHTTPAction': 'DENY'|'ALLOW',
'UseGenericHTTPAction': 'DENY'|'ALLOW',
'AsanaAction': 'DENY'|'ALLOW',
'CreateAndUpdateAsanaAction': 'DENY'|'ALLOW',
'ShareAsanaAction': 'DENY'|'ALLOW',
'UseAsanaAction': 'DENY'|'ALLOW',
'SlackAction': 'DENY'|'ALLOW',
'CreateAndUpdateSlackAction': 'DENY'|'ALLOW',
'ShareSlackAction': 'DENY'|'ALLOW',
'UseSlackAction': 'DENY'|'ALLOW',
'ServiceNowAction': 'DENY'|'ALLOW',
'CreateAndUpdateServiceNowAction': 'DENY'|'ALLOW',
'ShareServiceNowAction': 'DENY'|'ALLOW',
'UseServiceNowAction': 'DENY'|'ALLOW',
'SalesforceAction': 'DENY'|'ALLOW',
'CreateAndUpdateSalesforceAction': 'DENY'|'ALLOW',
'ShareSalesforceAction': 'DENY'|'ALLOW',
'UseSalesforceAction': 'DENY'|'ALLOW',
'MSExchangeAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSExchangeAction': 'DENY'|'ALLOW',
'ShareMSExchangeAction': 'DENY'|'ALLOW',
'UseMSExchangeAction': 'DENY'|'ALLOW',
'PagerDutyAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAction': 'DENY'|'ALLOW',
'SharePagerDutyAction': 'DENY'|'ALLOW',
'UsePagerDutyAction': 'DENY'|'ALLOW',
'JiraAction': 'DENY'|'ALLOW',
'CreateAndUpdateJiraAction': 'DENY'|'ALLOW',
'ShareJiraAction': 'DENY'|'ALLOW',
'UseJiraAction': 'DENY'|'ALLOW',
'ConfluenceAction': 'DENY'|'ALLOW',
'CreateAndUpdateConfluenceAction': 'DENY'|'ALLOW',
'ShareConfluenceAction': 'DENY'|'ALLOW',
'UseConfluenceAction': 'DENY'|'ALLOW',
'OneDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneDriveAction': 'DENY'|'ALLOW',
'ShareOneDriveAction': 'DENY'|'ALLOW',
'UseOneDriveAction': 'DENY'|'ALLOW',
'SharePointAction': 'DENY'|'ALLOW',
'CreateAndUpdateSharePointAction': 'DENY'|'ALLOW',
'ShareSharePointAction': 'DENY'|'ALLOW',
'UseSharePointAction': 'DENY'|'ALLOW',
'MSTeamsAction': 'DENY'|'ALLOW',
'CreateAndUpdateMSTeamsAction': 'DENY'|'ALLOW',
'ShareMSTeamsAction': 'DENY'|'ALLOW',
'UseMSTeamsAction': 'DENY'|'ALLOW',
'GoogleCalendarAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleCalendarAction': 'DENY'|'ALLOW',
'ShareGoogleCalendarAction': 'DENY'|'ALLOW',
'UseGoogleCalendarAction': 'DENY'|'ALLOW',
'ZendeskAction': 'DENY'|'ALLOW',
'CreateAndUpdateZendeskAction': 'DENY'|'ALLOW',
'ShareZendeskAction': 'DENY'|'ALLOW',
'UseZendeskAction': 'DENY'|'ALLOW',
'SmartsheetAction': 'DENY'|'ALLOW',
'CreateAndUpdateSmartsheetAction': 'DENY'|'ALLOW',
'ShareSmartsheetAction': 'DENY'|'ALLOW',
'UseSmartsheetAction': 'DENY'|'ALLOW',
'SAPBusinessPartnerAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'ShareSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'UseSAPBusinessPartnerAction': 'DENY'|'ALLOW',
'SAPProductMasterDataAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPProductMasterDataAction': 'DENY'|'ALLOW',
'ShareSAPProductMasterDataAction': 'DENY'|'ALLOW',
'UseSAPProductMasterDataAction': 'DENY'|'ALLOW',
'SAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'ShareSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'UseSAPPhysicalInventoryAction': 'DENY'|'ALLOW',
'SAPBillOfMaterialAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'ShareSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'UseSAPBillOfMaterialAction': 'DENY'|'ALLOW',
'SAPMaterialStockAction': 'DENY'|'ALLOW',
'CreateAndUpdateSAPMaterialStockAction': 'DENY'|'ALLOW',
'ShareSAPMaterialStockAction': 'DENY'|'ALLOW',
'UseSAPMaterialStockAction': 'DENY'|'ALLOW',
'FactSetAction': 'DENY'|'ALLOW',
'CreateAndUpdateFactSetAction': 'DENY'|'ALLOW',
'ShareFactSetAction': 'DENY'|'ALLOW',
'UseFactSetAction': 'DENY'|'ALLOW',
'AmazonSThreeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonSThreeAction': 'DENY'|'ALLOW',
'ShareAmazonSThreeAction': 'DENY'|'ALLOW',
'UseAmazonSThreeAction': 'DENY'|'ALLOW',
'TextractAction': 'DENY'|'ALLOW',
'CreateAndUpdateTextractAction': 'DENY'|'ALLOW',
'ShareTextractAction': 'DENY'|'ALLOW',
'UseTextractAction': 'DENY'|'ALLOW',
'ComprehendAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendAction': 'DENY'|'ALLOW',
'ShareComprehendAction': 'DENY'|'ALLOW',
'UseComprehendAction': 'DENY'|'ALLOW',
'ComprehendMedicalAction': 'DENY'|'ALLOW',
'CreateAndUpdateComprehendMedicalAction': 'DENY'|'ALLOW',
'ShareComprehendMedicalAction': 'DENY'|'ALLOW',
'UseComprehendMedicalAction': 'DENY'|'ALLOW',
'AmazonBedrockARSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockARSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockARSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockARSAction': 'DENY'|'ALLOW',
'AmazonBedrockFSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockFSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockFSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockFSAction': 'DENY'|'ALLOW',
'AmazonBedrockKRSAction': 'DENY'|'ALLOW',
'CreateAndUpdateAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'ShareAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'UseAmazonBedrockKRSAction': 'DENY'|'ALLOW',
'MCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateMCPAction': 'DENY'|'ALLOW',
'ShareMCPAction': 'DENY'|'ALLOW',
'UseMCPAction': 'DENY'|'ALLOW',
'LocalMCPAction': 'DENY'|'ALLOW',
'CreateAndUpdateLocalMCPAction': 'DENY'|'ALLOW',
'UseLocalMCPAction': 'DENY'|'ALLOW',
'OpenAPIAction': 'DENY'|'ALLOW',
'CreateAndUpdateOpenAPIAction': 'DENY'|'ALLOW',
'ShareOpenAPIAction': 'DENY'|'ALLOW',
'UseOpenAPIAction': 'DENY'|'ALLOW',
'SandPGMIAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGMIAction': 'DENY'|'ALLOW',
'ShareSandPGMIAction': 'DENY'|'ALLOW',
'UseSandPGMIAction': 'DENY'|'ALLOW',
'SandPGlobalEnergyAction': 'DENY'|'ALLOW',
'CreateAndUpdateSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'ShareSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'UseSandPGlobalEnergyAction': 'DENY'|'ALLOW',
'BambooHRAction': 'DENY'|'ALLOW',
'CreateAndUpdateBambooHRAction': 'DENY'|'ALLOW',
'ShareBambooHRAction': 'DENY'|'ALLOW',
'UseBambooHRAction': 'DENY'|'ALLOW',
'BoxAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateBoxAgentAction': 'DENY'|'ALLOW',
'ShareBoxAgentAction': 'DENY'|'ALLOW',
'UseBoxAgentAction': 'DENY'|'ALLOW',
'CanvaAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateCanvaAgentAction': 'DENY'|'ALLOW',
'ShareCanvaAgentAction': 'DENY'|'ALLOW',
'UseCanvaAgentAction': 'DENY'|'ALLOW',
'GithubAction': 'DENY'|'ALLOW',
'CreateAndUpdateGithubAction': 'DENY'|'ALLOW',
'ShareGithubAction': 'DENY'|'ALLOW',
'UseGithubAction': 'DENY'|'ALLOW',
'NotionAction': 'DENY'|'ALLOW',
'CreateAndUpdateNotionAction': 'DENY'|'ALLOW',
'ShareNotionAction': 'DENY'|'ALLOW',
'UseNotionAction': 'DENY'|'ALLOW',
'LinearAction': 'DENY'|'ALLOW',
'CreateAndUpdateLinearAction': 'DENY'|'ALLOW',
'ShareLinearAction': 'DENY'|'ALLOW',
'UseLinearAction': 'DENY'|'ALLOW',
'HuggingFaceAction': 'DENY'|'ALLOW',
'CreateAndUpdateHuggingFaceAction': 'DENY'|'ALLOW',
'ShareHuggingFaceAction': 'DENY'|'ALLOW',
'UseHuggingFaceAction': 'DENY'|'ALLOW',
'MondayAction': 'DENY'|'ALLOW',
'CreateAndUpdateMondayAction': 'DENY'|'ALLOW',
'ShareMondayAction': 'DENY'|'ALLOW',
'UseMondayAction': 'DENY'|'ALLOW',
'HubspotAction': 'DENY'|'ALLOW',
'CreateAndUpdateHubspotAction': 'DENY'|'ALLOW',
'ShareHubspotAction': 'DENY'|'ALLOW',
'UseHubspotAction': 'DENY'|'ALLOW',
'IntercomAction': 'DENY'|'ALLOW',
'CreateAndUpdateIntercomAction': 'DENY'|'ALLOW',
'ShareIntercomAction': 'DENY'|'ALLOW',
'UseIntercomAction': 'DENY'|'ALLOW',
'NewRelicAction': 'DENY'|'ALLOW',
'CreateAndUpdateNewRelicAction': 'DENY'|'ALLOW',
'ShareNewRelicAction': 'DENY'|'ALLOW',
'UseNewRelicAction': 'DENY'|'ALLOW',
'PagerDutyAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdatePagerDutyAgentAction': 'DENY'|'ALLOW',
'SharePagerDutyAgentAction': 'DENY'|'ALLOW',
'UsePagerDutyAgentAction': 'DENY'|'ALLOW',
'VisierAgentAction': 'DENY'|'ALLOW',
'CreateAndUpdateVisierAgentAction': 'DENY'|'ALLOW',
'ShareVisierAgentAction': 'DENY'|'ALLOW',
'UseVisierAgentAction': 'DENY'|'ALLOW',
'ZoomAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomAction': 'DENY'|'ALLOW',
'ShareZoomAction': 'DENY'|'ALLOW',
'UseZoomAction': 'DENY'|'ALLOW',
'SnowFlakeAction': 'DENY'|'ALLOW',
'CreateAndUpdateSnowFlakeAction': 'DENY'|'ALLOW',
'ShareSnowFlakeAction': 'DENY'|'ALLOW',
'UseSnowFlakeAction': 'DENY'|'ALLOW',
'ZapierAction': 'DENY'|'ALLOW',
'CreateAndUpdateZapierAction': 'DENY'|'ALLOW',
'ShareZapierAction': 'DENY'|'ALLOW',
'UseZapierAction': 'DENY'|'ALLOW',
'AirtableAction': 'DENY'|'ALLOW',
'CreateAndUpdateAirtableAction': 'DENY'|'ALLOW',
'ShareAirtableAction': 'DENY'|'ALLOW',
'UseAirtableAction': 'DENY'|'ALLOW',
'DropboxAction': 'DENY'|'ALLOW',
'CreateAndUpdateDropboxAction': 'DENY'|'ALLOW',
'ShareDropboxAction': 'DENY'|'ALLOW',
'UseDropboxAction': 'DENY'|'ALLOW',
'GmailAction': 'DENY'|'ALLOW',
'CreateAndUpdateGmailAction': 'DENY'|'ALLOW',
'ShareGmailAction': 'DENY'|'ALLOW',
'UseGmailAction': 'DENY'|'ALLOW',
'GoogleAnalyticsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleAnalyticsAction': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsAction': 'DENY'|'ALLOW',
'UseGoogleAnalyticsAction': 'DENY'|'ALLOW',
'GoogleDocsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDocsAction': 'DENY'|'ALLOW',
'ShareGoogleDocsAction': 'DENY'|'ALLOW',
'UseGoogleDocsAction': 'DENY'|'ALLOW',
'GoogleDriveAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleDriveAction': 'DENY'|'ALLOW',
'ShareGoogleDriveAction': 'DENY'|'ALLOW',
'UseGoogleDriveAction': 'DENY'|'ALLOW',
'GoogleMeetAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleMeetAction': 'DENY'|'ALLOW',
'ShareGoogleMeetAction': 'DENY'|'ALLOW',
'UseGoogleMeetAction': 'DENY'|'ALLOW',
'GoogleSheetsAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSheetsAction': 'DENY'|'ALLOW',
'ShareGoogleSheetsAction': 'DENY'|'ALLOW',
'UseGoogleSheetsAction': 'DENY'|'ALLOW',
'GoogleSlidesAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleSlidesAction': 'DENY'|'ALLOW',
'ShareGoogleSlidesAction': 'DENY'|'ALLOW',
'UseGoogleSlidesAction': 'DENY'|'ALLOW',
'QuickBooksAction': 'DENY'|'ALLOW',
'CreateAndUpdateQuickBooksAction': 'DENY'|'ALLOW',
'ShareQuickBooksAction': 'DENY'|'ALLOW',
'UseQuickBooksAction': 'DENY'|'ALLOW',
'FigmaAction': 'DENY'|'ALLOW',
'CreateAndUpdateFigmaAction': 'DENY'|'ALLOW',
'ShareFigmaAction': 'DENY'|'ALLOW',
'UseFigmaAction': 'DENY'|'ALLOW',
'WhatsAppAction': 'DENY'|'ALLOW',
'CreateAndUpdateWhatsAppAction': 'DENY'|'ALLOW',
'ShareWhatsAppAction': 'DENY'|'ALLOW',
'UseWhatsAppAction': 'DENY'|'ALLOW',
'GoogleChatAction': 'DENY'|'ALLOW',
'CreateAndUpdateGoogleChatAction': 'DENY'|'ALLOW',
'ShareGoogleChatAction': 'DENY'|'ALLOW',
'UseGoogleChatAction': 'DENY'|'ALLOW',
'OneNoteAction': 'DENY'|'ALLOW',
'CreateAndUpdateOneNoteAction': 'DENY'|'ALLOW',
'ShareOneNoteAction': 'DENY'|'ALLOW',
'UseOneNoteAction': 'DENY'|'ALLOW',
'ShopifyAction': 'DENY'|'ALLOW',
'CreateAndUpdateShopifyAction': 'DENY'|'ALLOW',
'ShareShopifyAction': 'DENY'|'ALLOW',
'UseShopifyAction': 'DENY'|'ALLOW',
'AdobeAction': 'DENY'|'ALLOW',
'CreateAndUpdateAdobeAction': 'DENY'|'ALLOW',
'ShareAdobeAction': 'DENY'|'ALLOW',
'UseAdobeAction': 'DENY'|'ALLOW',
'CiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'ShareCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'UseCiscoWebexVidcastAction': 'DENY'|'ALLOW',
'CiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'CreateAndUpdateCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'ShareCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'UseCiscoWebexMeetingsAction': 'DENY'|'ALLOW',
'DunAndBradstreetAction': 'DENY'|'ALLOW',
'CreateAndUpdateDunAndBradstreetAction': 'DENY'|'ALLOW',
'ShareDunAndBradstreetAction': 'DENY'|'ALLOW',
'UseDunAndBradstreetAction': 'DENY'|'ALLOW',
'HGInsightsAction': 'DENY'|'ALLOW',
'CreateAndUpdateHGInsightsAction': 'DENY'|'ALLOW',
'ShareHGInsightsAction': 'DENY'|'ALLOW',
'UseHGInsightsAction': 'DENY'|'ALLOW',
'ZoomInfoAction': 'DENY'|'ALLOW',
'CreateAndUpdateZoomInfoAction': 'DENY'|'ALLOW',
'ShareZoomInfoAction': 'DENY'|'ALLOW',
'UseZoomInfoAction': 'DENY'|'ALLOW',
'MoodysAction': 'DENY'|'ALLOW',
'CreateAndUpdateMoodysAction': 'DENY'|'ALLOW',
'ShareMoodysAction': 'DENY'|'ALLOW',
'UseMoodysAction': 'DENY'|'ALLOW',
'BeeAction': 'DENY'|'ALLOW',
'CreateAndUpdateBeeAction': 'DENY'|'ALLOW',
'ShareBeeAction': 'DENY'|'ALLOW',
'UseBeeAction': 'DENY'|'ALLOW',
'GongAction': 'DENY'|'ALLOW',
'CreateAndUpdateGongAction': 'DENY'|'ALLOW',
'ShareGongAction': 'DENY'|'ALLOW',
'UseGongAction': 'DENY'|'ALLOW',
'Topic': 'DENY'|'ALLOW',
'EditVisualWithQ': 'DENY'|'ALLOW',
'BuildCalculatedFieldWithQ': 'DENY'|'ALLOW',
'CreateDashboardExecutiveSummaryWithQ': 'DENY'|'ALLOW',
'Space': 'DENY'|'ALLOW',
'CreateSpaces': 'DENY'|'ALLOW',
'ShareSpaces': 'DENY'|'ALLOW',
'ChatAgent': 'DENY'|'ALLOW',
'CreateChatAgents': 'DENY'|'ALLOW',
'ShareChatAgents': 'DENY'|'ALLOW',
'Research': 'DENY'|'ALLOW',
'SelfUpgradeUserRole': 'DENY'|'ALLOW',
'Extension': 'DENY'|'ALLOW',
'UseBrowserExtension': 'DENY'|'ALLOW',
'UseWordAddInExtension': 'DENY'|'ALLOW',
'UseOutlookAddInExtension': 'DENY'|'ALLOW',
'UseExcelAddInExtension': 'DENY'|'ALLOW',
'UsePowerpointAddInExtension': 'DENY'|'ALLOW',
'ManageSharedFolders': 'DENY'|'ALLOW',
'GenerateAnalyses': 'DENY'|'ALLOW',
'Story': 'DENY'|'ALLOW',
'Scenario': 'DENY'|'ALLOW',
'Trigger': 'DENY'|'ALLOW',
'ScheduleTrigger': 'DENY'|'ALLOW',
'InboundEmailTrigger': 'DENY'|'ALLOW',
'QuickEventTrigger': 'DENY'|'ALLOW',
'FileDataSource': 'DENY'|'ALLOW',
'CreateFileDataSource': 'DENY'|'ALLOW',
'UpdateFileDataSource': 'DENY'|'ALLOW',
'ShareFileDataSource': 'DENY'|'ALLOW',
'S3DataSource': 'DENY'|'ALLOW',
'CreateS3DataSource': 'DENY'|'ALLOW',
'UpdateS3DataSource': 'DENY'|'ALLOW',
'ShareS3DataSource': 'DENY'|'ALLOW',
'S3AnalyticsDataSource': 'DENY'|'ALLOW',
'CreateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateS3AnalyticsDataSource': 'DENY'|'ALLOW',
'ShareS3AnalyticsDataSource': 'DENY'|'ALLOW',
'S3TablesDataSource': 'DENY'|'ALLOW',
'CreateS3TablesDataSource': 'DENY'|'ALLOW',
'UpdateS3TablesDataSource': 'DENY'|'ALLOW',
'ShareS3TablesDataSource': 'DENY'|'ALLOW',
'AthenaDataSource': 'DENY'|'ALLOW',
'CreateAthenaDataSource': 'DENY'|'ALLOW',
'UpdateAthenaDataSource': 'DENY'|'ALLOW',
'ShareAthenaDataSource': 'DENY'|'ALLOW',
'RdsDataSource': 'DENY'|'ALLOW',
'CreateRdsDataSource': 'DENY'|'ALLOW',
'UpdateRdsDataSource': 'DENY'|'ALLOW',
'ShareRdsDataSource': 'DENY'|'ALLOW',
'RedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'CreateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'ShareRedshiftAutoDiscoveredDataSource': 'DENY'|'ALLOW',
'RedshiftManualDataSource': 'DENY'|'ALLOW',
'CreateRedshiftManualDataSource': 'DENY'|'ALLOW',
'UpdateRedshiftManualDataSource': 'DENY'|'ALLOW',
'ShareRedshiftManualDataSource': 'DENY'|'ALLOW',
'OpenSearchDataSource': 'DENY'|'ALLOW',
'CreateOpenSearchDataSource': 'DENY'|'ALLOW',
'UpdateOpenSearchDataSource': 'DENY'|'ALLOW',
'ShareOpenSearchDataSource': 'DENY'|'ALLOW',
'TimestreamDataSource': 'DENY'|'ALLOW',
'CreateTimestreamDataSource': 'DENY'|'ALLOW',
'UpdateTimestreamDataSource': 'DENY'|'ALLOW',
'ShareTimestreamDataSource': 'DENY'|'ALLOW',
'AuroraDataSource': 'DENY'|'ALLOW',
'CreateAuroraDataSource': 'DENY'|'ALLOW',
'UpdateAuroraDataSource': 'DENY'|'ALLOW',
'ShareAuroraDataSource': 'DENY'|'ALLOW',
'MySqlDataSource': 'DENY'|'ALLOW',
'CreateMySqlDataSource': 'DENY'|'ALLOW',
'UpdateMySqlDataSource': 'DENY'|'ALLOW',
'ShareMySqlDataSource': 'DENY'|'ALLOW',
'PostgreSqlDataSource': 'DENY'|'ALLOW',
'CreatePostgreSqlDataSource': 'DENY'|'ALLOW',
'UpdatePostgreSqlDataSource': 'DENY'|'ALLOW',
'SharePostgreSqlDataSource': 'DENY'|'ALLOW',
'OracleDataSource': 'DENY'|'ALLOW',
'CreateOracleDataSource': 'DENY'|'ALLOW',
'UpdateOracleDataSource': 'DENY'|'ALLOW',
'ShareOracleDataSource': 'DENY'|'ALLOW',
'SqlServerDataSource': 'DENY'|'ALLOW',
'CreateSqlServerDataSource': 'DENY'|'ALLOW',
'UpdateSqlServerDataSource': 'DENY'|'ALLOW',
'ShareSqlServerDataSource': 'DENY'|'ALLOW',
'MariaDbDataSource': 'DENY'|'ALLOW',
'CreateMariaDbDataSource': 'DENY'|'ALLOW',
'UpdateMariaDbDataSource': 'DENY'|'ALLOW',
'ShareMariaDbDataSource': 'DENY'|'ALLOW',
'SnowflakeDataSource': 'DENY'|'ALLOW',
'CreateSnowflakeDataSource': 'DENY'|'ALLOW',
'UpdateSnowflakeDataSource': 'DENY'|'ALLOW',
'ShareSnowflakeDataSource': 'DENY'|'ALLOW',
'GoogleBigQueryDataSource': 'DENY'|'ALLOW',
'CreateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'UpdateGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'ShareGoogleBigQueryDataSource': 'DENY'|'ALLOW',
'DatabricksDataSource': 'DENY'|'ALLOW',
'CreateDatabricksDataSource': 'DENY'|'ALLOW',
'UpdateDatabricksDataSource': 'DENY'|'ALLOW',
'ShareDatabricksDataSource': 'DENY'|'ALLOW',
'StarburstDataSource': 'DENY'|'ALLOW',
'CreateStarburstDataSource': 'DENY'|'ALLOW',
'UpdateStarburstDataSource': 'DENY'|'ALLOW',
'ShareStarburstDataSource': 'DENY'|'ALLOW',
'TrinoDataSource': 'DENY'|'ALLOW',
'CreateTrinoDataSource': 'DENY'|'ALLOW',
'UpdateTrinoDataSource': 'DENY'|'ALLOW',
'ShareTrinoDataSource': 'DENY'|'ALLOW',
'ImpalaDataSource': 'DENY'|'ALLOW',
'CreateImpalaDataSource': 'DENY'|'ALLOW',
'UpdateImpalaDataSource': 'DENY'|'ALLOW',
'ShareImpalaDataSource': 'DENY'|'ALLOW',
'TeradataDataSource': 'DENY'|'ALLOW',
'CreateTeradataDataSource': 'DENY'|'ALLOW',
'UpdateTeradataDataSource': 'DENY'|'ALLOW',
'ShareTeradataDataSource': 'DENY'|'ALLOW',
'PrestoDataSource': 'DENY'|'ALLOW',
'CreatePrestoDataSource': 'DENY'|'ALLOW',
'UpdatePrestoDataSource': 'DENY'|'ALLOW',
'SharePrestoDataSource': 'DENY'|'ALLOW',
'SparkDataSource': 'DENY'|'ALLOW',
'CreateSparkDataSource': 'DENY'|'ALLOW',
'UpdateSparkDataSource': 'DENY'|'ALLOW',
'ShareSparkDataSource': 'DENY'|'ALLOW',
'ExasolDataSource': 'DENY'|'ALLOW',
'CreateExasolDataSource': 'DENY'|'ALLOW',
'UpdateExasolDataSource': 'DENY'|'ALLOW',
'ShareExasolDataSource': 'DENY'|'ALLOW',
'Db2DataSource': 'DENY'|'ALLOW',
'CreateDb2DataSource': 'DENY'|'ALLOW',
'UpdateDb2DataSource': 'DENY'|'ALLOW',
'ShareDb2DataSource': 'DENY'|'ALLOW',
'SapHanaDataSource': 'DENY'|'ALLOW',
'CreateSapHanaDataSource': 'DENY'|'ALLOW',
'UpdateSapHanaDataSource': 'DENY'|'ALLOW',
'ShareSapHanaDataSource': 'DENY'|'ALLOW',
'DenodoDataSource': 'DENY'|'ALLOW',
'CreateDenodoDataSource': 'DENY'|'ALLOW',
'UpdateDenodoDataSource': 'DENY'|'ALLOW',
'ShareDenodoDataSource': 'DENY'|'ALLOW',
'DremioDataSource': 'DENY'|'ALLOW',
'CreateDremioDataSource': 'DENY'|'ALLOW',
'UpdateDremioDataSource': 'DENY'|'ALLOW',
'ShareDremioDataSource': 'DENY'|'ALLOW',
'SalesforceDataSource': 'DENY'|'ALLOW',
'CreateSalesforceDataSource': 'DENY'|'ALLOW',
'UpdateSalesforceDataSource': 'DENY'|'ALLOW',
'ShareSalesforceDataSource': 'DENY'|'ALLOW',
'RadiantDataSource': 'DENY'|'ALLOW',
'CreateRadiantDataSource': 'DENY'|'ALLOW',
'UpdateRadiantDataSource': 'DENY'|'ALLOW',
'ShareRadiantDataSource': 'DENY'|'ALLOW',
'PayPalDataSource': 'DENY'|'ALLOW',
'CreatePayPalDataSource': 'DENY'|'ALLOW',
'UpdatePayPalDataSource': 'DENY'|'ALLOW',
'SharePayPalDataSource': 'DENY'|'ALLOW',
'SquareDataSource': 'DENY'|'ALLOW',
'CreateSquareDataSource': 'DENY'|'ALLOW',
'UpdateSquareDataSource': 'DENY'|'ALLOW',
'ShareSquareDataSource': 'DENY'|'ALLOW',
'GitHubDataSource': 'DENY'|'ALLOW',
'CreateGitHubDataSource': 'DENY'|'ALLOW',
'UpdateGitHubDataSource': 'DENY'|'ALLOW',
'ShareGitHubDataSource': 'DENY'|'ALLOW',
'TwitterDataSource': 'DENY'|'ALLOW',
'CreateTwitterDataSource': 'DENY'|'ALLOW',
'UpdateTwitterDataSource': 'DENY'|'ALLOW',
'ShareTwitterDataSource': 'DENY'|'ALLOW',
'JiraDataSource': 'DENY'|'ALLOW',
'CreateJiraDataSource': 'DENY'|'ALLOW',
'UpdateJiraDataSource': 'DENY'|'ALLOW',
'ShareJiraDataSource': 'DENY'|'ALLOW',
'ServiceNowDataSource': 'DENY'|'ALLOW',
'CreateServiceNowDataSource': 'DENY'|'ALLOW',
'UpdateServiceNowDataSource': 'DENY'|'ALLOW',
'ShareServiceNowDataSource': 'DENY'|'ALLOW',
'AdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareAdobeAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'CreateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'ShareGoogleAnalyticsDataSource': 'DENY'|'ALLOW',
'GoogleSheetsDataSource': 'DENY'|'ALLOW',
'CreateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'UpdateGoogleSheetsDataSource': 'DENY'|'ALLOW',
'ShareGoogleSheetsDataSource': 'DENY'|'ALLOW',
'DocumentDbDataSource': 'DENY'|'ALLOW',
'CreateDocumentDbDataSource': 'DENY'|'ALLOW',
'UpdateDocumentDbDataSource': 'DENY'|'ALLOW',
'ShareDocumentDbDataSource': 'DENY'|'ALLOW',
'MongoDbDataSource': 'DENY'|'ALLOW',
'CreateMongoDbDataSource': 'DENY'|'ALLOW',
'UpdateMongoDbDataSource': 'DENY'|'ALLOW',
'ShareMongoDbDataSource': 'DENY'|'ALLOW',
'MongoAtlasDataSource': 'DENY'|'ALLOW',
'CreateMongoAtlasDataSource': 'DENY'|'ALLOW',
'UpdateMongoAtlasDataSource': 'DENY'|'ALLOW',
'ShareMongoAtlasDataSource': 'DENY'|'ALLOW',
'DynamoDbDataSource': 'DENY'|'ALLOW',
'CreateDynamoDbDataSource': 'DENY'|'ALLOW',
'UpdateDynamoDbDataSource': 'DENY'|'ALLOW',
'ShareDynamoDbDataSource': 'DENY'|'ALLOW'
},
Governance={
'DefaultCategoryEffects': {
'string': 'DENY_BY_DEFAULT'
}
}
)
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.
Apps (string) --
The ability to perform apps-related actions.
CreateAndUpdateApps (string) --
The ability to create or update apps.
ShareApps (string) --
The ability to share apps with other users.
InvokeAppsAIInference (string) --
The ability to add and invoke AI inference in new and existing apps.
AccessAppsNativeDataStore (string) --
The ability to access the native data store for new and existing apps.
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.
ApproveFlowShareRequests (string) --
The ability to review and approve sharing requests of Flows.
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.
CreateAndUpdateKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareKnowledgeBases (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
SharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseSharePointKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
GoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseGoogleDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
WebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseWebCrawlerKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
S3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseS3KnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseConfluenceKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
OneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseOneDriveKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
QBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseQBusinessKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBedrockManagedKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
BoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseBoxKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
IDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
CreateAndUpdateIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
ShareIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
UseIDCKnowledgeBase (string) --
The permission state of a capability in a custom permissions profile. Valid values:
DENY – Amazon Quick denies this capability for users assigned to the profile.
ALLOW – Amazon Quick grants this capability to users assigned to the profile. This value is only relevant when governance is enabled for the capability's category. Without governance, the default effect is always ALLOW. In a governed category, this value overrides the category-level deny-by-default behavior for that capability only.
Action (string) --
The ability to perform actions in external services through Action connectors. Actions allow users to interact with third-party systems.
GenericHTTPAction (string) --
The ability to perform actions using REST API connection connectors.
CreateAndUpdateGenericHTTPAction (string) --
The ability to create and update REST API connection actions.
ShareGenericHTTPAction (string) --
The ability to share REST API connection actions.
UseGenericHTTPAction (string) --
The ability to use REST API connection actions.
AsanaAction (string) --
The ability to perform actions using Asana connectors.
CreateAndUpdateAsanaAction (string) --
The ability to create and update Asana actions.
ShareAsanaAction (string) --
The ability to share Asana actions.
UseAsanaAction (string) --
The ability to use Asana actions.
SlackAction (string) --
The ability to perform actions using Slack connectors.
CreateAndUpdateSlackAction (string) --
The ability to create and update Slack actions.
ShareSlackAction (string) --
The ability to share Slack actions.
UseSlackAction (string) --
The ability to use Slack actions.
ServiceNowAction (string) --
The ability to perform actions using ServiceNow connectors.
CreateAndUpdateServiceNowAction (string) --
The ability to create and update ServiceNow actions.
ShareServiceNowAction (string) --
The ability to share ServiceNow actions.
UseServiceNowAction (string) --
The ability to use ServiceNow actions.
SalesforceAction (string) --
The ability to perform actions using Salesforce connectors.
CreateAndUpdateSalesforceAction (string) --
The ability to create and update Salesforce actions.
ShareSalesforceAction (string) --
The ability to share Salesforce actions.
UseSalesforceAction (string) --
The ability to use Salesforce actions.
MSExchangeAction (string) --
The ability to perform actions using Microsoft Outlook connectors.
CreateAndUpdateMSExchangeAction (string) --
The ability to create and update Microsoft Outlook actions.
ShareMSExchangeAction (string) --
The ability to share Microsoft Outlook actions.
UseMSExchangeAction (string) --
The ability to use Microsoft Outlook actions.
PagerDutyAction (string) --
The ability to perform actions using PagerDuty Advance connectors.
CreateAndUpdatePagerDutyAction (string) --
The ability to create and update PagerDuty Advance actions.
SharePagerDutyAction (string) --
The ability to share PagerDuty Advance actions.
UsePagerDutyAction (string) --
The ability to use PagerDuty Advance actions.
JiraAction (string) --
The ability to perform actions using Jira connectors.
CreateAndUpdateJiraAction (string) --
The ability to create and update Jira actions.
ShareJiraAction (string) --
The ability to share Jira actions.
UseJiraAction (string) --
The ability to use Jira actions.
ConfluenceAction (string) --
The ability to perform actions using Atlassian Confluence Cloud connectors.
CreateAndUpdateConfluenceAction (string) --
The ability to create and update Atlassian Confluence Cloud actions.
ShareConfluenceAction (string) --
The ability to share Atlassian Confluence Cloud actions.
UseConfluenceAction (string) --
The ability to use Atlassian Confluence Cloud actions.
OneDriveAction (string) --
The ability to perform actions using Microsoft OneDrive connectors.
CreateAndUpdateOneDriveAction (string) --
The ability to create and update Microsoft OneDrive actions.
ShareOneDriveAction (string) --
The ability to share Microsoft OneDrive actions.
UseOneDriveAction (string) --
The ability to use Microsoft OneDrive actions.
SharePointAction (string) --
The ability to perform actions using Microsoft SharePoint Online connectors.
CreateAndUpdateSharePointAction (string) --
The ability to create and update Microsoft SharePoint Online actions.
ShareSharePointAction (string) --
The ability to share Microsoft SharePoint Online actions.
UseSharePointAction (string) --
The ability to use Microsoft SharePoint Online actions.
MSTeamsAction (string) --
The ability to perform actions using Microsoft Teams connectors.
CreateAndUpdateMSTeamsAction (string) --
The ability to create and update Microsoft Teams actions.
ShareMSTeamsAction (string) --
The ability to share Microsoft Teams actions.
UseMSTeamsAction (string) --
The ability to use Microsoft Teams actions.
GoogleCalendarAction (string) --
The ability to perform actions using Google Calendar connectors.
CreateAndUpdateGoogleCalendarAction (string) --
The ability to create and update Google Calendar actions.
ShareGoogleCalendarAction (string) --
The ability to share Google Calendar actions.
UseGoogleCalendarAction (string) --
The ability to use Google Calendar actions.
ZendeskAction (string) --
The ability to perform actions using Zendesk connectors.
CreateAndUpdateZendeskAction (string) --
The ability to create and update Zendesk actions.
ShareZendeskAction (string) --
The ability to share Zendesk actions.
UseZendeskAction (string) --
The ability to use Zendesk actions.
SmartsheetAction (string) --
The ability to perform actions using Smartsheet connectors.
CreateAndUpdateSmartsheetAction (string) --
The ability to create and update Smartsheet actions.
ShareSmartsheetAction (string) --
The ability to share Smartsheet actions.
UseSmartsheetAction (string) --
The ability to use Smartsheet actions.
SAPBusinessPartnerAction (string) --
The ability to perform actions using SAP Business Partner connectors.
CreateAndUpdateSAPBusinessPartnerAction (string) --
The ability to create and update SAP Business Partner actions.
ShareSAPBusinessPartnerAction (string) --
The ability to share SAP Business Partner actions.
UseSAPBusinessPartnerAction (string) --
The ability to use SAP Business Partner actions.
SAPProductMasterDataAction (string) --
The ability to perform actions using SAP Product Master connectors.
CreateAndUpdateSAPProductMasterDataAction (string) --
The ability to create and update SAP Product Master actions.
ShareSAPProductMasterDataAction (string) --
The ability to share SAP Product Master actions.
UseSAPProductMasterDataAction (string) --
The ability to use SAP Product Master actions.
SAPPhysicalInventoryAction (string) --
The ability to perform actions using SAP Physical Inventory connectors.
CreateAndUpdateSAPPhysicalInventoryAction (string) --
The ability to create and update SAP Physical Inventory actions.
ShareSAPPhysicalInventoryAction (string) --
The ability to share SAP Physical Inventory actions.
UseSAPPhysicalInventoryAction (string) --
The ability to use SAP Physical Inventory actions.
SAPBillOfMaterialAction (string) --
The ability to perform actions using SAP Bill of Materials connectors.
CreateAndUpdateSAPBillOfMaterialAction (string) --
The ability to create and update SAP Bill of Materials actions.
ShareSAPBillOfMaterialAction (string) --
The ability to share SAP Bill of Materials actions.
UseSAPBillOfMaterialAction (string) --
The ability to use SAP Bill of Materials actions.
SAPMaterialStockAction (string) --
The ability to perform actions using SAP Material Stock connectors.
CreateAndUpdateSAPMaterialStockAction (string) --
The ability to create and update SAP Material Stock actions.
ShareSAPMaterialStockAction (string) --
The ability to share SAP Material Stock actions.
UseSAPMaterialStockAction (string) --
The ability to use SAP Material Stock actions.
FactSetAction (string) --
The ability to perform actions using FactSet connectors.
CreateAndUpdateFactSetAction (string) --
The ability to create and update FactSet actions.
ShareFactSetAction (string) --
The ability to share FactSet actions.
UseFactSetAction (string) --
The ability to use FactSet actions.
AmazonSThreeAction (string) --
The ability to perform actions using Amazon S3 connectors.
CreateAndUpdateAmazonSThreeAction (string) --
The ability to create and update Amazon S3 actions.
ShareAmazonSThreeAction (string) --
The ability to share Amazon S3 actions.
UseAmazonSThreeAction (string) --
The ability to use Amazon S3 actions.
TextractAction (string) --
The ability to perform actions using Textract connectors.
CreateAndUpdateTextractAction (string) --
The ability to create and update Textract actions.
ShareTextractAction (string) --
The ability to share Textract actions.
UseTextractAction (string) --
The ability to use Textract actions.
ComprehendAction (string) --
The ability to perform actions using Comprehend connectors.
CreateAndUpdateComprehendAction (string) --
The ability to create and update Comprehend actions.
ShareComprehendAction (string) --
The ability to share Comprehend actions.
UseComprehendAction (string) --
The ability to use Comprehend actions.
ComprehendMedicalAction (string) --
The ability to perform actions using Comprehend Medical connectors.
CreateAndUpdateComprehendMedicalAction (string) --
The ability to create and update Comprehend Medical actions.
ShareComprehendMedicalAction (string) --
The ability to share Comprehend Medical actions.
UseComprehendMedicalAction (string) --
The ability to use Comprehend Medical actions.
AmazonBedrockARSAction (string) --
The ability to perform actions using Bedrock Agent connectors.
CreateAndUpdateAmazonBedrockARSAction (string) --
The ability to create and update Bedrock Agent actions.
ShareAmazonBedrockARSAction (string) --
The ability to share Bedrock Agent actions.
UseAmazonBedrockARSAction (string) --
The ability to use Bedrock Agent actions.
AmazonBedrockFSAction (string) --
The ability to perform actions using Bedrock Runtime connectors.
CreateAndUpdateAmazonBedrockFSAction (string) --
The ability to create and update Bedrock Runtime actions.
ShareAmazonBedrockFSAction (string) --
The ability to share Bedrock Runtime actions.
UseAmazonBedrockFSAction (string) --
The ability to use Bedrock Runtime actions.
AmazonBedrockKRSAction (string) --
The ability to perform actions using Bedrock Data Automation Runtime connectors.
CreateAndUpdateAmazonBedrockKRSAction (string) --
The ability to create and update Bedrock Data Automation Runtime actions.
ShareAmazonBedrockKRSAction (string) --
The ability to share Bedrock Data Automation Runtime actions.
UseAmazonBedrockKRSAction (string) --
The ability to use Bedrock Data Automation Runtime actions.
MCPAction (string) --
The ability to perform actions using Model Context Protocol connectors.
CreateAndUpdateMCPAction (string) --
The ability to create and update Model Context Protocol actions.
ShareMCPAction (string) --
The ability to share Model Context Protocol actions.
UseMCPAction (string) --
The ability to use Model Context Protocol actions.
LocalMCPAction (string) --
The ability to create, update, and use local Model Context Protocol (MCP) actions. This capability includes CreateAndUpdateLocalMCPAction and UseLocalMCPAction.
CreateAndUpdateLocalMCPAction (string) --
The ability to create and update local Model Context Protocol (MCP) server configurations. Denying this capability does not by itself deny use of previously configured local MCP servers.
UseLocalMCPAction (string) --
The ability to start local Model Context Protocol (MCP) servers and use their actions, including actions from previously configured local MCP servers.
OpenAPIAction (string) --
The ability to perform actions using OpenAPI Specification connectors.
CreateAndUpdateOpenAPIAction (string) --
The ability to create and update OpenAPI Specification actions.
ShareOpenAPIAction (string) --
The ability to share OpenAPI Specification actions.
UseOpenAPIAction (string) --
The ability to use OpenAPI Specification actions.
SandPGMIAction (string) --
The ability to perform actions using S&P Global Market Intelligence connectors.
CreateAndUpdateSandPGMIAction (string) --
The ability to create and update S&P Global Market Intelligence actions.
ShareSandPGMIAction (string) --
The ability to share S&P Global Market Intelligence actions.
UseSandPGMIAction (string) --
The ability to use S&P Global Market Intelligence actions.
SandPGlobalEnergyAction (string) --
The ability to perform actions using S&P Global Energy connectors.
CreateAndUpdateSandPGlobalEnergyAction (string) --
The ability to create and update S&P Global Energy actions.
ShareSandPGlobalEnergyAction (string) --
The ability to share S&P Global Energy actions.
UseSandPGlobalEnergyAction (string) --
The ability to use S&P Global Energy actions.
BambooHRAction (string) --
The ability to perform actions using BambooHR connectors.
CreateAndUpdateBambooHRAction (string) --
The ability to create and update BambooHR actions.
ShareBambooHRAction (string) --
The ability to share BambooHR actions.
UseBambooHRAction (string) --
The ability to use BambooHR actions.
BoxAgentAction (string) --
The ability to perform actions using Box Agent connectors.
CreateAndUpdateBoxAgentAction (string) --
The ability to create and update Box Agent actions.
ShareBoxAgentAction (string) --
The ability to share Box Agent actions.
UseBoxAgentAction (string) --
The ability to use Box Agent actions.
CanvaAgentAction (string) --
The ability to perform actions using Canva Agent connectors.
CreateAndUpdateCanvaAgentAction (string) --
The ability to create and update Canva Agent actions.
ShareCanvaAgentAction (string) --
The ability to share Canva Agent actions.
UseCanvaAgentAction (string) --
The ability to use Canva Agent actions.
GithubAction (string) --
The ability to perform actions using GitHub connectors.
CreateAndUpdateGithubAction (string) --
The ability to create and update GitHub actions.
ShareGithubAction (string) --
The ability to share GitHub actions.
UseGithubAction (string) --
The ability to use GitHub actions.
NotionAction (string) --
The ability to perform actions using Notion connectors.
CreateAndUpdateNotionAction (string) --
The ability to create and update Notion actions.
ShareNotionAction (string) --
The ability to share Notion actions.
UseNotionAction (string) --
The ability to use Notion actions.
LinearAction (string) --
The ability to perform actions using Linear connectors.
CreateAndUpdateLinearAction (string) --
The ability to create and update Linear actions.
ShareLinearAction (string) --
The ability to share Linear actions.
UseLinearAction (string) --
The ability to use Linear actions.
HuggingFaceAction (string) --
The ability to perform actions using HuggingFace connectors.
CreateAndUpdateHuggingFaceAction (string) --
The ability to create and update HuggingFace actions.
ShareHuggingFaceAction (string) --
The ability to share HuggingFace actions.
UseHuggingFaceAction (string) --
The ability to use HuggingFace actions.
MondayAction (string) --
The ability to perform actions using Monday connectors.
CreateAndUpdateMondayAction (string) --
The ability to create and update Monday actions.
ShareMondayAction (string) --
The ability to share Monday actions.
UseMondayAction (string) --
The ability to use Monday actions.
HubspotAction (string) --
The ability to perform actions using Hubspot connectors.
CreateAndUpdateHubspotAction (string) --
The ability to create and update Hubspot actions.
ShareHubspotAction (string) --
The ability to share Hubspot actions.
UseHubspotAction (string) --
The ability to use Hubspot actions.
IntercomAction (string) --
The ability to perform actions using Intercom connectors.
CreateAndUpdateIntercomAction (string) --
The ability to create and update Intercom actions.
ShareIntercomAction (string) --
The ability to share Intercom actions.
UseIntercomAction (string) --
The ability to use Intercom actions.
NewRelicAction (string) --
The ability to perform actions using New Relic connectors.
CreateAndUpdateNewRelicAction (string) --
The ability to create and update New Relic actions.
ShareNewRelicAction (string) --
The ability to share New Relic actions.
UseNewRelicAction (string) --
The ability to use New Relic actions.
PagerDutyAgentAction (string) --
The ability to perform actions using PagerDuty Agent connectors.
CreateAndUpdatePagerDutyAgentAction (string) --
The ability to create and update PagerDuty Agent actions.
SharePagerDutyAgentAction (string) --
The ability to share PagerDuty Agent actions.
UsePagerDutyAgentAction (string) --
The ability to use PagerDuty Agent actions.
VisierAgentAction (string) --
The ability to perform actions using Visier Agent connectors.
CreateAndUpdateVisierAgentAction (string) --
The ability to create and update Visier Agent actions.
ShareVisierAgentAction (string) --
The ability to share Visier Agent actions.
UseVisierAgentAction (string) --
The ability to use Visier Agent actions.
ZoomAction (string) --
The ability to perform actions using Zoom connectors.
CreateAndUpdateZoomAction (string) --
The ability to create and update Zoom actions.
ShareZoomAction (string) --
The ability to share Zoom actions.
UseZoomAction (string) --
The ability to use Zoom actions.
SnowFlakeAction (string) --
The ability to perform actions using Snowflake Cortex Agent connectors.
CreateAndUpdateSnowFlakeAction (string) --
The ability to create and update Snowflake Cortex Agent actions.
ShareSnowFlakeAction (string) --
The ability to share Snowflake Cortex Agent actions.
UseSnowFlakeAction (string) --
The ability to use Snowflake Cortex Agent actions.
ZapierAction (string) --
The ability to perform actions using Zapier Agent connectors.
CreateAndUpdateZapierAction (string) --
The ability to create and update Zapier Agent actions.
ShareZapierAction (string) --
The ability to share Zapier Agent actions.
UseZapierAction (string) --
The ability to use Zapier Agent actions.
AirtableAction (string) --
The ability to perform actions using Airtable connectors.
CreateAndUpdateAirtableAction (string) --
The ability to create and update Airtable actions.
ShareAirtableAction (string) --
The ability to share Airtable actions.
UseAirtableAction (string) --
The ability to use Airtable actions.
DropboxAction (string) --
The ability to perform actions using Dropbox connectors.
CreateAndUpdateDropboxAction (string) --
The ability to create and update Dropbox actions.
ShareDropboxAction (string) --
The ability to share Dropbox actions.
UseDropboxAction (string) --
The ability to use Dropbox actions.
GmailAction (string) --
The ability to perform actions using Gmail connectors.
CreateAndUpdateGmailAction (string) --
The ability to create and update Gmail actions.
ShareGmailAction (string) --
The ability to share Gmail actions.
UseGmailAction (string) --
The ability to use Gmail actions.
GoogleAnalyticsAction (string) --
The ability to perform actions using Google Analytics connectors.
CreateAndUpdateGoogleAnalyticsAction (string) --
The ability to create and update Google Analytics actions.
ShareGoogleAnalyticsAction (string) --
The ability to share Google Analytics actions.
UseGoogleAnalyticsAction (string) --
The ability to use Google Analytics actions.
GoogleDocsAction (string) --
The ability to perform actions using Google Docs connectors.
CreateAndUpdateGoogleDocsAction (string) --
The ability to create and update Google Docs actions.
ShareGoogleDocsAction (string) --
The ability to share Google Docs actions.
UseGoogleDocsAction (string) --
The ability to use Google Docs actions.
GoogleDriveAction (string) --
The ability to perform actions using Google Drive connectors.
CreateAndUpdateGoogleDriveAction (string) --
The ability to create and update Google Drive actions.
ShareGoogleDriveAction (string) --
The ability to share Google Drive actions.
UseGoogleDriveAction (string) --
The ability to use Google Drive actions.
GoogleMeetAction (string) --
The ability to perform actions using Google Meet connectors.
CreateAndUpdateGoogleMeetAction (string) --
The ability to create and update Google Meet actions.
ShareGoogleMeetAction (string) --
The ability to share Google Meet actions.
UseGoogleMeetAction (string) --
The ability to use Google Meet actions.
GoogleSheetsAction (string) --
The ability to perform actions using Google Sheets connectors.
CreateAndUpdateGoogleSheetsAction (string) --
The ability to create and update Google Sheets actions.
ShareGoogleSheetsAction (string) --
The ability to share Google Sheets actions.
UseGoogleSheetsAction (string) --
The ability to use Google Sheets actions.
GoogleSlidesAction (string) --
The ability to perform actions using Google Slides connectors.
CreateAndUpdateGoogleSlidesAction (string) --
The ability to create and update Google Slides actions.
ShareGoogleSlidesAction (string) --
The ability to share Google Slides actions.
UseGoogleSlidesAction (string) --
The ability to use Google Slides actions.
QuickBooksAction (string) --
The ability to perform actions using QuickBooks connectors.
CreateAndUpdateQuickBooksAction (string) --
The ability to create and update QuickBooks actions.
ShareQuickBooksAction (string) --
The ability to share QuickBooks actions.
UseQuickBooksAction (string) --
The ability to use QuickBooks actions.
FigmaAction (string) --
The ability to perform actions using Figma connectors.
CreateAndUpdateFigmaAction (string) --
The ability to create and update Figma actions.
ShareFigmaAction (string) --
The ability to share Figma actions.
UseFigmaAction (string) --
The ability to use Figma actions.
WhatsAppAction (string) --
The ability to perform actions using WhatsApp connectors.
CreateAndUpdateWhatsAppAction (string) --
The ability to create and update WhatsApp actions.
ShareWhatsAppAction (string) --
The ability to share WhatsApp actions.
UseWhatsAppAction (string) --
The ability to use WhatsApp actions.
GoogleChatAction (string) --
The ability to perform actions using Google Chat connectors.
CreateAndUpdateGoogleChatAction (string) --
The ability to create and update Google Chat actions.
ShareGoogleChatAction (string) --
The ability to share Google Chat actions.
UseGoogleChatAction (string) --
The ability to use Google Chat actions.
OneNoteAction (string) --
The ability to perform actions using Microsoft OneNote connectors.
CreateAndUpdateOneNoteAction (string) --
The ability to create and update Microsoft OneNote actions.
ShareOneNoteAction (string) --
The ability to share Microsoft OneNote actions.
UseOneNoteAction (string) --
The ability to use Microsoft OneNote actions.
ShopifyAction (string) --
The ability to perform actions using Shopify connectors.
CreateAndUpdateShopifyAction (string) --
The ability to create and update Shopify actions.
ShareShopifyAction (string) --
The ability to share Shopify actions.
UseShopifyAction (string) --
The ability to use Shopify actions.
AdobeAction (string) --
The ability to perform actions using Adobe Marketing Agent connectors.
CreateAndUpdateAdobeAction (string) --
The ability to create and update Adobe Marketing Agent actions.
ShareAdobeAction (string) --
The ability to share Adobe Marketing Agent actions.
UseAdobeAction (string) --
The ability to use Adobe Marketing Agent actions.
CiscoWebexVidcastAction (string) --
The ability to perform actions using Cisco Webex Video Messaging Agent connectors.
CreateAndUpdateCiscoWebexVidcastAction (string) --
The ability to create and update Cisco Webex Video Messaging Agent actions.
ShareCiscoWebexVidcastAction (string) --
The ability to share Cisco Webex Video Messaging Agent actions.
UseCiscoWebexVidcastAction (string) --
The ability to use Cisco Webex Video Messaging Agent actions.
CiscoWebexMeetingsAction (string) --
The ability to perform actions using Cisco Webex Meetings connectors.
CreateAndUpdateCiscoWebexMeetingsAction (string) --
The ability to create and update Cisco Webex Meetings actions.
ShareCiscoWebexMeetingsAction (string) --
The ability to share Cisco Webex Meetings actions.
UseCiscoWebexMeetingsAction (string) --
The ability to use Cisco Webex Meetings actions.
DunAndBradstreetAction (string) --
The ability to perform actions using Dun and Bradstreet connectors.
CreateAndUpdateDunAndBradstreetAction (string) --
The ability to create and update Dun and Bradstreet actions.
ShareDunAndBradstreetAction (string) --
The ability to share Dun and Bradstreet actions.
UseDunAndBradstreetAction (string) --
The ability to use Dun and Bradstreet actions.
HGInsightsAction (string) --
The ability to perform actions using HG Insights Agent connectors.
CreateAndUpdateHGInsightsAction (string) --
The ability to create and update HG Insights Agent actions.
ShareHGInsightsAction (string) --
The ability to share HG Insights Agent actions.
UseHGInsightsAction (string) --
The ability to use HG Insights Agent actions.
ZoomInfoAction (string) --
The ability to perform actions using ZoomInfo Agent connectors.
CreateAndUpdateZoomInfoAction (string) --
The ability to create and update ZoomInfo Agent actions.
ShareZoomInfoAction (string) --
The ability to share ZoomInfo Agent actions.
UseZoomInfoAction (string) --
The ability to use ZoomInfo Agent actions.
MoodysAction (string) --
The ability to perform actions using Moody's GenAI Ready Data connectors.
CreateAndUpdateMoodysAction (string) --
The ability to create and update Moody's GenAI Ready Data actions.
ShareMoodysAction (string) --
The ability to share Moody's GenAI Ready Data actions.
UseMoodysAction (string) --
The ability to use Moody's GenAI Ready Data actions.
BeeAction (string) --
The ability to perform actions using Bee connectors.
CreateAndUpdateBeeAction (string) --
The ability to create and update Bee actions.
ShareBeeAction (string) --
The ability to share Bee actions.
UseBeeAction (string) --
The ability to use Bee actions.
GongAction (string) --
The ability to perform actions using Gong connectors.
CreateAndUpdateGongAction (string) --
The ability to create and update Gong actions.
ShareGongAction (string) --
The ability to share Gong actions.
UseGongAction (string) --
The ability to use Gong actions.
Topic (string) --
The ability to perform Topic-related actions.
EditVisualWithQ (string) --
The ability to Edit Visual with AI
BuildCalculatedFieldWithQ (string) --
The ability to Build Calculation with AI
CreateDashboardExecutiveSummaryWithQ (string) --
The ability to Create Executive Summary
Space (string) --
The ability to perform space-related actions.
CreateSpaces (string) --
The ability to create spaces.
ShareSpaces (string) --
The ability to share spaces with other users and groups.
ChatAgent (string) --
The ability to perform chat-related actions.
CreateChatAgents (string) --
The ability to create chat agents.
ShareChatAgents (string) --
The ability to share chat agents with other users and groups.
Research (string) --
The ability to perform research-related actions.
SelfUpgradeUserRole (string) --
The ability to enable users to upgrade their user role.
Extension (string) --
The ability to perform Extension-related actions.
UseBrowserExtension (string) --
The ability to use Amazon Quick through the browser extension for Chrome, Firefox, and Edge.
UseWordAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Word add-in.
UseOutlookAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Outlook add-in.
UseExcelAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft Excel add-in.
UsePowerpointAddInExtension (string) --
The ability to use Amazon Quick through the Microsoft PowerPoint add-in.
ManageSharedFolders (string) --
The ability to create, update, delete and view shared folders (both restricted and unrestricted), ability to add any asset to shared folders, and ability to share the folders.
Note: This does not prevent inheriting access to assets that others share with them through folder membership.
GenerateAnalyses (string) --
The ability to generate analysis using AI
Story (string) --
The ability to perform Story-related actions.
Scenario (string) --
The ability to perform Scenario-related actions.
Trigger (string) --
The ability to manage trigger-related settings for flows and automations.
ScheduleTrigger (string) --
The ability to create, view, edit, delete, and run schedule triggers for flows and automations.
InboundEmailTrigger (string) --
The ability to create, view, edit, delete, and run inbound email triggers for flows and automations.
QuickEventTrigger (string) --
The ability to create, view, edit, delete, and run Quick event triggers for flows and automations.
FileDataSource (string) --
The ability to create, update, and share file data sources.
CreateFileDataSource (string) --
The ability to create file data sources.
UpdateFileDataSource (string) --
The ability to update file data sources.
ShareFileDataSource (string) --
The ability to share file data sources.
S3DataSource (string) --
The ability to create, update, and share Amazon S3 data sources.
CreateS3DataSource (string) --
The ability to create Amazon S3 data sources.
UpdateS3DataSource (string) --
The ability to update Amazon S3 data sources.
ShareS3DataSource (string) --
The ability to share Amazon S3 data sources.
S3AnalyticsDataSource (string) --
The ability to create, update, and share Amazon S3 Analytics data sources.
CreateS3AnalyticsDataSource (string) --
The ability to create Amazon S3 Analytics data sources.
UpdateS3AnalyticsDataSource (string) --
The ability to update Amazon S3 Analytics data sources.
ShareS3AnalyticsDataSource (string) --
The ability to share Amazon S3 Analytics data sources.
S3TablesDataSource (string) --
The ability to create, update, and share Amazon S3 Tables data sources.
CreateS3TablesDataSource (string) --
The ability to create Amazon S3 Tables data sources.
UpdateS3TablesDataSource (string) --
The ability to update Amazon S3 Tables data sources.
ShareS3TablesDataSource (string) --
The ability to share Amazon S3 Tables data sources.
AthenaDataSource (string) --
The ability to create, update, and share Amazon Athena data sources.
CreateAthenaDataSource (string) --
The ability to create Amazon Athena data sources.
UpdateAthenaDataSource (string) --
The ability to update Amazon Athena data sources.
ShareAthenaDataSource (string) --
The ability to share Amazon Athena data sources.
RdsDataSource (string) --
The ability to create, update, and share auto-discovered Amazon RDS data sources.
CreateRdsDataSource (string) --
The ability to create auto-discovered Amazon RDS data sources.
UpdateRdsDataSource (string) --
The ability to update auto-discovered Amazon RDS data sources.
ShareRdsDataSource (string) --
The ability to share auto-discovered Amazon RDS data sources.
RedshiftAutoDiscoveredDataSource (string) --
The ability to create, update, and share auto-discovered Amazon Redshift data sources.
CreateRedshiftAutoDiscoveredDataSource (string) --
The ability to create auto-discovered Amazon Redshift data sources.
UpdateRedshiftAutoDiscoveredDataSource (string) --
The ability to update auto-discovered Amazon Redshift data sources.
ShareRedshiftAutoDiscoveredDataSource (string) --
The ability to share auto-discovered Amazon Redshift data sources.
RedshiftManualDataSource (string) --
The ability to create, update, and share manually configured Amazon Redshift data sources.
CreateRedshiftManualDataSource (string) --
The ability to create manually configured Amazon Redshift data sources.
UpdateRedshiftManualDataSource (string) --
The ability to update manually configured Amazon Redshift data sources.
ShareRedshiftManualDataSource (string) --
The ability to share manually configured Amazon Redshift data sources.
OpenSearchDataSource (string) --
The ability to create, update, and share Amazon OpenSearch Service data sources.
CreateOpenSearchDataSource (string) --
The ability to create Amazon OpenSearch Service data sources.
UpdateOpenSearchDataSource (string) --
The ability to update Amazon OpenSearch Service data sources.
ShareOpenSearchDataSource (string) --
The ability to share Amazon OpenSearch Service data sources.
TimestreamDataSource (string) --
The ability to create, update, and share Amazon Timestream data sources.
CreateTimestreamDataSource (string) --
The ability to create Amazon Timestream data sources.
UpdateTimestreamDataSource (string) --
The ability to update Amazon Timestream data sources.
ShareTimestreamDataSource (string) --
The ability to share Amazon Timestream data sources.
AuroraDataSource (string) --
The ability to create, update, and share Amazon Aurora data sources.
CreateAuroraDataSource (string) --
The ability to create Amazon Aurora data sources.
UpdateAuroraDataSource (string) --
The ability to update Amazon Aurora data sources.
ShareAuroraDataSource (string) --
The ability to share Amazon Aurora data sources.
MySqlDataSource (string) --
The ability to create, update, and share MySQL data sources.
CreateMySqlDataSource (string) --
The ability to create MySQL data sources.
UpdateMySqlDataSource (string) --
The ability to update MySQL data sources.
ShareMySqlDataSource (string) --
The ability to share MySQL data sources.
PostgreSqlDataSource (string) --
The ability to create, update, and share PostgreSQL data sources.
CreatePostgreSqlDataSource (string) --
The ability to create PostgreSQL data sources.
UpdatePostgreSqlDataSource (string) --
The ability to update PostgreSQL data sources.
SharePostgreSqlDataSource (string) --
The ability to share PostgreSQL data sources.
OracleDataSource (string) --
The ability to create, update, and share Oracle data sources.
CreateOracleDataSource (string) --
The ability to create Oracle data sources.
UpdateOracleDataSource (string) --
The ability to update Oracle data sources.
ShareOracleDataSource (string) --
The ability to share Oracle data sources.
SqlServerDataSource (string) --
The ability to create, update, and share SQL Server data sources.
CreateSqlServerDataSource (string) --
The ability to create SQL Server data sources.
UpdateSqlServerDataSource (string) --
The ability to update SQL Server data sources.
ShareSqlServerDataSource (string) --
The ability to share SQL Server data sources.
MariaDbDataSource (string) --
The ability to create, update, and share MariaDB data sources.
CreateMariaDbDataSource (string) --
The ability to create MariaDB data sources.
UpdateMariaDbDataSource (string) --
The ability to update MariaDB data sources.
ShareMariaDbDataSource (string) --
The ability to share MariaDB data sources.
SnowflakeDataSource (string) --
The ability to create, update, and share Snowflake data sources.
CreateSnowflakeDataSource (string) --
The ability to create Snowflake data sources.
UpdateSnowflakeDataSource (string) --
The ability to update Snowflake data sources.
ShareSnowflakeDataSource (string) --
The ability to share Snowflake data sources.
GoogleBigQueryDataSource (string) --
The ability to create, update, and share Google BigQuery data sources.
CreateGoogleBigQueryDataSource (string) --
The ability to create Google BigQuery data sources.
UpdateGoogleBigQueryDataSource (string) --
The ability to update Google BigQuery data sources.
ShareGoogleBigQueryDataSource (string) --
The ability to share Google BigQuery data sources.
DatabricksDataSource (string) --
The ability to create, update, and share Databricks data sources.
CreateDatabricksDataSource (string) --
The ability to create Databricks data sources.
UpdateDatabricksDataSource (string) --
The ability to update Databricks data sources.
ShareDatabricksDataSource (string) --
The ability to share Databricks data sources.
StarburstDataSource (string) --
The ability to create, update, and share Starburst data sources.
CreateStarburstDataSource (string) --
The ability to create Starburst data sources.
UpdateStarburstDataSource (string) --
The ability to update Starburst data sources.
ShareStarburstDataSource (string) --
The ability to share Starburst data sources.
TrinoDataSource (string) --
The ability to create, update, and share Trino data sources.
CreateTrinoDataSource (string) --
The ability to create Trino data sources.
UpdateTrinoDataSource (string) --
The ability to update Trino data sources.
ShareTrinoDataSource (string) --
The ability to share Trino data sources.
ImpalaDataSource (string) --
The ability to create, update, and share Impala data sources.
CreateImpalaDataSource (string) --
The ability to create Impala data sources.
UpdateImpalaDataSource (string) --
The ability to update Impala data sources.
ShareImpalaDataSource (string) --
The ability to share Impala data sources.
TeradataDataSource (string) --
The ability to create, update, and share Teradata data sources.
CreateTeradataDataSource (string) --
The ability to create Teradata data sources.
UpdateTeradataDataSource (string) --
The ability to update Teradata data sources.
ShareTeradataDataSource (string) --
The ability to share Teradata data sources.
PrestoDataSource (string) --
The ability to create, update, and share Presto data sources.
CreatePrestoDataSource (string) --
The ability to create Presto data sources.
UpdatePrestoDataSource (string) --
The ability to update Presto data sources.
SharePrestoDataSource (string) --
The ability to share Presto data sources.
SparkDataSource (string) --
The ability to create, update, and share Spark data sources.
CreateSparkDataSource (string) --
The ability to create Spark data sources.
UpdateSparkDataSource (string) --
The ability to update Spark data sources.
ShareSparkDataSource (string) --
The ability to share Spark data sources.
ExasolDataSource (string) --
The ability to create, update, and share Exasol data sources.
CreateExasolDataSource (string) --
The ability to create Exasol data sources.
UpdateExasolDataSource (string) --
The ability to update Exasol data sources.
ShareExasolDataSource (string) --
The ability to share Exasol data sources.
Db2DataSource (string) --
The ability to create, update, and share Db2 data sources.
CreateDb2DataSource (string) --
The ability to create Db2 data sources.
UpdateDb2DataSource (string) --
The ability to update Db2 data sources.
ShareDb2DataSource (string) --
The ability to share Db2 data sources.
SapHanaDataSource (string) --
The ability to create, update, and share SAP HANA data sources.
CreateSapHanaDataSource (string) --
The ability to create SAP HANA data sources.
UpdateSapHanaDataSource (string) --
The ability to update SAP HANA data sources.
ShareSapHanaDataSource (string) --
The ability to share SAP HANA data sources.
DenodoDataSource (string) --
The ability to create, update, and share Denodo data sources.
CreateDenodoDataSource (string) --
The ability to create Denodo data sources.
UpdateDenodoDataSource (string) --
The ability to update Denodo data sources.
ShareDenodoDataSource (string) --
The ability to share Denodo data sources.
DremioDataSource (string) --
The ability to create, update, and share Dremio data sources.
CreateDremioDataSource (string) --
The ability to create Dremio data sources.
UpdateDremioDataSource (string) --
The ability to update Dremio data sources.
ShareDremioDataSource (string) --
The ability to share Dremio data sources.
SalesforceDataSource (string) --
The ability to create, update, and share Salesforce data sources.
CreateSalesforceDataSource (string) --
The ability to create Salesforce data sources.
UpdateSalesforceDataSource (string) --
The ability to update Salesforce data sources.
ShareSalesforceDataSource (string) --
The ability to share Salesforce data sources.
RadiantDataSource (string) --
The ability to create, update, and share Amazon QuickSight data sources.
CreateRadiantDataSource (string) --
The ability to create Amazon QuickSight data sources.
UpdateRadiantDataSource (string) --
The ability to update Amazon QuickSight data sources.
ShareRadiantDataSource (string) --
The ability to share Amazon QuickSight data sources.
PayPalDataSource (string) --
The ability to create, update, and share PayPal data sources.
CreatePayPalDataSource (string) --
The ability to create PayPal data sources.
UpdatePayPalDataSource (string) --
The ability to update PayPal data sources.
SharePayPalDataSource (string) --
The ability to share PayPal data sources.
SquareDataSource (string) --
The ability to create, update, and share Square data sources.
CreateSquareDataSource (string) --
The ability to create Square data sources.
UpdateSquareDataSource (string) --
The ability to update Square data sources.
ShareSquareDataSource (string) --
The ability to share Square data sources.
GitHubDataSource (string) --
The ability to create, update, and share GitHub data sources.
CreateGitHubDataSource (string) --
The ability to create GitHub data sources.
UpdateGitHubDataSource (string) --
The ability to update GitHub data sources.
ShareGitHubDataSource (string) --
The ability to share GitHub data sources.
TwitterDataSource (string) --
The ability to create, update, and share Twitter data sources.
CreateTwitterDataSource (string) --
The ability to create Twitter data sources.
UpdateTwitterDataSource (string) --
The ability to update Twitter data sources.
ShareTwitterDataSource (string) --
The ability to share Twitter data sources.
JiraDataSource (string) --
The ability to create, update, and share Jira data sources.
CreateJiraDataSource (string) --
The ability to create Jira data sources.
UpdateJiraDataSource (string) --
The ability to update Jira data sources.
ShareJiraDataSource (string) --
The ability to share Jira data sources.
ServiceNowDataSource (string) --
The ability to create, update, and share ServiceNow data sources.
CreateServiceNowDataSource (string) --
The ability to create ServiceNow data sources.
UpdateServiceNowDataSource (string) --
The ability to update ServiceNow data sources.
ShareServiceNowDataSource (string) --
The ability to share ServiceNow data sources.
AdobeAnalyticsDataSource (string) --
The ability to create, update, and share Adobe Analytics data sources.
CreateAdobeAnalyticsDataSource (string) --
The ability to create Adobe Analytics data sources.
UpdateAdobeAnalyticsDataSource (string) --
The ability to update Adobe Analytics data sources.
ShareAdobeAnalyticsDataSource (string) --
The ability to share Adobe Analytics data sources.
GoogleAnalyticsDataSource (string) --
The ability to create, update, and share Google Analytics data sources.
CreateGoogleAnalyticsDataSource (string) --
The ability to create Google Analytics data sources.
UpdateGoogleAnalyticsDataSource (string) --
The ability to update Google Analytics data sources.
ShareGoogleAnalyticsDataSource (string) --
The ability to share Google Analytics data sources.
GoogleSheetsDataSource (string) --
The ability to create, update, and share Google Sheets data sources.
CreateGoogleSheetsDataSource (string) --
The ability to create Google Sheets data sources.
UpdateGoogleSheetsDataSource (string) --
The ability to update Google Sheets data sources.
ShareGoogleSheetsDataSource (string) --
The ability to share Google Sheets data sources.
DocumentDbDataSource (string) --
The ability to create, update, and share Amazon DocumentDB data sources.
CreateDocumentDbDataSource (string) --
The ability to create Amazon DocumentDB data sources.
UpdateDocumentDbDataSource (string) --
The ability to update Amazon DocumentDB data sources.
ShareDocumentDbDataSource (string) --
The ability to share Amazon DocumentDB data sources.
MongoDbDataSource (string) --
The ability to create, update, and share MongoDB data sources.
CreateMongoDbDataSource (string) --
The ability to create MongoDB data sources.
UpdateMongoDbDataSource (string) --
The ability to update MongoDB data sources.
ShareMongoDbDataSource (string) --
The ability to share MongoDB data sources.
MongoAtlasDataSource (string) --
The ability to create, update, and share MongoDB Atlas data sources.
CreateMongoAtlasDataSource (string) --
The ability to create MongoDB Atlas data sources.
UpdateMongoAtlasDataSource (string) --
The ability to update MongoDB Atlas data sources.
ShareMongoAtlasDataSource (string) --
The ability to share MongoDB Atlas data sources.
DynamoDbDataSource (string) --
The ability to create, update, and share Amazon DynamoDB data sources.
CreateDynamoDbDataSource (string) --
The ability to create Amazon DynamoDB data sources.
UpdateDynamoDbDataSource (string) --
The ability to update Amazon DynamoDB data sources.
ShareDynamoDbDataSource (string) --
The ability to share Amazon DynamoDB data sources.
dict
The governance configuration for the custom permissions profile. The UpdateCustomPermissions operation replaces all existing Capabilities and Governance values. If you omit this parameter, Amazon Quick removes governance from the profile and the existing custom permission behavior applies.
DefaultCategoryEffects (dict) --
A map of DefaultCategoryEffects.
(string) --
The name of a governance category. A governance category groups related capabilities so that you can apply a default effect to all capabilities in the category at once. Valid values:
AI – Capabilities related to Amazon Quick AI features.
(string) --
The default effect that Amazon Quick applies to capabilities in a governed category when you do not explicitly list those capabilities in Capabilities. Valid values:
DENY_BY_DEFAULT – Amazon Quick denies any capability access in the given category that the profile does not explicitly set to ALLOW.
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.
{'UnmaterializedCalculatedColumns': [{'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'SubType': 'FLOAT | FIXED',
'Type': 'STRING | INTEGER | DECIMAL | '
'DATETIME'}]}
Updates a dataset. Partial updates are not supported by this operation.
See also: AWS API Documentation
Request Syntax
client.update_data_set(
AwsAccountId='string',
DataSetId='string',
Name='string',
PhysicalTableMap={
'string': {
'RelationalTable': {
'DataSourceArn': 'string',
'Catalog': 'string',
'Schema': 'string',
'Name': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'CustomSql': {
'DataSourceArn': 'string',
'Name': 'string',
'SqlQuery': 'string',
'Columns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'S3Source': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'SaaSTable': {
'DataSourceArn': 'string',
'TablePath': [
{
'Name': 'string',
'Id': 'string'
},
],
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
},
'FileSource': {
'DataSourceArn': 'string',
'UploadSettings': {
'Format': 'CSV'|'TSV'|'CLF'|'ELF'|'XLSX'|'JSON',
'StartFromRow': 123,
'ContainsHeader': True|False,
'TextQualifier': 'DOUBLE_QUOTE'|'SINGLE_QUOTE',
'Delimiter': 'string',
'CustomCellAddressRange': 'string'
},
'SheetIndex': 123,
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
LogicalTableMap={
'string': {
'Alias': 'string',
'DataTransforms': [
{
'ProjectOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FilterOperation': {
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
'CreateColumnsOperation': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnOperation': {
'ColumnName': 'string',
'NewColumnName': 'string'
},
'CastColumnTypeOperation': {
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
'TagColumnOperation': {
'ColumnName': 'string',
'Tags': [
{
'ColumnGeographicRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE',
'ColumnDescription': {
'Text': 'string'
}
},
]
},
'UntagColumnOperation': {
'ColumnName': 'string',
'TagNames': [
'COLUMN_GEOGRAPHIC_ROLE'|'COLUMN_DESCRIPTION',
]
},
'OverrideDatasetParameterOperation': {
'ParameterName': 'string',
'NewParameterName': 'string',
'NewDefaultValues': {
'StringStaticValues': [
'string',
],
'DecimalStaticValues': [
123.0,
],
'DateTimeStaticValues': [
datetime(2015, 1, 1),
],
'IntegerStaticValues': [
123,
]
}
}
},
],
'Source': {
'JoinInstruction': {
'LeftOperand': 'string',
'RightOperand': 'string',
'LeftJoinKeyProperties': {
'UniqueKey': True|False
},
'RightJoinKeyProperties': {
'UniqueKey': True|False
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string'
},
'PhysicalTableId': 'string',
'DataSetArn': 'string'
}
}
},
ImportMode='SPICE'|'DIRECT_QUERY',
ColumnGroups=[
{
'GeoSpatialColumnGroup': {
'Name': 'string',
'CountryCode': 'US',
'Columns': [
'string',
]
}
},
],
FieldFolders={
'string': {
'description': 'string',
'columns': [
'string',
]
}
},
RowLevelPermissionDataSet={
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
},
RowLevelPermissionTagConfiguration={
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
ColumnLevelPermissionRules=[
{
'Principals': [
'string',
],
'ColumnNames': [
'string',
]
},
],
DataSetUsageConfiguration={
'DisableUseAsDirectQuerySource': True|False,
'DisableUseAsImportedSource': True|False
},
DatasetParameters=[
{
'StringDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
'string',
]
}
},
'DecimalDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123.0,
]
}
},
'IntegerDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'DefaultValues': {
'StaticValues': [
123,
]
}
},
'DateTimeDatasetParameter': {
'Id': 'string',
'Name': 'string',
'ValueType': 'MULTI_VALUED'|'SINGLE_VALUED',
'TimeGranularity': 'YEAR'|'QUARTER'|'MONTH'|'WEEK'|'DAY'|'HOUR'|'MINUTE'|'SECOND'|'MILLISECOND',
'DefaultValues': {
'StaticValues': [
datetime(2015, 1, 1),
]
}
}
},
],
PerformanceConfiguration={
'UniqueKeys': [
{
'ColumnNames': [
'string',
]
},
]
},
DataPrepConfiguration={
'SourceTableMap': {
'string': {
'PhysicalTableId': 'string',
'DataSet': {
'DataSetArn': 'string',
'InputColumns': [
{
'Name': 'string',
'Id': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME'|'BIT'|'BOOLEAN'|'JSON'|'SEMISTRUCT',
'SubType': 'FLOAT'|'FIXED'
},
]
}
}
},
'TransformStepMap': {
'string': {
'ImportTableStep': {
'Alias': 'string',
'Source': {
'SourceTableId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
}
},
'ProjectStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ProjectedColumns': [
'string',
]
},
'FiltersStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'FilterOperations': [
{
'ConditionExpression': 'string',
'StringFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'CONTAINS'|'DOES_NOT_CONTAIN'|'STARTS_WITH'|'ENDS_WITH',
'Value': {
'StaticValue': 'string'
}
},
'ListFilterCondition': {
'Operator': 'INCLUDE'|'EXCLUDE',
'Values': {
'StaticValues': [
'string',
]
}
}
},
'NumericFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'EQUALS'|'DOES_NOT_EQUAL'|'GREATER_THAN'|'GREATER_THAN_OR_EQUALS_TO'|'LESS_THAN'|'LESS_THAN_OR_EQUALS_TO',
'Value': {
'StaticValue': 123.0
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': 123.0
},
'RangeMaximum': {
'StaticValue': 123.0
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
},
'DateFilterCondition': {
'ColumnName': 'string',
'ComparisonFilterCondition': {
'Operator': 'BEFORE'|'BEFORE_OR_EQUALS_TO'|'AFTER'|'AFTER_OR_EQUALS_TO',
'Value': {
'StaticValue': datetime(2015, 1, 1)
}
},
'RangeFilterCondition': {
'RangeMinimum': {
'StaticValue': datetime(2015, 1, 1)
},
'RangeMaximum': {
'StaticValue': datetime(2015, 1, 1)
},
'IncludeMinimum': True|False,
'IncludeMaximum': True|False
}
}
},
]
},
'CreateColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Columns': [
{
'ColumnName': 'string',
'ColumnId': 'string',
'Expression': 'string'
},
]
},
'RenameColumnsStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RenameColumnOperations': [
{
'ColumnName': 'string',
'NewColumnName': 'string'
},
]
},
'CastColumnTypesStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'CastColumnTypeOperations': [
{
'ColumnName': 'string',
'NewColumnType': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED',
'Format': 'string'
},
]
},
'JoinStep': {
'Alias': 'string',
'LeftOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'RightOperand': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'Type': 'INNER'|'OUTER'|'LEFT'|'RIGHT',
'OnClause': 'string',
'LeftOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
},
'RightOperandProperties': {
'OutputColumnNameOverrides': [
{
'SourceColumnName': 'string',
'OutputColumnName': 'string'
},
]
}
},
'AggregateStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'Aggregations': [
{
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
},
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
},
'PivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'GroupByColumnNames': [
'string',
],
'ValueColumnConfiguration': {
'AggregationFunction': {
'SimpleAggregation': {
'InputColumnName': 'string',
'FunctionType': 'COUNT'|'DISTINCT_COUNT'|'SUM'|'AVERAGE'|'MAX'|'MIN'
},
'ListAggregation': {
'InputColumnName': 'string',
'Separator': 'string',
'Distinct': True|False
}
}
},
'PivotConfiguration': {
'LabelColumnName': 'string',
'PivotedLabels': [
{
'LabelName': 'string',
'NewColumnName': 'string',
'NewColumnId': 'string'
},
]
}
},
'UnpivotStep': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'ColumnsToUnpivot': [
{
'ColumnName': 'string',
'NewValue': 'string'
},
],
'UnpivotedLabelColumnName': 'string',
'UnpivotedLabelColumnId': 'string',
'UnpivotedValueColumnName': 'string',
'UnpivotedValueColumnId': 'string'
},
'AppendStep': {
'Alias': 'string',
'FirstSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'SecondSource': {
'TransformOperationId': 'string',
'ColumnIdMappings': [
{
'SourceColumnId': 'string',
'TargetColumnId': 'string'
},
]
},
'AppendedColumns': [
{
'ColumnName': 'string',
'NewColumnId': 'string'
},
]
}
}
},
'DestinationTableMap': {
'string': {
'Alias': 'string',
'Source': {
'TransformOperationId': 'string'
}
}
}
},
SemanticModelConfiguration={
'TableMap': {
'string': {
'Alias': 'string',
'DestinationTableId': 'string',
'RowLevelPermissionConfiguration': {
'TagConfiguration': {
'Status': 'ENABLED'|'DISABLED',
'TagRules': [
{
'TagKey': 'string',
'ColumnName': 'string',
'TagMultiValueDelimiter': 'string',
'MatchAllValue': 'string'
},
],
'TagRuleConfigurations': [
[
'string',
],
]
},
'RowLevelPermissionDataSet': {
'Namespace': 'string',
'Arn': 'string',
'PermissionPolicy': 'GRANT_ACCESS'|'DENY_ACCESS',
'FormatVersion': 'VERSION_1'|'VERSION_2',
'Status': 'ENABLED'|'DISABLED'
}
},
'SemanticMetadata': {
'ColumnMetadata': [
{
'ColumnNames': [
'string',
],
'ColumnProperties': [
{
'Description': {
'Text': 'string'
},
'AdditionalNotes': {
'Text': 'string'
},
'SemanticType': {
'GeographicalRole': 'COUNTRY'|'STATE'|'COUNTY'|'CITY'|'POSTCODE'|'LONGITUDE'|'LATITUDE'
}
},
]
},
]
}
}
},
'SemanticMetadata': [
{
'Description': {
'Text': 'string'
},
'CustomInstructions': [
{
'InlineCustomInstruction': {
'InstructionText': 'string',
'UploadedDocumentMetadata': {
'Name': 'string'
}
}
},
]
},
]
},
UnmaterializedCalculatedColumns=[
{
'ColumnId': 'string',
'ColumnName': 'string',
'Expression': 'string',
'Type': 'STRING'|'INTEGER'|'DECIMAL'|'DATETIME',
'SubType': 'FLOAT'|'FIXED'
},
]
)
string
[REQUIRED]
The Amazon Web Services account ID.
string
[REQUIRED]
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
string
[REQUIRED]
The display name for the dataset.
dict
[REQUIRED]
Declares the physical tables that are available in the underlying data sources.
(string) --
(dict) --
A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
RelationalTable (dict) --
A physical table type for relational data sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
Catalog (string) --
The catalog associated with a table.
Schema (string) --
The schema name. This name applies to certain relational database engines.
Name (string) -- [REQUIRED]
The name of the relational table.
InputColumns (list) -- [REQUIRED]
The column schema of the table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
CustomSql (dict) --
A physical table type built from the results of the custom SQL query.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the data source.
Name (string) -- [REQUIRED]
A display name for the SQL query result.
SqlQuery (string) -- [REQUIRED]
The SQL query.
Columns (list) --
The column schema from the SQL query result set.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
S3Source (dict) --
A physical table type for an S3 data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the S3 source file or files.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
InputColumns (list) -- [REQUIRED]
A physical table type for an S3 data source.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
SaaSTable (dict) --
A physical table type for Software-as-a-Service (SaaS) sources.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the SaaS data source.
TablePath (list) -- [REQUIRED]
The hierarchical path to the table within the SaaS data source.
(dict) --
An element in the hierarchical path to a table within a data source, containing both name and identifier.
Name (string) --
The name of the path element.
Id (string) --
The unique identifier of the path element.
InputColumns (list) -- [REQUIRED]
The list of input columns available from the SaaS table.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
FileSource (dict) --
A physical table type for a file data source.
DataSourceArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) for the data source.
UploadSettings (dict) --
Information about the format for the source file.
Format (string) --
File format.
StartFromRow (integer) --
A row number to start reading data from.
ContainsHeader (boolean) --
Whether the file has a header row, or the files each have a header row.
TextQualifier (string) --
Text qualifier.
Delimiter (string) --
The delimiter between values in the file.
CustomCellAddressRange (string) --
A custom cell address range for Excel files, specifying which cells to import from the spreadsheet.
SheetIndex (integer) -- [REQUIRED]
The zero-based index of the sheet to use within the file. For files that contain multiple sheets, this identifies which sheet to read. Files that contain a single sheet, or that have no concept of sheets, use sheet 0.
InputColumns (list) -- [REQUIRED]
The column schema of the file.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
dict
Configures the combination and transformation of the data from the physical tables. This parameter is used with the legacy data preparation experience.
(string) --
An identifier for the logical table that is defined in the dataset
(dict) --
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
Alias (string) -- [REQUIRED]
A display name for the logical table.
DataTransforms (list) --
Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
(dict) --
A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ProjectOperation (dict) --
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FilterOperation (dict) --
An operation that filters rows based on some condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) -- [REQUIRED]
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsOperation (dict) --
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnOperation (dict) --
An operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypeOperation (dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
TagColumnOperation (dict) --
An operation that tags a column with additional information.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
Tags (list) -- [REQUIRED]
The dataset column tag, currently only used for geospatial type tagging.
(dict) --
A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
ColumnGeographicRole (string) --
A geospatial role for a column.
ColumnDescription (dict) --
A description for a column.
Text (string) --
The text of a description for a column.
UntagColumnOperation (dict) --
A transform operation that removes tags associated with a column.
ColumnName (string) -- [REQUIRED]
The column that this operation acts on.
TagNames (list) -- [REQUIRED]
The column tags to remove from this column.
(string) --
OverrideDatasetParameterOperation (dict) --
A transform operation that overrides the dataset parameter values that are defined in another dataset.
ParameterName (string) -- [REQUIRED]
The name of the parameter to be overridden with different values.
NewParameterName (string) --
The new name for the parameter.
NewDefaultValues (dict) --
The new default values for the parameter.
StringStaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalStaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
DateTimeStaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
IntegerStaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
Source (dict) -- [REQUIRED]
Source of this logical table.
JoinInstruction (dict) --
Specifies the result of a join of two logical tables.
LeftOperand (string) -- [REQUIRED]
The operand on the left side of a join.
RightOperand (string) -- [REQUIRED]
The operand on the right side of a join.
LeftJoinKeyProperties (dict) --
Join key properties of the left operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
RightJoinKeyProperties (dict) --
Join key properties of the right operand.
UniqueKey (boolean) --
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Quick Sight to optimize query performance.
Type (string) -- [REQUIRED]
The type of join that it is.
OnClause (string) -- [REQUIRED]
The join instructions provided in the ON clause of a join.
PhysicalTableId (string) --
Physical table ID.
DataSetArn (string) --
The Amazon Resource Number (ARN) of the parent dataset.
string
[REQUIRED]
Indicates whether you want to import the data into SPICE.
list
Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.
(dict) --
Groupings of columns that work together in certain Quick Sight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
GeoSpatialColumnGroup (dict) --
Geospatial column group that denotes a hierarchy.
Name (string) -- [REQUIRED]
A display name for the hierarchy.
CountryCode (string) --
Country code.
Columns (list) -- [REQUIRED]
Columns in this hierarchy.
(string) --
dict
The folder that contains fields and nested subfolders for your dataset.
(string) --
(dict) --
A FieldFolder element is a folder that contains fields and nested subfolders.
description (string) --
The description for a field folder.
columns (list) --
A folder has a list of columns. A column can only be in one folder.
(string) --
dict
The row-level security configuration for the data you want to create. This parameter is used with the legacy data preparation experience.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
dict
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only. This parameter is used with the legacy data preparation experience.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
list
A set of one or more definitions of a ``ColumnLevelPermissionRule ``.
(dict) --
A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.
Principals (list) --
An array of Amazon Resource Names (ARNs) for Quick Sight users or groups.
(string) --
ColumnNames (list) --
An array of column names.
(string) --
dict
The usage configuration to apply to child datasets that reference this dataset as a source.
DisableUseAsDirectQuerySource (boolean) --
An option that controls whether a child dataset of a direct query can use this dataset as a source.
DisableUseAsImportedSource (boolean) --
An option that controls whether a child dataset that's stored in Quick Sight can use this dataset as a source.
list
The parameter declarations of the dataset.
(dict) --
A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.
StringDatasetParameter (dict) --
A string parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the string parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the string parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given string dataset parameter type. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given string parameter.
(string) --
The default value for the string parameter.
DecimalDatasetParameter (dict) --
A decimal parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the decimal parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the decimal parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given decimal parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given decimal parameter.
(float) --
The default value for the decimal parameter.
IntegerDatasetParameter (dict) --
An integer parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the integer parameter created in the dataset.
Name (string) -- [REQUIRED]
The name of the integer parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
DefaultValues (dict) --
A list of default values for a given integer parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given integer parameter.
(integer) --
The default value for the integer parameter.
DateTimeDatasetParameter (dict) --
A date time parameter that is created in the dataset.
Id (string) -- [REQUIRED]
An identifier for the parameter that is created in the dataset.
Name (string) -- [REQUIRED]
The name of the date time parameter that is created in the dataset.
ValueType (string) -- [REQUIRED]
The value type of the dataset parameter. Valid values are single value or multi value.
TimeGranularity (string) --
The time granularity of the date time parameter.
DefaultValues (dict) --
A list of default values for a given date time parameter. This structure only accepts static values.
StaticValues (list) --
A list of static default values for a given date time parameter.
(datetime) --
The default value for the date time parameter.
dict
The configuration for the performance optimization of the dataset that contains a UniqueKey configuration.
UniqueKeys (list) --
A UniqueKey configuration.
(dict) --
A UniqueKey configuration that references a dataset column.
ColumnNames (list) -- [REQUIRED]
The name of the column that is referenced in the UniqueKey configuration.
(string) --
dict
The data preparation configuration for the dataset. This configuration defines the source tables, transformation steps, and destination tables used to prepare the data. Required when using the new data preparation experience.
SourceTableMap (dict) -- [REQUIRED]
A map of source tables that provide information about underlying sources.
(string) --
(dict) --
A source table that provides initial data from either a physical table or parent dataset.
PhysicalTableId (string) --
The identifier of the physical table that serves as the data source.
DataSet (dict) --
A parent dataset that serves as the data source instead of a physical table.
DataSetArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the parent dataset.
InputColumns (list) -- [REQUIRED]
The list of input columns available from the parent dataset.
(dict) --
Metadata for a column that is used as the input of a transform operation.
Name (string) -- [REQUIRED]
The name of this column in the underlying data source.
Id (string) --
A unique identifier for the input column.
Type (string) -- [REQUIRED]
The data type of the column.
Note: SEMISTRUCT represents Athena's map, row, and struct data types. It is supported when using the new data preparation experience.
SubType (string) --
The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
TransformStepMap (dict) -- [REQUIRED]
A map of transformation steps that process the data.
(string) --
(dict) --
A step in data preparation that performs a specific operation on the data.
ImportTableStep (dict) --
A transform step that brings data from a source table.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source configuration that specifies which source table to import and any column mappings.
SourceTableId (string) -- [REQUIRED]
The identifier of the source table to import data from.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers during the import.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectStep (dict) --
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for column projection.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ProjectedColumns (list) -- [REQUIRED]
Projected columns.
(string) --
FiltersStep (dict) --
A transform step that applies filter conditions.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for filtering.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
FilterOperations (list) -- [REQUIRED]
The list of filter operations to apply.
(dict) --
A transform operation that filters rows based on a condition.
ConditionExpression (string) --
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
StringFilterCondition (dict) --
A string-based filter condition within a filter operation.
ColumnName (string) --
The name of the string column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the string column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, CONTAINS, STARTS_WITH, ENDS_WITH, or their negations.
Value (dict) --
The string value to compare against.
StaticValue (string) --
A static string value used for filtering.
ListFilterCondition (dict) --
A list-based filter condition that includes or excludes values from a specified list.
Operator (string) -- [REQUIRED]
The list operator to use, either INCLUDE to match values in the list or EXCLUDE to filter out values in the list.
Values (dict) --
The list of string values to include or exclude in the filter.
StaticValues (list) --
A list of static string values used for filtering.
(string) --
NumericFilterCondition (dict) --
A numeric-based filter condition within a filter operation.
ColumnName (string) --
The name of the numeric column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the numeric column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as EQUALS, GREATER_THAN, LESS_THAN, or their variants.
Value (dict) --
The numeric value to compare against.
StaticValue (float) --
A static numeric value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the numeric column, filtering values between minimum and maximum numbers.
RangeMinimum (dict) --
The minimum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
RangeMaximum (dict) --
The maximum numeric value for the range filter.
StaticValue (float) --
A static numeric value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
DateFilterCondition (dict) --
A date-based filter condition within a filter operation.
ColumnName (string) --
The name of the date column to filter.
ComparisonFilterCondition (dict) --
A comparison-based filter condition for the date column.
Operator (string) -- [REQUIRED]
The comparison operator to use, such as BEFORE, BEFORE_OR_EQUALS_TO, AFTER, or AFTER_OR_EQUALS_TO.
Value (dict) --
The date value to compare against.
StaticValue (datetime) --
A static date value used for filtering.
RangeFilterCondition (dict) --
A range-based filter condition for the date column, filtering values between minimum and maximum dates.
RangeMinimum (dict) --
The minimum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
RangeMaximum (dict) --
The maximum date value for the range filter.
StaticValue (datetime) --
A static date value used for filtering.
IncludeMinimum (boolean) --
Whether to include the minimum value in the filter range.
IncludeMaximum (boolean) --
Whether to include the maximum value in the filter range.
CreateColumnsStep (dict) --
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Alias (string) --
Alias for this operation.
Source (dict) --
The source transform operation that provides input data for creating new calculated columns.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Columns (list) -- [REQUIRED]
Calculated columns to create.
(dict) --
A calculated column for a dataset.
ColumnName (string) -- [REQUIRED]
Column name.
ColumnId (string) -- [REQUIRED]
A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Quick Sight preserves the existing calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the calculated column.
RenameColumnsStep (dict) --
A transform step that changes the names of one or more columns.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for column renaming.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
RenameColumnOperations (list) -- [REQUIRED]
The list of column rename operations to perform, specifying old and new column names.
(dict) --
A transform operation that renames a column.
ColumnName (string) -- [REQUIRED]
The name of the column to be renamed.
NewColumnName (string) -- [REQUIRED]
The new name for the column.
CastColumnTypesStep (dict) --
A transform step that changes the data types of one or more columns.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for the type casting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
CastColumnTypeOperations (list) -- [REQUIRED]
The list of column type casting operations to perform.
(dict) --
A transform operation that casts a column to a different type.
ColumnName (string) -- [REQUIRED]
Column name.
NewColumnType (string) -- [REQUIRED]
New column data type.
SubType (string) --
The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
Format (string) --
When casting a column from string to datetime type, you can supply a string in a format supported by Quick Sight to denote the source data format.
JoinStep (dict) --
A transform step that combines data from two sources based on specified join conditions.
Alias (string) -- [REQUIRED]
Alias for this operation.
LeftOperand (dict) -- [REQUIRED]
The left operand for the join operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
RightOperand (dict) -- [REQUIRED]
The right operand for the join operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
Type (string) -- [REQUIRED]
The type of join to perform, such as INNER, LEFT, RIGHT, or OUTER.
OnClause (string) -- [REQUIRED]
The join condition that specifies how to match rows between the left and right operands.
LeftOperandProperties (dict) --
Properties that control how the left operand's columns are handled in the join result.
OutputColumnNameOverrides (list) -- [REQUIRED]
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) -- [REQUIRED]
The new name to assign to the column in the output.
RightOperandProperties (dict) --
Properties that control how the right operand's columns are handled in the join result.
OutputColumnNameOverrides (list) -- [REQUIRED]
A list of column name overrides to apply to the join operand's output columns.
(dict) --
Specifies a mapping to override the name of an output column from a transform operation.
SourceColumnName (string) --
The original name of the column from the source transform operation.
OutputColumnName (string) -- [REQUIRED]
The new name to assign to the column in the output.
AggregateStep (dict) --
A transform step that groups data and applies aggregation functions to calculate summary values.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for the aggregation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the aggregation. Rows with the same values in these columns will be grouped together.
(string) --
Aggregations (list) -- [REQUIRED]
The list of aggregation functions to apply to the grouped data, such as SUM, COUNT, or AVERAGE.
(dict) --
Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.
AggregationFunction (dict) -- [REQUIRED]
The aggregation function to apply, such as SUM, COUNT, AVERAGE, MIN, MAX
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) -- [REQUIRED]
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) -- [REQUIRED]
The string used to separate values in the concatenated result.
Distinct (boolean) -- [REQUIRED]
Whether to include only distinct values in the concatenated result, removing duplicates.
NewColumnName (string) -- [REQUIRED]
The name for the new column that will contain the aggregated values.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the aggregated values.
PivotStep (dict) --
A transform step that converts row values into columns to reshape the data structure.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for pivoting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
GroupByColumnNames (list) --
The list of column names to group by when performing the pivot operation.
(string) --
ValueColumnConfiguration (dict) -- [REQUIRED]
Configuration for how to aggregate values when multiple rows map to the same pivoted column.
AggregationFunction (dict) --
The aggregation function to apply when multiple values map to the same pivoted cell.
SimpleAggregation (dict) --
A simple aggregation function such as SUM, COUNT, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
InputColumnName (string) --
The name of the column on which to perform the aggregation function.
FunctionType (string) -- [REQUIRED]
The type of aggregation function to perform, such as COUNT, SUM, AVERAGE, MIN, MAX, MEDIAN, VARIANCE, or STANDARD_DEVIATION.
ListAggregation (dict) --
A list aggregation function that concatenates values from multiple rows into a single delimited string.
InputColumnName (string) --
The name of the column containing values to be concatenated.
Separator (string) -- [REQUIRED]
The string used to separate values in the concatenated result.
Distinct (boolean) -- [REQUIRED]
Whether to include only distinct values in the concatenated result, removing duplicates.
PivotConfiguration (dict) -- [REQUIRED]
Configuration that specifies which labels to pivot and how to structure the resulting columns.
LabelColumnName (string) --
The name of the column that contains the labels to be pivoted into separate columns.
PivotedLabels (list) -- [REQUIRED]
The list of specific label values to pivot into separate columns.
(dict) --
Specifies a label value to be pivoted into a separate column, including the new column name and identifier.
LabelName (string) -- [REQUIRED]
The label value from the source data to be pivoted.
NewColumnName (string) -- [REQUIRED]
The name for the new column created from this pivoted label.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the new column created from this pivoted label.
UnpivotStep (dict) --
A transform step that converts columns into rows to normalize the data structure.
Alias (string) -- [REQUIRED]
Alias for this operation.
Source (dict) -- [REQUIRED]
The source transform operation that provides input data for unpivoting.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
ColumnsToUnpivot (list) -- [REQUIRED]
The list of columns to unpivot from the source data.
(dict) --
Specifies a column to be unpivoted, transforming it from a column into rows with associated values.
ColumnName (string) --
The name of the column to unpivot from the source data.
NewValue (string) --
The value to assign to this column in the unpivoted result, typically the column name or a descriptive label.
UnpivotedLabelColumnName (string) -- [REQUIRED]
The name for the new column that will contain the unpivoted column names.
UnpivotedLabelColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the unpivoted column names.
UnpivotedValueColumnName (string) -- [REQUIRED]
The name for the new column that will contain the unpivoted values.
UnpivotedValueColumnId (string) -- [REQUIRED]
A unique identifier for the new column that will contain the unpivoted values.
AppendStep (dict) --
A transform step that combines rows from multiple sources by stacking them vertically.
Alias (string) -- [REQUIRED]
Alias for this operation.
FirstSource (dict) --
The first data source to be included in the append operation.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
SecondSource (dict) --
The second data source to be appended to the first source.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides input data.
ColumnIdMappings (list) --
The mappings between source column identifiers and target column identifiers for this transformation.
(dict) --
Maps a source column identifier to a target column identifier during transform operations.
SourceColumnId (string) -- [REQUIRED]
Source column ID.
TargetColumnId (string) -- [REQUIRED]
Target column ID.
AppendedColumns (list) -- [REQUIRED]
The list of columns to include in the appended result, mapping columns from both sources.
(dict) --
Represents a column that will be included in the result of an append operation, combining data from multiple sources.
ColumnName (string) -- [REQUIRED]
The name of the column to include in the appended result.
NewColumnId (string) -- [REQUIRED]
A unique identifier for the column in the appended result.
DestinationTableMap (dict) -- [REQUIRED]
A map of destination tables that receive the final prepared data.
(string) --
(dict) --
Defines a destination table in data preparation that receives the final transformed data.
Alias (string) -- [REQUIRED]
Alias for the destination table.
Source (dict) -- [REQUIRED]
The source configuration that specifies which transform operation provides data to this destination table.
TransformOperationId (string) -- [REQUIRED]
The identifier of the transform operation that provides data to the destination table.
dict
The semantic model configuration for the dataset. This configuration defines how the prepared data is structured for an analysis, including table mappings and row-level security configurations. Required when using the new data preparation experience.
TableMap (dict) --
A map of semantic tables that define the analytical structure.
(string) --
(dict) --
A semantic table that represents the final analytical structure of the data.
Alias (string) -- [REQUIRED]
Alias for the semantic table.
DestinationTableId (string) -- [REQUIRED]
The identifier of the destination table from data preparation that provides data to this semantic table.
RowLevelPermissionConfiguration (dict) --
Configuration for row level security that control data access for this semantic table.
TagConfiguration (dict) --
The configuration of tags on a dataset to set row-level security.
Status (string) --
The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
TagRules (list) -- [REQUIRED]
A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
(dict) --
A set of rules associated with a tag.
TagKey (string) -- [REQUIRED]
The unique key for a tag.
ColumnName (string) -- [REQUIRED]
The column name that a tag key is assigned to.
TagMultiValueDelimiter (string) --
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
MatchAllValue (string) --
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
TagRuleConfigurations (list) --
A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
(list) --
(string) --
RowLevelPermissionDataSet (dict) --
Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Quick Sight User Guide.
The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.
Namespace (string) --
The namespace associated with the dataset that contains permissions for RLS.
Arn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
PermissionPolicy (string) -- [REQUIRED]
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
FormatVersion (string) --
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
Status (string) --
The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
SemanticMetadata (dict) --
The column-level semantic metadata for this semantic table.
ColumnMetadata (list) --
A list of column semantic metadata entries.
(dict) --
Semantic metadata shared across one or more columns.
ColumnNames (list) --
The names of the columns this metadata applies to.
(string) --
ColumnProperties (list) -- [REQUIRED]
The semantic properties for the specified columns.
(dict) --
A semantic property for a column.
Description (dict) --
A description of the column.
Text (string) --
The text of a description for a column.
AdditionalNotes (dict) --
Additional notes for the column.
Text (string) --
The additional notes text.
SemanticType (dict) --
The semantic type of the column.
GeographicalRole (string) --
The geographical role of the column in the new data preparation experience.
SemanticMetadata (list) --
The dataset-level semantic metadata, including a description and custom instructions.
(dict) --
Semantic metadata for a dataset, including a description and custom instructions.
Description (dict) --
A description of the dataset.
Text (string) -- [REQUIRED]
The descriptive text for the dataset.
CustomInstructions (list) --
A list of custom instructions that guide how the dataset should be consumed.
(dict) --
A custom instruction that provides guidance on how the dataset should be consumed.
InlineCustomInstruction (dict) --
An inline custom instruction containing text and optional uploaded document metadata.
InstructionText (string) -- [REQUIRED]
The instruction text content.
UploadedDocumentMetadata (dict) --
Metadata about an uploaded document associated with this instruction.
Name (string) --
The name of the uploaded document.
list
A list of unmaterialized calculated columns for the dataset. These columns are computed at analysis time and are not stored in the prepared data. You can only use this with the new data preparation experience.
(dict) --
A calculated column that is not materialized in the prepared data. The column is computed at analysis time and can use aggregate expressions.
ColumnId (string) -- [REQUIRED]
A unique ID to identify the unmaterialized calculated column.
ColumnName (string) -- [REQUIRED]
The name of the unmaterialized calculated column.
Expression (string) -- [REQUIRED]
An expression that defines the unmaterialized calculated column.
Type (string) --
The data type of the unmaterialized calculated column.
SubType (string) --
The sub data type of the unmaterialized calculated column.
dict
Response Syntax
{
'Arn': 'string',
'DataSetId': 'string',
'IngestionArn': 'string',
'IngestionId': 'string',
'RequestId': 'string',
'Status': 123
}
Response Structure
(dict) --
Arn (string) --
The Amazon Resource Name (ARN) of the dataset.
DataSetId (string) --
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
IngestionArn (string) --
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
IngestionId (string) --
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
RequestId (string) --
The Amazon Web Services request ID for this operation.
Status (integer) --
The HTTP status of the request.
{'Credentials': {'CredentialPair': {'AlternateDataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}},
'DataSourceParameters': {'RedshiftParameters': {'FederatedCatalog': 'string'}}}
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',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
Credentials={
'CredentialPair': {
'Username': 'string',
'Password': 'string',
'AlternateDataSourceParameters': [
{
'AmazonElasticsearchParameters': {
'Domain': 'string'
},
'AthenaParameters': {
'WorkGroup': 'string',
'RoleArn': 'string',
'ConsumerAccountRoleArn': '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',
'FederatedCatalog': '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'
},
'S3TablesParameters': {
'TableBucketArn': 'string'
},
'S3KnowledgeBaseParameters': {
'RoleArn': 'string',
'BucketUrl': 'string',
'MetadataFilesLocation': 'string'
},
'ServiceNowParameters': {
'SiteBaseUrl': 'string'
},
'SnowflakeParameters': {
'Host': 'string',
'Database': 'string',
'Warehouse': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'DatabaseAccessControlRole': 'string',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': 'string'
}
},
'StarburstParameters': {
'Host': 'string',
'Port': 123,
'Catalog': 'string',
'ProductType': 'GALAXY'|'ENTERPRISE',
'DatabaseAccessControlRole': 'string',
'AuthenticationType': 'PASSWORD'|'KEYPAIR'|'TOKEN'|'X509',
'OAuthParameters': {
'TokenProviderUrl': 'string',
'OAuthScope': 'string',
'IdentityProviderVpcConnectionProperties': {
'VpcConnectionArn': 'string'
},
'IdentityProviderResourceUri': 'string',
'IdentityProviderCACertificatesBundleS3Uri': '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'
},
'SharePointParameters': {
'SharePointDomain': 'string',
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'GoogleDriveParameters': {
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'OneDriveParameters': {
'TenantId': 'string',
'ClientId': 'string',
'AuthType': 'THREE_LEGGED_OAUTH'|'TWO_LEGGED_OAUTH'|'SERVICE_ACCOUNT'
},
'FMKBParameters': {
'KnowledgeBaseArn': 'string',
'LinkedDataSourceIds': [
'string',
]
}
},
]
},
'CopySourceArn': 'string',
'SecretArn': 'string',
'KeyPairCredentials': {
'KeyPairUsername': 'string',
'PrivateKey': 'string',
'PrivateKeyPassphrase': 'string'
},
'WebProxyCredentials': {
'WebProxyUsername': 'string',
'WebProxyPassword': 'string'
},
'OAuthClientCredentials': {
'ClientId': 'string',
'ClientSecret': 'string',
'Username': 'string'
},
'ServiceAccountCredentials': {
'AdminAccountEmail': 'string',
'ServiceAccountPrivateKey': 'string',
'ClientEmail': 'string'
},
'SharePointClientCredentials': {
'KmsKeyArn': 'string',
'CertThumbprint': 'string'
},
'OneDriveClientCredentials': {
'KmsKeyArn': 'string',
'CertThumbprint': '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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
ConsumerAccountRoleArn (string) --
Use ConsumerAccountRoleArn to perform cross-account Athena access. This is an IAM role ARN in the same AWS account as the Athena resources you want to access. Provide this along with RoleArn to enable role-chaining, where Amazon Quick Sight first assumes the RoleArn and then assumes the ConsumerAccountRoleArn to access Athena resources.
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.
FederatedCatalog (string) --
The federated database to use for table and schema discovery. Specify the exact database name returned by SHOW DATABASES, such as producer_database@catalog_name. This value must differ from Database, which specifies the database used for the connection.
For UpdateDataSource, omit this parameter to keep the current catalog, or specify an empty string to clear the configured catalog.
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.
S3TablesParameters (dict) --
The parameters for S3 Tables.
TableBucketArn (string) --
The Amazon Resource Name (ARN) of the S3 Tables bucket.
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 Amazon S3 location (prefix) of per-document metadata files. Each metadata file describes a single source document and its indexable attributes, such as title, category, and version. This is not the global ACL configuration file. To apply a single global ACL file to the entire knowledge base, use the access control configuration instead.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
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 Databricks.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
IdentityProviderCACertificatesBundleS3Uri (string) --
The S3 URI of the identity provider's CA certificates bundle in PEM format. Use this parameter to provide a custom CA certificate bundle for the identity provider when the default trust store does not include the required certificates.
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.
SharePointParameters (dict) --
The parameters for a SharePoint data source.
SharePointDomain (string) -- [REQUIRED]
The SharePoint domain for the data source.
TenantId (string) --
The tenant ID for the SharePoint data source.
ClientId (string) --
The client ID for the SharePoint data source.
AuthType (string) --
The authentication type for the SharePoint data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
GoogleDriveParameters (dict) --
The parameters for a Google Drive data source.
AuthType (string) --
The authentication type for the Google Drive data source. Valid values include:
SERVICE_ACCOUNT – Server-to-server authentication using a Google service account key.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
OneDriveParameters (dict) --
The parameters for an OneDrive data source.
TenantId (string) --
The tenant ID for the OneDrive data source.
ClientId (string) --
The client ID for the OneDrive data source.
AuthType (string) --
The authentication type for the OneDrive data source. Valid values include:
TWO_LEGGED_OAUTH – Server-to-server authentication using client credentials that do not require user interaction.
THREE_LEGGED_OAUTH – Interactive OAuth that requires user consent.
FMKBParameters (dict) --
The parameters for a fully managed knowledge base data source.
KnowledgeBaseArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Amazon Bedrock knowledge base.
LinkedDataSourceIds (list) --
The IDs of the linked data sources.
(string) --
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.
KeyPairCredentials (dict) --
The credentials for connecting using key-pair.
KeyPairUsername (string) -- [REQUIRED]
Username
PrivateKey (string) -- [REQUIRED]
PrivateKey
PrivateKeyPassphrase (string) --
PrivateKeyPassphrase
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.
OAuthClientCredentials (dict) --
The OAuth client credentials for connecting to a data source using OAuth 2.0 client credentials (2LO) authentication. For more information, see ``OAuthClientCredentials ``.
ClientId (string) --
The client ID of the OAuth 2.0 application that is registered with the data source provider.
ClientSecret (string) --
The client secret of the OAuth 2.0 application that is registered with the data source provider.
Username (string) --
The username of the account that is used for OAuth 2.0 client credentials authentication with the data source provider.
ServiceAccountCredentials (dict) --
The service account credentials for connecting to a data source that uses Google Workspace domain-wide delegation.
AdminAccountEmail (string) -- [REQUIRED]
The email address of the Google Workspace administrator account that the service account impersonates through domain-wide delegation. This field is required.
ServiceAccountPrivateKey (string) -- [REQUIRED]
The private key of the Google service account used for domain-wide delegation. This field is required.
ClientEmail (string) -- [REQUIRED]
The client email address of the Google service account used for domain-wide delegation. This field is required.
SharePointClientCredentials (dict) --
The client credentials for connecting to a Microsoft SharePoint data source using two-legged OAuth (2LO) certificate-based authentication.
KmsKeyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the SharePoint certificate credentials. This field is required.
CertThumbprint (string) -- [REQUIRED]
The thumbprint of the certificate used for two-legged OAuth (2LO) authentication to SharePoint. This field is required.
OneDriveClientCredentials (dict) --
The client credentials for connecting to a Microsoft OneDrive data source using two-legged OAuth (2LO) certificate-based authentication.
KmsKeyArn (string) -- [REQUIRED]
The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the OneDrive certificate credentials. This field is required.
CertThumbprint (string) -- [REQUIRED]
The thumbprint of the certificate used for two-legged OAuth (2LO) authentication to OneDrive. This field is required.
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.