Amazon QuickSight 2018-04-01
- Client: Aws\QuickSight\QuickSightClient
- Service ID: quicksight
- Version: 2018-04-01
This page describes the parameters and results for the operations of the Amazon QuickSight (2018-04-01), and shows how to use the Aws\QuickSight\QuickSightClient object to call the described operations. This documentation is specific to the 2018-04-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CancelIngestion ( array $params = [] )
Cancels an on-going ingestion of data into SPICE.
- CreateDashboard ( array $params = [] )
Creates a dashboard from a template.
- CreateDataSet ( array $params = [] )
Creates a dataset.
- CreateDataSource ( array $params = [] )
Creates a data source.
- CreateGroup ( array $params = [] )
Creates an Amazon QuickSight group.
- CreateGroupMembership ( array $params = [] )
Adds an Amazon QuickSight user to an Amazon QuickSight group.
- CreateIAMPolicyAssignment ( array $params = [] )
Creates an assignment with one specified IAM policy ARN and will assigned to specified groups or users of QuickSight.
- CreateIngestion ( array $params = [] )
Creates and starts a new SPICE ingestion on a dataset Any ingestions operating on tagged datasets inherit the same tags automatically for use in access-control.
- CreateTemplate ( array $params = [] )
Creates a template from an existing QuickSight analysis or template.
- CreateTemplateAlias ( array $params = [] )
Creates a template alias for a template.
- DeleteDashboard ( array $params = [] )
Deletes a dashboard.
- DeleteDataSet ( array $params = [] )
Deletes a dataset.
- DeleteDataSource ( array $params = [] )
Deletes the data source permanently.
- DeleteGroup ( array $params = [] )
Removes a user group from Amazon QuickSight.
- DeleteGroupMembership ( array $params = [] )
Removes a user from a group so that the user is no longer a member of the group.
- DeleteIAMPolicyAssignment ( array $params = [] )
Deletes an existing assignment.
- DeleteTemplate ( array $params = [] )
Deletes a template.
- DeleteTemplateAlias ( array $params = [] )
Update template alias of given template.
- DeleteUser ( array $params = [] )
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call.
- DeleteUserByPrincipalId ( array $params = [] )
Deletes a user identified by its principal ID.
- DescribeDashboard ( array $params = [] )
Provides a summary for a dashboard.
- DescribeDashboardPermissions ( array $params = [] )
Describes read and write permissions on a dashboard.
- DescribeDataSet ( array $params = [] )
Describes a dataset.
- DescribeDataSetPermissions ( array $params = [] )
Describes the permissions on a dataset.
- DescribeDataSource ( array $params = [] )
Describes a data source.
- DescribeDataSourcePermissions ( array $params = [] )
Describes the resource permissions for a data source.
- DescribeGroup ( array $params = [] )
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
- DescribeIAMPolicyAssignment ( array $params = [] )
Describes an existing IAMPolicy Assignment by specified assignment name.
- DescribeIngestion ( array $params = [] )
Describes a SPICE ingestion.
- DescribeTemplate ( array $params = [] )
Describes a template's metadata.
- DescribeTemplateAlias ( array $params = [] )
Describes the template aliases of a template.
- DescribeTemplatePermissions ( array $params = [] )
Describes read and write permissions on a template.
- DescribeUser ( array $params = [] )
Returns information about a user, given the user name.
- GetDashboardEmbedUrl ( array $params = [] )
Generates a server-side embeddable URL and authorization code.
- ListDashboardVersions ( array $params = [] )
Lists all the versions of the dashboards in the Quicksight subscription.
- ListDashboards ( array $params = [] )
Lists dashboards in the AWS account.
- ListDataSets ( array $params = [] )
Lists all of the datasets belonging to this account in an AWS region.
- ListDataSources ( array $params = [] )
Lists data sources in current AWS region that belong to this AWS account.
- ListGroupMemberships ( array $params = [] )
Lists member users in a group.
- ListGroups ( array $params = [] )
Lists all user groups in Amazon QuickSight.
- ListIAMPolicyAssignments ( array $params = [] )
Lists assignments in current QuickSight account.
- ListIAMPolicyAssignmentsForUser ( array $params = [] )
Lists all the assignments and the ARNs for the associated IAM policies assigned to the specified user and the group or groups that the user belongs to.
- ListIngestions ( array $params = [] )
Lists the history of SPICE ingestions for a dataset.
- ListTagsForResource ( array $params = [] )
Lists the tags assigned to a resource.
- ListTemplateAliases ( array $params = [] )
Lists all the aliases of a template.
- ListTemplateVersions ( array $params = [] )
Lists all the versions of the templates in the Quicksight account.
- ListTemplates ( array $params = [] )
Lists all the templates in the QuickSight account.
- ListUserGroups ( array $params = [] )
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
- ListUsers ( array $params = [] )
Returns a list of all of the Amazon QuickSight users belonging to this account.
- RegisterUser ( array $params = [] )
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
- TagResource ( array $params = [] )
Assigns a tag or tags to a resource.
- UntagResource ( array $params = [] )
Removes a tag or tags from a resource.
- UpdateDashboard ( array $params = [] )
Updates a dashboard in the AWS account.
- UpdateDashboardPermissions ( array $params = [] )
Updates read and write permissions on a dashboard.
- UpdateDashboardPublishedVersion ( array $params = [] )
Updates the published version of a dashboard.
- UpdateDataSet ( array $params = [] )
Updates a dataset.
- UpdateDataSetPermissions ( array $params = [] )
Updates the permissions on a dataset.
- UpdateDataSource ( array $params = [] )
Updates a data source.
- UpdateDataSourcePermissions ( array $params = [] )
Updates the permissions to a data source.
- UpdateGroup ( array $params = [] )
Changes a group description.
- UpdateIAMPolicyAssignment ( array $params = [] )
Updates an existing assignment.
- UpdateTemplate ( array $params = [] )
Updates a template from an existing QuickSight analysis.
- UpdateTemplateAlias ( array $params = [] )
Updates the template alias of a template.
- UpdateTemplatePermissions ( array $params = [] )
Updates the permissions on a template.
- UpdateUser ( array $params = [] )
Updates an Amazon QuickSight user.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CancelIngestion
$result = $client->cancelIngestion([/* ... */]); $promise = $client->cancelIngestionAsync([/* ... */]);
Cancels an on-going ingestion of data into SPICE.
Parameter Syntax
$result = $client->cancelIngestion([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'IngestionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'IngestionId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The resource specified already exists.
-
An internal failure occurred.
CreateDashboard
$result = $client->createDashboard([/* ... */]); $promise = $client->createDashboardAsync([/* ... */]);
Creates a dashboard from a template. To first create a template, see the CreateTemplate API.
A dashboard is an entity in QuickSight which identifies Quicksight reports, created from analyses. QuickSight dashboards are sharable. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard and ListDashboardsByUser APIs act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.
CLI syntax:
aws quicksight create-dashboard --cli-input-json file://create-dashboard.json
Parameter Syntax
$result = $client->createDashboard([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'DashboardPublishOptions' => [
'AdHocFilteringOption' => [
'AvailabilityStatus' => 'ENABLED|DISABLED',
],
'ExportToCSVOption' => [
'AvailabilityStatus' => 'ENABLED|DISABLED',
],
'SheetControlsOption' => [
'VisibilityState' => 'EXPANDED|COLLAPSED',
],
],
'Name' => '<string>', // REQUIRED
'Parameters' => [
'DateTimeParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<integer || string || DateTime>, ...], // REQUIRED
],
// ...
],
'DecimalParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<float>, ...], // REQUIRED
],
// ...
],
'IntegerParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<integer>, ...], // REQUIRED
],
// ...
],
'StringParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
],
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'SourceEntity' => [ // REQUIRED
'SourceTemplate' => [
'Arn' => '<string>', // REQUIRED
'DataSetReferences' => [ // REQUIRED
[
'DataSetArn' => '<string>', // REQUIRED
'DataSetPlaceholder' => '<string>', // REQUIRED
],
// ...
],
],
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID where you want to create the dashboard.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard, also added to IAM policy.
- DashboardPublishOptions
-
- Type: DashboardPublishOptions structure
Publishing options when creating dashboard.
-
AvailabilityStatus for AdHocFilteringOption - This can be either
ENABLEDorDISABLED. When This is set to set toDISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default. -
AvailabilityStatus for ExportToCSVOption - This can be either
ENABLEDorDISABLED. The visual option to export data to CSV is disabled when this is set toDISABLED. Enabled by default. -
VisibilityState for SheetControlsOption - This can be either
COLLAPSEDorEXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by default.
Shorthand Syntax:
AdHocFilteringDisabled=boolean,ExportToCSVDisabled=boolean,SheetControlsCollapsed=boolean - Name
-
- Required: Yes
- Type: string
The display name of the dashboard.
- Parameters
-
- Type: Parameters structure
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters and some parameters might accept multiple values. You could use the following structure to override two string parameters that accept multiple values:
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that contains the permissions of the dashboard. You can use this for granting permissions with principal and action information.
- SourceEntity
-
- Required: Yes
- Type: DashboardSourceEntity structure
Source entity from which the dashboard is created. The souce entity accepts the ARN of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.
If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- VersionDescription
-
- Type: string
A description for the first version of the dashboard being created.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'DashboardId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the dashboard.
- CreationStatus
-
- Type: string
The creation status of the dashboard create request.
- DashboardId
-
- Type: string
The ID for the dashboard.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- VersionArn
-
- Type: string
The ARN of the dashboard, including the version number of the first version that is created.
Errors
-
One or more resources can't be found.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
The resource specified already exists.
-
Updating or deleting a resource can cause an inconsistent state.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
CreateDataSet
$result = $client->createDataSet([/* ... */]); $promise = $client->createDataSetAsync([/* ... */]);
Creates a dataset.
CLI syntax:
aws quicksight create-data-set \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--name='My dataset' \
--import-mode=SPICE \
--physical-table-map='{
"physical-table-id": {
"RelationalTable": {
"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
"Name": "table1",
"InputColumns": [
{
"Name": "column1",
"Type": "STRING"
}
]
}
}'
Parameter Syntax
$result = $client->createDataSet([
'AwsAccountId' => '<string>', // REQUIRED
'ColumnGroups' => [
[
'GeoSpatialColumnGroup' => [
'Columns' => ['<string>', ...], // REQUIRED
'CountryCode' => 'US', // REQUIRED
'Name' => '<string>', // REQUIRED
],
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'ImportMode' => 'SPICE|DIRECT_QUERY', // REQUIRED
'LogicalTableMap' => [
'<LogicalTableId>' => [
'Alias' => '<string>', // REQUIRED
'DataTransforms' => [
[
'CastColumnTypeOperation' => [
'ColumnName' => '<string>', // REQUIRED
'Format' => '<string>',
'NewColumnType' => 'STRING|INTEGER|DECIMAL|DATETIME', // REQUIRED
],
'CreateColumnsOperation' => [
'Columns' => [ // REQUIRED
[
'ColumnId' => '<string>', // REQUIRED
'ColumnName' => '<string>', // REQUIRED
'Expression' => '<string>', // REQUIRED
],
// ...
],
],
'FilterOperation' => [
'ConditionExpression' => '<string>', // REQUIRED
],
'ProjectOperation' => [
'ProjectedColumns' => ['<string>', ...], // REQUIRED
],
'RenameColumnOperation' => [
'ColumnName' => '<string>', // REQUIRED
'NewColumnName' => '<string>', // REQUIRED
],
'TagColumnOperation' => [
'ColumnName' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [ // REQUIRED
'JoinInstruction' => [
'LeftOperand' => '<string>', // REQUIRED
'OnClause' => '<string>', // REQUIRED
'RightOperand' => '<string>', // REQUIRED
'Type' => 'INNER|OUTER|LEFT|RIGHT', // REQUIRED
],
'PhysicalTableId' => '<string>',
],
],
// ...
],
'Name' => '<string>', // REQUIRED
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'PhysicalTableMap' => [ // REQUIRED
'<PhysicalTableId>' => [
'CustomSql' => [
'Columns' => [
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'DataSourceArn' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'SqlQuery' => '<string>', // REQUIRED
],
'RelationalTable' => [
'DataSourceArn' => '<string>', // REQUIRED
'InputColumns' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
'Schema' => '<string>',
],
'S3Source' => [
'DataSourceArn' => '<string>', // REQUIRED
'InputColumns' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'UploadSettings' => [
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'Format' => 'CSV|TSV|CLF|ELF|XLSX|JSON',
'StartFromRow' => <integer>,
'TextQualifier' => 'DOUBLE_QUOTE|SINGLE_QUOTE',
],
],
],
// ...
],
'RowLevelPermissionDataSet' => [
'Arn' => '<string>', // REQUIRED
'PermissionPolicy' => 'GRANT_ACCESS|DENY_ACCESS', // REQUIRED
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- ColumnGroups
-
- Type: Array of ColumnGroup structures
Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.
- DataSetId
-
- Required: Yes
- Type: string
An ID for the dataset you want to create. This is unique per region per AWS account.
- ImportMode
-
- Required: Yes
- Type: string
Indicates whether or not you want to import the data into SPICE.
- LogicalTableMap
-
- Type: Associative array of custom strings keys (LogicalTableId) to LogicalTable structures
Configures the combination and transformation of the data from the physical tables.
- Name
-
- Required: Yes
- Type: string
The display name for the dataset.
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions on the dataset.
- PhysicalTableMap
-
- Required: Yes
- Type: Associative array of custom strings keys (PhysicalTableId) to PhysicalTable structures
Declares the physical tables that are available in the underlying data sources.
- RowLevelPermissionDataSet
-
- Type: RowLevelPermissionDataSet structure
Row-level security configuration on the data you want to create.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
Result Syntax
[
'Arn' => '<string>',
'DataSetId' => '<string>',
'IngestionArn' => '<string>',
'IngestionId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset you want to create. This is unique per region per AWS account.
- IngestionArn
-
- Type: string
The Amazon Resource Name (ARN) for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
- IngestionId
-
- Type: string
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
A limit is exceeded.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
CreateDataSource
$result = $client->createDataSource([/* ... */]); $promise = $client->createDataSourceAsync([/* ... */]);
Creates a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight create-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--type=POSTGRESQL \
--data-source-parameters='{ "PostgreSqlParameters": {
"Host": "my-db-host.example.com",
"Port": 1234,
"Database": "my-db" } }' \
--credentials='{ "CredentialPair": {
"Username": "username",
"Password": "password" } }'
Parameter Syntax
$result = $client->createDataSource([
'AwsAccountId' => '<string>', // REQUIRED
'Credentials' => [
'CredentialPair' => [
'Password' => '<string>', // REQUIRED
'Username' => '<string>', // REQUIRED
],
],
'DataSourceId' => '<string>', // REQUIRED
'DataSourceParameters' => [
'AmazonElasticsearchParameters' => [
'Domain' => '<string>', // REQUIRED
],
'AthenaParameters' => [
'WorkGroup' => '<string>',
],
'AuroraParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'AuroraPostgreSqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'AwsIotAnalyticsParameters' => [
'DataSetName' => '<string>', // REQUIRED
],
'JiraParameters' => [
'SiteBaseUrl' => '<string>', // REQUIRED
],
'MariaDbParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'MySqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'PostgreSqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'PrestoParameters' => [
'Catalog' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'RdsParameters' => [
'Database' => '<string>', // REQUIRED
'InstanceId' => '<string>', // REQUIRED
],
'RedshiftParameters' => [
'ClusterId' => '<string>',
'Database' => '<string>', // REQUIRED
'Host' => '<string>',
'Port' => <integer>,
],
'S3Parameters' => [
'ManifestFileLocation' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
],
'ServiceNowParameters' => [
'SiteBaseUrl' => '<string>', // REQUIRED
],
'SnowflakeParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Warehouse' => '<string>', // REQUIRED
],
'SparkParameters' => [
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'SqlServerParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'TeradataParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'TwitterParameters' => [
'MaxRows' => <integer>, // REQUIRED
'Query' => '<string>', // REQUIRED
],
],
'Name' => '<string>', // REQUIRED
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'SslProperties' => [
'DisableSsl' => true || false,
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER', // REQUIRED
'VpcConnectionProperties' => [
'VpcConnectionArn' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID.
- Credentials
-
- Type: DataSourceCredentials structure
The credentials QuickSight uses to connect to your underlying source. Currently only username/password based credentials are supported.
- DataSourceId
-
- Required: Yes
- Type: string
An ID for the data source. This is unique per AWS Region per AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters QuickSight uses to connect to your underlying source.
- Name
-
- Required: Yes
- Type: string
A display name for the data source.
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions on the data source.
- SslProperties
-
- Type: SslProperties structure
SSL properties that apply when QuickSight connects to your underlying source.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
- Type
-
- Required: Yes
- Type: string
The type of the data source. Currently the supported types for this operation are:
ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. UseListDataSourcesto return a list of all data sources. - VpcConnectionProperties
-
- Type: VpcConnectionProperties structure
You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'DataSourceId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the data source.
- CreationStatus
-
- Type: string
The status of creating the data source.
- DataSourceId
-
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
A limit is exceeded.
-
One or more resources can't be found.
-
The resource specified already exists.
-
Access is throttled.
-
An internal failure occurred.
CreateGroup
$result = $client->createGroup([/* ... */]); $promise = $client->createGroupAsync([/* ... */]);
Creates an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is a group object.
CLI Sample:
aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name="Sales-Management" --description="Sales Management - Forecasting"
Parameter Syntax
$result = $client->createGroup([
'AwsAccountId' => '<string>', // REQUIRED
'Description' => '<string>',
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Description
-
- Type: string
A description for the group that you want to create.
- GroupName
-
- Required: Yes
- Type: string
A name for the group that you want to create.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
'PrincipalId' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
A limit is exceeded.
-
An internal failure occurred.
-
This resource is currently unavailable.
CreateGroupMembership
$result = $client->createGroupMembership([/* ... */]); $promise = $client->createGroupMembershipAsync([/* ... */]);
Adds an Amazon QuickSight user to an Amazon QuickSight group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
The response is the group member object.
CLI Sample:
aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat
Parameter Syntax
$result = $client->createGroupMembership([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MemberName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to add the user to.
- MemberName
-
- Required: Yes
- Type: string
The name of the user that you want to add to the group membership.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'GroupMember' => [
'Arn' => '<string>',
'MemberName' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupMember
-
- Type: GroupMember structure
The group member.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
CreateIAMPolicyAssignment
$result = $client->createIAMPolicyAssignment([/* ... */]); $promise = $client->createIAMPolicyAssignmentAsync([/* ... */]);
Creates an assignment with one specified IAM policy ARN and will assigned to specified groups or users of QuickSight. Users and groups need to be in the same namespace.
CLI syntax:
aws quicksight create-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=helpAssignment --policy-arn=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user5,engineer123,group=QS-Admin" --namespace=default --region=us-west-2
Parameter Syntax
$result = $client->createIAMPolicyAssignment([
'AssignmentName' => '<string>', // REQUIRED
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'Identities' => [
'<String>' => ['<string>', ...],
// ...
],
'Namespace' => '<string>', // REQUIRED
'PolicyArn' => '<string>',
]);
Parameter Details
Members
- AssignmentName
-
- Required: Yes
- Type: string
The name of the assignment. It must be unique within an AWS account.
- AssignmentStatus
-
- Required: Yes
- Type: string
The status of an assignment:
-
ENABLED - Anything specified in this assignment is used while creating the data source.
-
DISABLED - This assignment isn't used while creating the data source.
-
DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID where you want to assign QuickSight users or groups to an IAM policy.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
QuickSight users and/or groups that you want to assign the policy to.
- Namespace
-
- Required: Yes
- Type: string
The namespace that contains the assignment.
- PolicyArn
-
- Type: string
An IAM policy ARN that you want to apply to the QuickSight users and groups specified in this assignment.
Result Syntax
[
'AssignmentId' => '<string>',
'AssignmentName' => '<string>',
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
'Identities' => [
'<String>' => ['<string>', ...],
// ...
],
'PolicyArn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AssignmentId
-
- Type: string
An ID for the assignment.
- AssignmentName
-
- Type: string
The name of the assignment. Must be unique within an AWS account.
- AssignmentStatus
-
- Type: string
The status of an assignment:
-
ENABLED - Anything specified in this assignment is used while creating the data source.
-
DISABLED - This assignment isn't used while creating the data source.
-
DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
QuickSight users and/or groups that are assigned to the IAM policy.
- PolicyArn
-
- Type: string
An IAM policy ARN that is applied to the QuickSight users and groups specified in this assignment.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in an "actionable" state that must complete before a new update can be applied.
-
An internal failure occurred.
CreateIngestion
$result = $client->createIngestion([/* ... */]); $promise = $client->createIngestionAsync([/* ... */]);
Creates and starts a new SPICE ingestion on a dataset
Any ingestions operating on tagged datasets inherit the same tags automatically for use in access-control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags?. Tags will be visible on the tagged dataset, but not on the ingestion resource.
Parameter Syntax
$result = $client->createIngestion([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'IngestionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'IngestionId' => '<string>',
'IngestionStatus' => 'INITIALIZED|QUEUED|RUNNING|FAILED|COMPLETED|CANCELLED',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
A limit is exceeded.
-
The resource specified already exists.
-
An internal failure occurred.
CreateTemplate
$result = $client->createTemplate([/* ... */]); $promise = $client->createTemplateAsync([/* ... */]);
Creates a template from an existing QuickSight analysis or template. The resulting template can be used to create a dashboard.
A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be used to create dashboard. It adds a layer of abstraction by use placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets which follow the same schema that was used to create the source analysis and template.
To create a template from an existing analysis, use the analysis's ARN, aws-account-id, template-id, source-entity, and data-set-references.
CLI syntax to create a template:
aws quicksight create-template —cli-input-json file://create-template.json
CLI syntax to create a template from another template in the same AWS account:
aws quicksight create-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0dfc789c-81f6-4f4f-b9ac-7db2453eefc8 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/f60da323-af68-45db-9016-08e0d1d7ded5 --source-entity SourceAnalysis='{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/7fb74527-c36d-4be8-8139-ac1be4c97365}'
To create template from another account’s template, you need to grant cross account resource permission for DescribeTemplate the account that contains the template.
You can use a file to pass JSON to the function if you prefer.
Parameter Syntax
$result = $client->createTemplate([
'AwsAccountId' => '<string>', // REQUIRED
'Name' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'SourceEntity' => [ // REQUIRED
'SourceAnalysis' => [
'Arn' => '<string>', // REQUIRED
'DataSetReferences' => [ // REQUIRED
[
'DataSetArn' => '<string>', // REQUIRED
'DataSetPlaceholder' => '<string>', // REQUIRED
],
// ...
],
],
'SourceTemplate' => [
'Arn' => '<string>', // REQUIRED
],
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'TemplateId' => '<string>', // REQUIRED
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Name
-
- Type: string
A display name for the template.
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be set on the template. The shorthand syntax should look similar to this:
Shorthand Syntax: Principal=string,Actions=string,string ... - SourceEntity
-
- Required: Yes
- Type: TemplateSourceEntity structure
The ARN of the source entity from which this template is being created. Templates can be currently created from an analysis or another template. If the ARN is for an analysis, you must include its dataset references.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
- TemplateId
-
- Required: Yes
- Type: string
An ID for the template you want to create. This is unique per AWS region per AWS account.
- VersionDescription
-
- Type: string
A description of the current template version being created. This API created the first version of the template. Every time UpdateTemplate is called a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the template.
- CreationStatus
-
- Type: string
The template creation status.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateId
-
- Type: string
The ID of the template.
- VersionArn
-
- Type: string
The Amazon Resource Name (ARN) for the template, including the version information of the first version.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A limit is exceeded.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
CreateTemplateAlias
$result = $client->createTemplateAlias([/* ... */]); $promise = $client->createTemplateAliasAsync([/* ... */]);
Creates a template alias for a template.
CLI syntax:
aws quicksight create-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name PROD —version-number 1
Parameter Syntax
$result = $client->createTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'TemplateVersionNumber' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The name you want to give the template's alias. Alias names can't begin with a
$, which is reserved by QuickSight. Alias names that start with ‘$’ sign are QuickSight reserved naming and can't be deleted. - AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template you are aliasing.
- TemplateId
-
- Required: Yes
- Type: string
An ID for the template.
- TemplateVersionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the template.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'TemplateVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateAlias
-
- Type: TemplateAlias structure
Information on the template alias.
Errors
-
Access is throttled.
-
One or more resources can't be found.
-
Updating or deleting a resource can cause an inconsistent state.
-
The resource specified already exists.
-
A limit is exceeded.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DeleteDashboard
$result = $client->deleteDashboard([/* ... */]); $promise = $client->deleteDashboardAsync([/* ... */]);
Deletes a dashboard.
CLI syntax:
aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123
aws quicksight delete-dashboard --aws-account-id 111122223333 —dashboard-id 123123123 —version-number 3
Parameter Syntax
$result = $client->deleteDashboard([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are deleting.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- VersionNumber
-
- Type: long (int|float)
The version number of the dashboard. If version number property is provided, only the specified version of the dashboard is deleted.
Result Syntax
[
'Arn' => '<string>',
'DashboardId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Updating or deleting a resource can cause an inconsistent state.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DeleteDataSet
$result = $client->deleteDataSet([/* ... */]); $promise = $client->deleteDataSetAsync([/* ... */]);
Deletes a dataset.
CLI syntax:
aws quicksight delete-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
Parameter Syntax
$result = $client->deleteDataSet([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'DataSetId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DeleteDataSource
$result = $client->deleteDataSource([/* ... */]); $promise = $client->deleteDataSourceAsync([/* ... */]);
Deletes the data source permanently. This action breaks all the datasets that reference the deleted data source.
CLI syntax:
aws quicksight delete-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id
Parameter Syntax
$result = $client->deleteDataSource([
'AwsAccountId' => '<string>', // REQUIRED
'DataSourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'DataSourceId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DeleteGroup
$result = $client->deleteGroup([/* ... */]); $promise = $client->deleteGroupAsync([/* ... */]);
Removes a user group from Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
CLI Sample:
aws quicksight delete-group -\-aws-account-id=111122223333 -\-namespace=default -\-group-name=Sales-Management
Parameter Syntax
$result = $client->deleteGroup([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to delete.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
DeleteGroupMembership
$result = $client->deleteGroupMembership([/* ... */]); $promise = $client->deleteGroupMembershipAsync([/* ... */]);
Removes a user from a group so that the user is no longer a member of the group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The condition resource is the user name.
The condition key is quicksight:UserName.
CLI Sample:
aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie
Parameter Syntax
$result = $client->deleteGroupMembership([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MemberName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to delete the user from.
- MemberName
-
- Required: Yes
- Type: string
The name of the user that you want to delete from the group membership.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
DeleteIAMPolicyAssignment
$result = $client->deleteIAMPolicyAssignment([/* ... */]); $promise = $client->deleteIAMPolicyAssignmentAsync([/* ... */]);
Deletes an existing assignment.
CLI syntax:
aws quicksight delete-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --region=us-east-1 --namespace=default
Parameter Syntax
$result = $client->deleteIAMPolicyAssignment([
'AssignmentName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AssignmentName' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in an "actionable" state that must complete before a new update can be applied.
-
An internal failure occurred.
DeleteTemplate
$result = $client->deleteTemplate([/* ... */]); $promise = $client->deleteTemplateAsync([/* ... */]);
Deletes a template.
CLI syntax:
-
aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template --version-number 2 -
aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name STAGING -
aws quicksight delete-template —aws-account-id 111122223333 —template-id reports_test_template —alias-name ‘\$LATEST’ -
aws quicksight delete-template --aws-account-id 111122223333 —-template-id reports_test_template
If version number which is an optional field is not passed the template (including all the versions) is deleted by the API, if version number is provided, the specific template version is deleted by the API.
Users can explicitly describe the latest version of the template by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the template.
Parameter Syntax
$result = $client->deleteTemplate([
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
]
Result Details
Members
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
Updating or deleting a resource can cause an inconsistent state.
-
A limit is exceeded.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DeleteTemplateAlias
$result = $client->deleteTemplateAlias([/* ... */]); $promise = $client->deleteTemplateAliasAsync([/* ... */]);
Update template alias of given template.
CLI syntax:
aws quicksight delete-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
Parameter Syntax
$result = $client->deleteTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The alias of the template. If alias-name is provided, the version that the alias-name points to is deleted. Alias names that start with
$are reserved by QuickSight and can't be deleted.” - AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template alias you are deleting.
- TemplateId
-
- Required: Yes
- Type: string
An ID for the template.
Result Syntax
[
'AliasName' => '<string>',
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
]
Result Details
Members
Errors
-
Access is throttled.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DeleteUser
$result = $client->deleteUser([/* ... */]); $promise = $client->deleteUserAsync([/* ... */]);
Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call.
CLI Sample:
aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
Parameter Syntax
$result = $client->deleteUser([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - UserName
-
- Required: Yes
- Type: string
The name of the user that you want to delete.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
-
This resource is currently unavailable.
DeleteUserByPrincipalId
$result = $client->deleteUserByPrincipalId([/* ... */]); $promise = $client->deleteUserByPrincipalIdAsync([/* ... */]);
Deletes a user identified by its principal ID.
CLI Sample:
aws quicksight delete-user-by-principal-id --aws-account-id=111122223333 --namespace=default --principal-id=ABCDEFJA26JLI7EUUOEHS
Parameter Syntax
$result = $client->deleteUserByPrincipalId([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'PrincipalId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - PrincipalId
-
- Required: Yes
- Type: string
The principal ID of the user.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
-
This resource is currently unavailable.
DescribeDashboard
$result = $client->describeDashboard([/* ... */]); $promise = $client->describeDashboardAsync([/* ... */]);
Provides a summary for a dashboard.
CLI syntax:
-
aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -version-number 2 -
aws quicksight describe-dashboard --aws-account-id 111122223333 —dashboard-id reports_test_report -alias-name ‘$PUBLISHED’
Parameter Syntax
$result = $client->describeDashboard([
'AliasName' => '<string>',
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AliasName
-
- Type: string
The alias name.
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are describing.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- VersionNumber
-
- Type: long (int|float)
The version number for the dashboard. If version number isn’t passed the latest published dashboard version is described.
Result Syntax
[
'Dashboard' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DashboardId' => '<string>',
'LastPublishedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Version' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Errors' => [
[
'Message' => '<string>',
'Type' => 'DATA_SET_NOT_FOUND|INTERNAL_FAILURE|PARAMETER_VALUE_INCOMPATIBLE|PARAMETER_TYPE_INVALID|PARAMETER_NOT_FOUND|COLUMN_TYPE_MISMATCH|COLUMN_GEOGRAPHIC_ROLE_MISMATCH|COLUMN_REPLACEMENT_MISSING',
],
// ...
],
'SourceEntityArn' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'VersionNumber' => <integer>,
],
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Dashboard
-
- Type: Dashboard structure
Information about the dashboard.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of this request.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Access is throttled.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DescribeDashboardPermissions
$result = $client->describeDashboardPermissions([/* ... */]); $promise = $client->describeDashboardPermissionsAsync([/* ... */]);
Describes read and write permissions on a dashboard.
CLI syntax:
aws quicksight describe-dashboard-permissions --aws-account-id 735340738645 —dashboard-id reports_test_bob_report
Parameter Syntax
$result = $client->describeDashboardPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DashboardArn' => '<string>',
'DashboardId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DashboardArn
-
- Type: string
The ARN of the dashboard.
- DashboardId
-
- Type: string
The ID for the dashboard.
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that contains the permissions of the dashboard.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DescribeDataSet
$result = $client->describeDataSet([/* ... */]); $promise = $client->describeDataSetAsync([/* ... */]);
Describes a dataset.
CLI syntax:
aws quicksight describe-data-set \
--aws-account-id=111111111111 \
--data-set-id=unique-data-set-id
Parameter Syntax
$result = $client->describeDataSet([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DataSet' => [
'Arn' => '<string>',
'ColumnGroups' => [
[
'GeoSpatialColumnGroup' => [
'Columns' => ['<string>', ...],
'CountryCode' => 'US',
'Name' => '<string>',
],
],
// ...
],
'ConsumedSpiceCapacityInBytes' => <integer>,
'CreatedTime' => <DateTime>,
'DataSetId' => '<string>',
'ImportMode' => 'SPICE|DIRECT_QUERY',
'LastUpdatedTime' => <DateTime>,
'LogicalTableMap' => [
'<LogicalTableId>' => [
'Alias' => '<string>',
'DataTransforms' => [
[
'CastColumnTypeOperation' => [
'ColumnName' => '<string>',
'Format' => '<string>',
'NewColumnType' => 'STRING|INTEGER|DECIMAL|DATETIME',
],
'CreateColumnsOperation' => [
'Columns' => [
[
'ColumnId' => '<string>',
'ColumnName' => '<string>',
'Expression' => '<string>',
],
// ...
],
],
'FilterOperation' => [
'ConditionExpression' => '<string>',
],
'ProjectOperation' => [
'ProjectedColumns' => ['<string>', ...],
],
'RenameColumnOperation' => [
'ColumnName' => '<string>',
'NewColumnName' => '<string>',
],
'TagColumnOperation' => [
'ColumnName' => '<string>',
'Tags' => [
[
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [
'JoinInstruction' => [
'LeftOperand' => '<string>',
'OnClause' => '<string>',
'RightOperand' => '<string>',
'Type' => 'INNER|OUTER|LEFT|RIGHT',
],
'PhysicalTableId' => '<string>',
],
],
// ...
],
'Name' => '<string>',
'OutputColumns' => [
[
'Name' => '<string>',
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME',
],
// ...
],
'PhysicalTableMap' => [
'<PhysicalTableId>' => [
'CustomSql' => [
'Columns' => [
[
'Name' => '<string>',
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON',
],
// ...
],
'DataSourceArn' => '<string>',
'Name' => '<string>',
'SqlQuery' => '<string>',
],
'RelationalTable' => [
'DataSourceArn' => '<string>',
'InputColumns' => [
[
'Name' => '<string>',
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON',
],
// ...
],
'Name' => '<string>',
'Schema' => '<string>',
],
'S3Source' => [
'DataSourceArn' => '<string>',
'InputColumns' => [
[
'Name' => '<string>',
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON',
],
// ...
],
'UploadSettings' => [
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'Format' => 'CSV|TSV|CLF|ELF|XLSX|JSON',
'StartFromRow' => <integer>,
'TextQualifier' => 'DOUBLE_QUOTE|SINGLE_QUOTE',
],
],
],
// ...
],
'RowLevelPermissionDataSet' => [
'Arn' => '<string>',
'PermissionPolicy' => 'GRANT_ACCESS|DENY_ACCESS',
],
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSet
-
- Type: DataSet structure
Information on the dataset.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DescribeDataSetPermissions
$result = $client->describeDataSetPermissions([/* ... */]); $promise = $client->describeDataSetPermissionsAsync([/* ... */]);
Describes the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
CLI syntax:
aws quicksight describe-data-set-permissions \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
Parameter Syntax
$result = $client->describeDataSetPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DataSetArn' => '<string>',
'DataSetId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSetArn
-
- Type: string
The ARN of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset you want to create. This is unique per region per AWS account.
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions on the dataset.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DescribeDataSource
$result = $client->describeDataSource([/* ... */]); $promise = $client->describeDataSourceAsync([/* ... */]);
Describes a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
Parameter Syntax
$result = $client->describeDataSource([
'AwsAccountId' => '<string>', // REQUIRED
'DataSourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DataSource' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DataSourceId' => '<string>',
'DataSourceParameters' => [
'AmazonElasticsearchParameters' => [
'Domain' => '<string>',
],
'AthenaParameters' => [
'WorkGroup' => '<string>',
],
'AuroraParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'AuroraPostgreSqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'AwsIotAnalyticsParameters' => [
'DataSetName' => '<string>',
],
'JiraParameters' => [
'SiteBaseUrl' => '<string>',
],
'MariaDbParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'MySqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'PostgreSqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'PrestoParameters' => [
'Catalog' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'RdsParameters' => [
'Database' => '<string>',
'InstanceId' => '<string>',
],
'RedshiftParameters' => [
'ClusterId' => '<string>',
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'S3Parameters' => [
'ManifestFileLocation' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
],
'ServiceNowParameters' => [
'SiteBaseUrl' => '<string>',
],
'SnowflakeParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Warehouse' => '<string>',
],
'SparkParameters' => [
'Host' => '<string>',
'Port' => <integer>,
],
'SqlServerParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'TeradataParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'TwitterParameters' => [
'MaxRows' => <integer>,
'Query' => '<string>',
],
],
'ErrorInfo' => [
'Message' => '<string>',
'Type' => 'TIMEOUT|ENGINE_VERSION_NOT_SUPPORTED|UNKNOWN_HOST|GENERIC_SQL_FAILURE|CONFLICT|UNKNOWN',
],
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'SslProperties' => [
'DisableSsl' => true || false,
],
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER',
'VpcConnectionProperties' => [
'VpcConnectionArn' => '<string>',
],
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSource
-
- Type: DataSource structure
The information on the data source.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DescribeDataSourcePermissions
$result = $client->describeDataSourcePermissions([/* ... */]); $promise = $client->describeDataSourcePermissionsAsync([/* ... */]);
Describes the resource permissions for a data source.
The permissions resource is aws:quicksight:region:aws-account-id:datasource/data-source-id
Parameter Syntax
$result = $client->describeDataSourcePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DataSourceId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DataSourceArn' => '<string>',
'DataSourceId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSourceArn
-
- Type: string
The ARN of the data source.
- DataSourceId
-
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions on the data source.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
DescribeGroup
$result = $client->describeGroup([/* ... */]); $promise = $client->describeGroupAsync([/* ... */]);
Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
The permissions resource is arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> .
The response is the group object.
CLI Sample:
aws quicksight describe-group -\-aws-account-id=11112222333 -\-namespace=default -\-group-name=Sales
Parameter Syntax
$result = $client->describeGroup([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to describe.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
'PrincipalId' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
DescribeIAMPolicyAssignment
$result = $client->describeIAMPolicyAssignment([/* ... */]); $promise = $client->describeIAMPolicyAssignmentAsync([/* ... */]);
Describes an existing IAMPolicy Assignment by specified assignment name.
CLI syntax:
aws quicksight describe-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=testtest --namespace=default --region=us-east-1
Parameter Syntax
$result = $client->describeIAMPolicyAssignment([
'AssignmentName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'IAMPolicyAssignment' => [
'AssignmentId' => '<string>',
'AssignmentName' => '<string>',
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
'AwsAccountId' => '<string>',
'Identities' => [
'<String>' => ['<string>', ...],
// ...
],
'PolicyArn' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- IAMPolicyAssignment
-
- Type: IAMPolicyAssignment structure
Information describing the IAM policy assignment.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
DescribeIngestion
$result = $client->describeIngestion([/* ... */]); $promise = $client->describeIngestionAsync([/* ... */]);
Describes a SPICE ingestion.
Parameter Syntax
$result = $client->describeIngestion([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'IngestionId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Ingestion' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'ErrorInfo' => [
'Message' => '<string>',
'Type' => 'FAILURE_TO_ASSUME_ROLE|INGESTION_SUPERSEDED|INGESTION_CANCELED|DATA_SET_DELETED|DATA_SET_NOT_SPICE|S3_UPLOADED_FILE_DELETED|S3_MANIFEST_ERROR|DATA_TOLERANCE_EXCEPTION|SPICE_TABLE_NOT_FOUND|DATA_SET_SIZE_LIMIT_EXCEEDED|ROW_SIZE_LIMIT_EXCEEDED|ACCOUNT_CAPACITY_LIMIT_EXCEEDED|CUSTOMER_ERROR|DATA_SOURCE_NOT_FOUND|IAM_ROLE_NOT_AVAILABLE|CONNECTION_FAILURE|SQL_TABLE_NOT_FOUND|PERMISSION_DENIED|SSL_CERTIFICATE_VALIDATION_FAILURE|OAUTH_TOKEN_FAILURE|SOURCE_API_LIMIT_EXCEEDED_FAILURE|PASSWORD_AUTHENTICATION_FAILURE|SQL_SCHEMA_MISMATCH_ERROR|INVALID_DATE_FORMAT|INVALID_DATAPREP_SYNTAX|SOURCE_RESOURCE_LIMIT_EXCEEDED|SQL_INVALID_PARAMETER_VALUE|QUERY_TIMEOUT|SQL_NUMERIC_OVERFLOW|UNRESOLVABLE_HOST|UNROUTABLE_HOST|SQL_EXCEPTION|S3_FILE_INACCESSIBLE|IOT_FILE_NOT_FOUND|IOT_DATA_SET_FILE_EMPTY|INVALID_DATA_SOURCE_CONFIG|DATA_SOURCE_AUTH_FAILED|DATA_SOURCE_CONNECTION_FAILED|FAILURE_TO_PROCESS_JSON_FILE|INTERNAL_SERVICE_ERROR',
],
'IngestionId' => '<string>',
'IngestionSizeInBytes' => <integer>,
'IngestionStatus' => 'INITIALIZED|QUEUED|RUNNING|FAILED|COMPLETED|CANCELLED',
'IngestionTimeInSeconds' => <integer>,
'QueueInfo' => [
'QueuedIngestion' => '<string>',
'WaitingOnIngestion' => '<string>',
],
'RequestSource' => 'MANUAL|SCHEDULED',
'RequestType' => 'INITIAL_INGESTION|EDIT|INCREMENTAL_REFRESH|FULL_REFRESH',
'RowInfo' => [
'RowsDropped' => <integer>,
'RowsIngested' => <integer>,
],
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Ingestion
-
- Type: Ingestion structure
Information about the ingestion.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The resource specified already exists.
-
An internal failure occurred.
DescribeTemplate
$result = $client->describeTemplate([/* ... */]); $promise = $client->describeTemplateAsync([/* ... */]);
Describes a template's metadata.
CLI syntax:
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --version-number-2
aws quicksight describe-template --aws-account-id 111122223333 --template-id reports_test_template --alias-name '\$LATEST'
Users can explicitly describe the latest version of the dashboard by passing $LATEST to the alias-name parameter. $LATEST is an internally supported alias, which points to the latest version of the dashboard.
Parameter Syntax
$result = $client->describeTemplate([
'AliasName' => '<string>',
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AliasName
-
- Type: string
This is an optional field, when an alias name is provided, the version referenced by the alias is described. Refer to
CreateTemplateAliasto create a template alias.$PUBLISHEDis not supported for template. - AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template you are describing.
- TemplateId
-
- Required: Yes
- Type: string
An ID for the template.
- VersionNumber
-
- Type: long (int|float)
This is an optional field, when a version number is provided the corresponding version is describe, if it's not provided the latest version of the template is described.
Result Syntax
[
'Status' => <integer>,
'Template' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'TemplateId' => '<string>',
'Version' => [
'CreatedTime' => <DateTime>,
'DataSetConfigurations' => [
[
'ColumnGroupSchemaList' => [
[
'ColumnGroupColumnSchemaList' => [
[
'Name' => '<string>',
],
// ...
],
'Name' => '<string>',
],
// ...
],
'DataSetSchema' => [
'ColumnSchemaList' => [
[
'DataType' => '<string>',
'GeographicRole' => '<string>',
'Name' => '<string>',
],
// ...
],
],
'Placeholder' => '<string>',
],
// ...
],
'Description' => '<string>',
'Errors' => [
[
'Message' => '<string>',
'Type' => 'DATA_SET_NOT_FOUND|INTERNAL_FAILURE',
],
// ...
],
'SourceEntityArn' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'VersionNumber' => <integer>,
],
],
]
Result Details
Members
- Status
-
- Type: int
The http status of the request.
- Template
-
- Type: Template structure
The template structure of the object you want to describe.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
Updating or deleting a resource can cause an inconsistent state.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DescribeTemplateAlias
$result = $client->describeTemplateAlias([/* ... */]); $promise = $client->describeTemplateAliasAsync([/* ... */]);
Describes the template aliases of a template.
CLI syntax:
aws quicksight describe-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name 'STAGING'
Parameter Syntax
$result = $client->describeTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'TemplateVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateAlias
-
- Type: TemplateAlias structure
Information about the template alias.
Errors
-
Access is throttled.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DescribeTemplatePermissions
$result = $client->describeTemplatePermissions([/* ... */]); $promise = $client->describeTemplatePermissionsAsync([/* ... */]);
Describes read and write permissions on a template.
CLI syntax:
aws quicksight describe-template-permissions —aws-account-id 735340738645 —template-id reports_test_template
Parameter Syntax
$result = $client->describeTemplatePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateArn' => '<string>',
'TemplateId' => '<string>',
]
Result Details
Members
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be set on the template.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateArn
-
- Type: string
The ARN of the template.
- TemplateId
-
- Type: string
The ID for the template.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Updating or deleting a resource can cause an inconsistent state.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
DescribeUser
$result = $client->describeUser([/* ... */]); $promise = $client->describeUserAsync([/* ... */]);
Returns information about a user, given the user name.
The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat
Parameter Syntax
$result = $client->describeUser([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - UserName
-
- Required: Yes
- Type: string
The name of the user that you want to describe.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'PrincipalId' => '<string>',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The user name.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
-
This resource is currently unavailable.
GetDashboardEmbedUrl
$result = $client->getDashboardEmbedUrl([/* ... */]); $promise = $client->getDashboardEmbedUrlAsync([/* ... */]);
Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
CLI Sample:
Assume the role with permissions enabled for actions: quickSight:RegisterUser and quicksight:GetDashboardEmbedURL. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml.
aws sts assume-role --role-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --role-session-name embeddingsession
If the user does not exist in QuickSight, register the user:
aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn "arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role" --user-role READER --session-name "embeddingsession" --email user123@example.com --region us-east-1
Get the URL for the embedded dashboard (IAM identity authentication):
aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM
Get the URL for the embedded dashboard (QUICKSIGHT identity authentication):
aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type QUICKSIGHT --user-arn arn:aws:quicksight:us-east-1:111122223333:user/default/embedding_quicksight_dashboard_role/embeddingsession
Parameter Syntax
$result = $client->getDashboardEmbedUrl([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'IdentityType' => 'IAM|QUICKSIGHT', // REQUIRED
'ResetDisabled' => true || false,
'SessionLifetimeInMinutes' => <integer>,
'UndoRedoDisabled' => true || false,
'UserArn' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are embedding.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard, also added to IAM policy
- IdentityType
-
- Required: Yes
- Type: string
The authentication method the user uses to sign in (IAM only).
- ResetDisabled
-
- Type: boolean
Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.
- SessionLifetimeInMinutes
-
- Type: long (int|float)
How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.
- UndoRedoDisabled
-
- Type: boolean
Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.
- UserArn
-
- Type: string
The Amazon QuickSight user's ARN, for use with
QUICKSIGHTidentity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:-
Active Directory (AD) users or group members
-
Invited non-federated users
-
IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM Federation
Result Syntax
[
'EmbedUrl' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- EmbedUrl
-
- Type: string
URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
DomainNotWhitelistedException:
The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
-
QuickSightUserNotFoundException:
The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as
DeleteUser,DescribeUser, and so on. -
IdentityTypeNotSupportedException:
The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
-
SessionLifetimeInMinutesInvalidException:
The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListDashboardVersions
$result = $client->listDashboardVersions([/* ... */]); $promise = $client->listDashboardVersionsAsync([/* ... */]);
Lists all the versions of the dashboards in the Quicksight subscription.
CLI syntax:
aws quicksight list-template-versions —aws-account-id 111122223333 —template-id reports-test-template
Parameter Syntax
$result = $client->listDashboardVersions([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are listing.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
Result Syntax
[
'DashboardVersionSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'SourceEntityArn' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'VersionNumber' => <integer>,
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DashboardVersionSummaryList
-
- Type: Array of DashboardVersionSummary structures
A structure that contains information about each version of the dashboard.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListDashboards
$result = $client->listDashboards([/* ... */]); $promise = $client->listDashboardsAsync([/* ... */]);
Lists dashboards in the AWS account.
CLI syntax:
aws quicksight list-dashboards --aws-account-id 111122223333 --max-results 5 —next-token 'next-10'
Parameter Syntax
$result = $client->listDashboards([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DashboardSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DashboardId' => '<string>',
'LastPublishedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'PublishedVersionNumber' => <integer>,
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DashboardSummaryList
-
- Type: Array of DashboardSummary structures
A structure that contains all of the dashboards shared with the user. Provides basic information about the dashboards.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListDataSets
$result = $client->listDataSets([/* ... */]); $promise = $client->listDataSetsAsync([/* ... */]);
Lists all of the datasets belonging to this account in an AWS region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*
CLI syntax: aws quicksight list-data-sets --aws-account-id=111111111111
Parameter Syntax
$result = $client->listDataSets([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DataSetSummaries' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DataSetId' => '<string>',
'ImportMode' => 'SPICE|DIRECT_QUERY',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'RowLevelPermissionDataSet' => [
'Arn' => '<string>',
'PermissionPolicy' => 'GRANT_ACCESS|DENY_ACCESS',
],
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSetSummaries
-
- Type: Array of DataSetSummary structures
The list of dataset summaries.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
ListDataSources
$result = $client->listDataSources([/* ... */]); $promise = $client->listDataSourcesAsync([/* ... */]);
Lists data sources in current AWS region that belong to this AWS account.
The permissions resource is: arn:aws:quicksight:region:aws-account-id:datasource/*
CLI syntax: aws quicksight list-data-sources --aws-account-id=111122223333
Parameter Syntax
$result = $client->listDataSources([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'DataSources' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DataSourceId' => '<string>',
'DataSourceParameters' => [
'AmazonElasticsearchParameters' => [
'Domain' => '<string>',
],
'AthenaParameters' => [
'WorkGroup' => '<string>',
],
'AuroraParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'AuroraPostgreSqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'AwsIotAnalyticsParameters' => [
'DataSetName' => '<string>',
],
'JiraParameters' => [
'SiteBaseUrl' => '<string>',
],
'MariaDbParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'MySqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'PostgreSqlParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'PrestoParameters' => [
'Catalog' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'RdsParameters' => [
'Database' => '<string>',
'InstanceId' => '<string>',
],
'RedshiftParameters' => [
'ClusterId' => '<string>',
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'S3Parameters' => [
'ManifestFileLocation' => [
'Bucket' => '<string>',
'Key' => '<string>',
],
],
'ServiceNowParameters' => [
'SiteBaseUrl' => '<string>',
],
'SnowflakeParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Warehouse' => '<string>',
],
'SparkParameters' => [
'Host' => '<string>',
'Port' => <integer>,
],
'SqlServerParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'TeradataParameters' => [
'Database' => '<string>',
'Host' => '<string>',
'Port' => <integer>,
],
'TwitterParameters' => [
'MaxRows' => <integer>,
'Query' => '<string>',
],
],
'ErrorInfo' => [
'Message' => '<string>',
'Type' => 'TIMEOUT|ENGINE_VERSION_NOT_SUPPORTED|UNKNOWN_HOST|GENERIC_SQL_FAILURE|CONFLICT|UNKNOWN',
],
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'SslProperties' => [
'DisableSsl' => true || false,
],
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER',
'VpcConnectionProperties' => [
'VpcConnectionArn' => '<string>',
],
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DataSources
-
- Type: Array of DataSource structures
A list of data sources.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
ListGroupMemberships
$result = $client->listGroupMemberships([/* ... */]); $promise = $client->listGroupMembershipsAsync([/* ... */]);
Lists member users in a group.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a list of group member objects.
CLI Sample:
aws quicksight list-group-memberships -\-aws-account-id=111122223333 -\-namespace=default
Parameter Syntax
$result = $client->listGroupMemberships([
'AwsAccountId' => '<string>', // REQUIRED
'GroupName' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to see a membership list of.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'GroupMemberList' => [
[
'Arn' => '<string>',
'MemberName' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupMemberList
-
- Type: Array of GroupMember structures
The list of the members of the group.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
ListGroups
$result = $client->listGroups([/* ... */]); $promise = $client->listGroupsAsync([/* ... */]);
Lists all user groups in Amazon QuickSight.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*.
The response is a list of group objects.
CLI Sample:
aws quicksight list-groups -\-aws-account-id=111122223333 -\-namespace=default
Parameter Syntax
$result = $client->listGroups([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'GroupList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
'PrincipalId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupList
-
- Type: Array of Group structures
The list of the groups.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
ListIAMPolicyAssignments
$result = $client->listIAMPolicyAssignments([/* ... */]); $promise = $client->listIAMPolicyAssignmentsAsync([/* ... */]);
Lists assignments in current QuickSight account.
CLI syntax:
aws quicksight list-iam-policy-assignments --aws-account-id=111122223333 --max-result=5 --assignment-status=ENABLED --namespace=default --region=us-east-1 --next-token=3
Parameter Syntax
$result = $client->listIAMPolicyAssignments([
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AssignmentStatus
-
- Type: string
The status of the assignment.
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID that contains this IAM policy assignment.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- Namespace
-
- Required: Yes
- Type: string
The namespace for this assignment.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
Result Syntax
[
'IAMPolicyAssignments' => [
[
'AssignmentName' => '<string>',
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- IAMPolicyAssignments
-
- Type: Array of IAMPolicyAssignmentSummary structures
Information describing the IAM policy assignments.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
ListIAMPolicyAssignmentsForUser
$result = $client->listIAMPolicyAssignmentsForUser([/* ... */]); $promise = $client->listIAMPolicyAssignmentsForUserAsync([/* ... */]);
Lists all the assignments and the ARNs for the associated IAM policies assigned to the specified user and the group or groups that the user belongs to.
CLI syntax:
aws quicksight list-iam-policy-assignments-for-user --aws-account-id=111122223333 --user-name=user5 --namespace=default --max-result=6 --region=us-east-1
Parameter Syntax
$result = $client->listIAMPolicyAssignmentsForUser([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID that contains the assignment.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- Namespace
-
- Required: Yes
- Type: string
The namespace of the assignment.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- UserName
-
- Required: Yes
- Type: string
The name of the user.
Result Syntax
[
'ActiveAssignments' => [
[
'AssignmentName' => '<string>',
'PolicyArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- ActiveAssignments
-
- Type: Array of ActiveIAMPolicyAssignment structures
Active assignments for this user.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in an "actionable" state that must complete before a new update can be applied.
-
An internal failure occurred.
ListIngestions
$result = $client->listIngestions([/* ... */]); $promise = $client->listIngestionsAsync([/* ... */]);
Lists the history of SPICE ingestions for a dataset.
Parameter Syntax
$result = $client->listIngestions([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID.
- DataSetId
-
- Required: Yes
- Type: string
The ID of the dataset used in the ingestion.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
Result Syntax
[
'Ingestions' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'ErrorInfo' => [
'Message' => '<string>',
'Type' => 'FAILURE_TO_ASSUME_ROLE|INGESTION_SUPERSEDED|INGESTION_CANCELED|DATA_SET_DELETED|DATA_SET_NOT_SPICE|S3_UPLOADED_FILE_DELETED|S3_MANIFEST_ERROR|DATA_TOLERANCE_EXCEPTION|SPICE_TABLE_NOT_FOUND|DATA_SET_SIZE_LIMIT_EXCEEDED|ROW_SIZE_LIMIT_EXCEEDED|ACCOUNT_CAPACITY_LIMIT_EXCEEDED|CUSTOMER_ERROR|DATA_SOURCE_NOT_FOUND|IAM_ROLE_NOT_AVAILABLE|CONNECTION_FAILURE|SQL_TABLE_NOT_FOUND|PERMISSION_DENIED|SSL_CERTIFICATE_VALIDATION_FAILURE|OAUTH_TOKEN_FAILURE|SOURCE_API_LIMIT_EXCEEDED_FAILURE|PASSWORD_AUTHENTICATION_FAILURE|SQL_SCHEMA_MISMATCH_ERROR|INVALID_DATE_FORMAT|INVALID_DATAPREP_SYNTAX|SOURCE_RESOURCE_LIMIT_EXCEEDED|SQL_INVALID_PARAMETER_VALUE|QUERY_TIMEOUT|SQL_NUMERIC_OVERFLOW|UNRESOLVABLE_HOST|UNROUTABLE_HOST|SQL_EXCEPTION|S3_FILE_INACCESSIBLE|IOT_FILE_NOT_FOUND|IOT_DATA_SET_FILE_EMPTY|INVALID_DATA_SOURCE_CONFIG|DATA_SOURCE_AUTH_FAILED|DATA_SOURCE_CONNECTION_FAILED|FAILURE_TO_PROCESS_JSON_FILE|INTERNAL_SERVICE_ERROR',
],
'IngestionId' => '<string>',
'IngestionSizeInBytes' => <integer>,
'IngestionStatus' => 'INITIALIZED|QUEUED|RUNNING|FAILED|COMPLETED|CANCELLED',
'IngestionTimeInSeconds' => <integer>,
'QueueInfo' => [
'QueuedIngestion' => '<string>',
'WaitingOnIngestion' => '<string>',
],
'RequestSource' => 'MANUAL|SCHEDULED',
'RequestType' => 'INITIAL_INGESTION|EDIT|INCREMENTAL_REFRESH|FULL_REFRESH',
'RowInfo' => [
'RowsDropped' => <integer>,
'RowsIngested' => <integer>,
],
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Ingestions
-
- Type: Array of Ingestion structures
A list of the ingestions.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The resource specified already exists.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags assigned to a resource.
CLI syntax:
-
aws quicksight list-tags-for-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --region us-east-1
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'Tags' => [
[
'Key' => '<string>',
'Value' => '<string>',
],
// ...
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
ListTemplateAliases
$result = $client->listTemplateAliases([/* ... */]); $promise = $client->listTemplateAliasesAsync([/* ... */]);
Lists all the aliases of a template.
CLI syntax:
aws quicksight list-template-aliases --aws-account-id 111122223333 —template-id 'reports_test_template'
Parameter Syntax
$result = $client->listTemplateAliases([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template aliases you are listing.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateAliasList' => [
[
'AliasName' => '<string>',
'Arn' => '<string>',
'TemplateVersionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateAliasList
-
- Type: Array of TemplateAlias structures
A structure containing the list of template aliases.
Errors
-
Access is throttled.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListTemplateVersions
$result = $client->listTemplateVersions([/* ... */]); $promise = $client->listTemplateVersionsAsync([/* ... */]);
Lists all the versions of the templates in the Quicksight account.
CLI syntax:
aws quicksight list-template-versions --aws-account-id 111122223333 --aws-account-id 196359894473 --template-id reports-test-template
Parameter Syntax
$result = $client->listTemplateVersions([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the templates you are listing.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateVersionSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'VersionNumber' => <integer>,
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateVersionSummaryList
-
- Type: Array of TemplateVersionSummary structures
A structure containing a list of all the versions of the specified template.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
The
NextTokenvalue isn't valid. -
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListTemplates
$result = $client->listTemplates([/* ... */]); $promise = $client->listTemplatesAsync([/* ... */]);
Lists all the templates in the QuickSight account.
CLI syntax:
aws quicksight list-templates --aws-account-id 111122223333 --max-results 1 —next-token AYADeJuxwOypAndSoOn
Parameter Syntax
$result = $client->listTemplates([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'LatestVersionNumber' => <integer>,
'Name' => '<string>',
'TemplateId' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateSummaryList
-
- Type: Array of TemplateSummary structures
A structure containing information about the templates in the list.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
The
NextTokenvalue isn't valid. -
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
ListUserGroups
$result = $client->listUserGroups([/* ... */]); $promise = $client->listUserGroupsAsync([/* ... */]);
Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
The response is a one or more group objects.
CLI Sample:
aws quicksight list-user-groups -\-user-name=Pat -\-aws-account-id=111122223333 -\-namespace=default -\-region=us-east-1
Parameter Syntax
$result = $client->listUserGroups([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- UserName
-
- Required: Yes
- Type: string
The Amazon QuickSight user name that you want to list group memberships for.
Result Syntax
[
'GroupList' => [
[
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
'PrincipalId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- GroupList
-
- Type: Array of Group structures
The list of groups the user is a member of.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
-
This resource is currently unavailable.
ListUsers
$result = $client->listUsers([/* ... */]); $promise = $client->listUsersAsync([/* ... */]);
Returns a list of all of the Amazon QuickSight users belonging to this account.
The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address.
CLI Sample:
aws quicksight list-users --aws-account-id=111122223333 --namespace=default
Parameter Syntax
$result = $client->listUsers([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'Namespace' => '<string>', // REQUIRED
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- MaxResults
-
- Type: int
The maximum number of results to return from this request.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'UserList' => [
[
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'PrincipalId' => '<string>',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
// ...
],
]
Result Details
Members
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- UserList
-
- Type: Array of User structures
The list of users.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
-
This resource is currently unavailable.
RegisterUser
$result = $client->registerUser([/* ... */]); $promise = $client->registerUserAsync([/* ... */]);
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request.
CLI Sample:
aws quicksight register-user -\-aws-account-id=111122223333 -\-namespace=default -\-email=pat@example.com -\-identity-type=IAM -\-user-role=AUTHOR -\-iam-arn=arn:aws:iam::111122223333:user/Pat
Parameter Syntax
$result = $client->registerUser([
'AwsAccountId' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'IamArn' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'SessionName' => '<string>',
'UserName' => '<string>',
'UserRole' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
-
- Required: Yes
- Type: string
The email address of the user that you want to register.
- IamArn
-
- Type: string
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
- IdentityType
-
- Required: Yes
- Type: string
Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:
-
IAM: A user whose identity maps to an existing IAM user or role. -
QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - SessionName
-
- Type: string
You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see
assume-rolein the AWS CLI Reference. - UserName
-
- Type: string
The Amazon QuickSight user name that you want to create for the user you are registering.
- UserRole
-
- Required: Yes
- Type: string
The Amazon QuickSight role for the user. The user role can be one of the following:
-
READER: A user who has read-only access to dashboards. -
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. -
RESTRICTED_READER: This role isn't currently available for use. -
RESTRICTED_AUTHOR: This role isn't currently available for use.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'PrincipalId' => '<string>',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
'UserInvitationUrl' => '<string>',
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The user name.
- UserInvitationUrl
-
- Type: string
The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of
QUICKSIGHT.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
A limit is exceeded.
-
The resource specified already exists.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Assigns a tag or tags to a resource.
Assigns one or more tags (key-value pairs) to the specified QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource action with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data-set, data-source, dashboard, template.
Tagging for QuickSight works in a similar was to tagging for other AWS services, except for the following:
-
You can't use tags to track AWS costs for QuickSight, because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.
-
QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
CLI syntax to tag a resource:
-
aws quicksight tag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tags Key=K1,Value=V1 Key=K2,Value=V2 --region us-east-1
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The ARN of the resource you want to tag.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
A limit is exceeded.
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes a tag or tags from a resource.
CLI syntax:
-
aws quicksight untag-resource --resource-arn arn:aws:quicksight:us-east-1:111111111111:dataset/dataset1 --tag-keys K1 K2 --region us-east-1
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
UpdateDashboard
$result = $client->updateDashboard([/* ... */]); $promise = $client->updateDashboardAsync([/* ... */]);
Updates a dashboard in the AWS account.
CLI syntax:
aws quicksight update-dashboard --aws-account-id 111122223333 --dashboard-id 123123123 --dashboard-name "test-update102" --source-entity SourceTemplate={Arn=arn:aws:quicksight:us-west-2:111122223333:template/sales-report-template2} --data-set-references DataSetPlaceholder=SalesDataSet,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/0e251aef-9ebf-46e1-b852-eb4fa33c1d3a
aws quicksight update-dashboard --cli-input-json file://update-dashboard.json
Parameter Syntax
$result = $client->updateDashboard([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'DashboardPublishOptions' => [
'AdHocFilteringOption' => [
'AvailabilityStatus' => 'ENABLED|DISABLED',
],
'ExportToCSVOption' => [
'AvailabilityStatus' => 'ENABLED|DISABLED',
],
'SheetControlsOption' => [
'VisibilityState' => 'EXPANDED|COLLAPSED',
],
],
'Name' => '<string>', // REQUIRED
'Parameters' => [
'DateTimeParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<integer || string || DateTime>, ...], // REQUIRED
],
// ...
],
'DecimalParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<float>, ...], // REQUIRED
],
// ...
],
'IntegerParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => [<integer>, ...], // REQUIRED
],
// ...
],
'StringParameters' => [
[
'Name' => '<string>', // REQUIRED
'Values' => ['<string>', ...], // REQUIRED
],
// ...
],
],
'SourceEntity' => [ // REQUIRED
'SourceTemplate' => [
'Arn' => '<string>', // REQUIRED
'DataSetReferences' => [ // REQUIRED
[
'DataSetArn' => '<string>', // REQUIRED
'DataSetPlaceholder' => '<string>', // REQUIRED
],
// ...
],
],
],
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are updating.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- DashboardPublishOptions
-
- Type: DashboardPublishOptions structure
Publishing options when creating a dashboard.
-
AvailabilityStatus for AdHocFilteringOption - This can be either
ENABLEDorDISABLED. When This is set to set toDISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for AdHoc filtering. Enabled by default. -
AvailabilityStatus for ExportToCSVOption - This can be either
ENABLEDorDISABLED. The visual option to export data to CSV is disabled when this is set toDISABLED. Enabled by default. -
VisibilityState for SheetControlsOption - This can be either
COLLAPSEDorEXPANDED. The sheet controls pane is collapsed by default when set to true. Collapsed by default.
- Name
-
- Required: Yes
- Type: string
The display name of the dashboard.
- Parameters
-
- Type: Parameters structure
A structure that contains the parameters of the dashboard.
- SourceEntity
-
- Required: Yes
- Type: DashboardSourceEntity structure
The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Arn of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.
- VersionDescription
-
- Type: string
A description for the first version of the dashboard being created.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'DashboardId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the resource.
- CreationStatus
-
- Type: string
The creation status of the request.
- DashboardId
-
- Type: string
The ID for the dashboard.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- VersionArn
-
- Type: string
The ARN of the dashboard, including the version number.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Updating or deleting a resource can cause an inconsistent state.
-
A limit is exceeded.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateDashboardPermissions
$result = $client->updateDashboardPermissions([/* ... */]); $promise = $client->updateDashboardPermissionsAsync([/* ... */]);
Updates read and write permissions on a dashboard.
CLI syntax:
aws quicksight update-dashboard-permissions —cli-input-json file://update-permission.json
A sample update-permissions.json for granting read only permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard" ] } ] }
A sample update-permissions.json for granting read and write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "GrantPermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
A sample update-permissions.json for revoking write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
A sample update-permissions.json for revoking read and write permissions:
{ "AwsAccountId": "111122223333", "DashboardId": "reports_test_report", "RevokePermissions": [ { "Principal": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Actions": [ "quicksight:DescribeDashboard", "quicksight:ListDashboardVersions", "quicksight:DescribeDashboardVersion", "quicksight:QueryDashboard", "quicksight:DescribeDashboardPermissions", "quicksight:UpdateDashboardPermissions", "quicksight:DeleteDashboardVersion", "quicksight:DeleteDashboard", "quicksight:UpdateDashboard", "quicksight:UpdateDashboardPublishedVersion", ] } ] }
To obtain the principal name of a QuickSight user or group, you can use describe-group or describe-user. For example:
aws quicksight describe-user --aws-account-id 111122223333 --namespace default --user-name user2 --region us-east-1 { "User": { "Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2", "Active": true, "Email": "user2@example.com", "Role": "ADMIN", "UserName": "user2", "PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5" }, "RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31", "Status": 200 }
Parameter Syntax
$result = $client->updateDashboardPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the dashboard you are updating.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
The permissions that you want to grant on this resource.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
The permissions that you want to revoke from this resource.
Result Syntax
[
'DashboardArn' => '<string>',
'DashboardId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- DashboardArn
-
- Type: string
The ARN of the dashboard.
- DashboardId
-
- Type: string
The ID for the dashboard.
- Permissions
-
- Type: Array of ResourcePermission structures
Information about the permissions on the dashboard.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
Updating or deleting a resource can cause an inconsistent state.
-
An internal failure occurred.
UpdateDashboardPublishedVersion
$result = $client->updateDashboardPublishedVersion([/* ... */]); $promise = $client->updateDashboardPublishedVersionAsync([/* ... */]);
Updates the published version of a dashboard.
CLI syntax:
aws quicksight update-dashboard-published-version --aws-account-id 111122223333 --dashboard-id dashboard-w1 ---version-number 2
Parameter Syntax
$result = $client->updateDashboardPublishedVersion([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'VersionNumber' => <integer>, // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'DashboardArn' => '<string>',
'DashboardId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
Updating or deleting a resource can cause an inconsistent state.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateDataSet
$result = $client->updateDataSet([/* ... */]); $promise = $client->updateDataSetAsync([/* ... */]);
Updates a dataset.
CLI syntax:
aws quicksight update-data-set \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--name='My dataset' \
--import-mode=SPICE \
--physical-table-map='{
"physical-table-id": {
"RelationalTable": {
"DataSourceArn": "arn:aws:quicksight:us-west-2:111111111111:datasource/data-source-id",
"Name": "table1",
"InputColumns": [
{
"Name": "column1",
"Type": "STRING"
}
]
}
}'
Parameter Syntax
$result = $client->updateDataSet([
'AwsAccountId' => '<string>', // REQUIRED
'ColumnGroups' => [
[
'GeoSpatialColumnGroup' => [
'Columns' => ['<string>', ...], // REQUIRED
'CountryCode' => 'US', // REQUIRED
'Name' => '<string>', // REQUIRED
],
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'ImportMode' => 'SPICE|DIRECT_QUERY', // REQUIRED
'LogicalTableMap' => [
'<LogicalTableId>' => [
'Alias' => '<string>', // REQUIRED
'DataTransforms' => [
[
'CastColumnTypeOperation' => [
'ColumnName' => '<string>', // REQUIRED
'Format' => '<string>',
'NewColumnType' => 'STRING|INTEGER|DECIMAL|DATETIME', // REQUIRED
],
'CreateColumnsOperation' => [
'Columns' => [ // REQUIRED
[
'ColumnId' => '<string>', // REQUIRED
'ColumnName' => '<string>', // REQUIRED
'Expression' => '<string>', // REQUIRED
],
// ...
],
],
'FilterOperation' => [
'ConditionExpression' => '<string>', // REQUIRED
],
'ProjectOperation' => [
'ProjectedColumns' => ['<string>', ...], // REQUIRED
],
'RenameColumnOperation' => [
'ColumnName' => '<string>', // REQUIRED
'NewColumnName' => '<string>', // REQUIRED
],
'TagColumnOperation' => [
'ColumnName' => '<string>', // REQUIRED
'Tags' => [ // REQUIRED
[
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [ // REQUIRED
'JoinInstruction' => [
'LeftOperand' => '<string>', // REQUIRED
'OnClause' => '<string>', // REQUIRED
'RightOperand' => '<string>', // REQUIRED
'Type' => 'INNER|OUTER|LEFT|RIGHT', // REQUIRED
],
'PhysicalTableId' => '<string>',
],
],
// ...
],
'Name' => '<string>', // REQUIRED
'PhysicalTableMap' => [ // REQUIRED
'<PhysicalTableId>' => [
'CustomSql' => [
'Columns' => [
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'DataSourceArn' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'SqlQuery' => '<string>', // REQUIRED
],
'RelationalTable' => [
'DataSourceArn' => '<string>', // REQUIRED
'InputColumns' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'Name' => '<string>', // REQUIRED
'Schema' => '<string>',
],
'S3Source' => [
'DataSourceArn' => '<string>', // REQUIRED
'InputColumns' => [ // REQUIRED
[
'Name' => '<string>', // REQUIRED
'Type' => 'STRING|INTEGER|DECIMAL|DATETIME|BIT|BOOLEAN|JSON', // REQUIRED
],
// ...
],
'UploadSettings' => [
'ContainsHeader' => true || false,
'Delimiter' => '<string>',
'Format' => 'CSV|TSV|CLF|ELF|XLSX|JSON',
'StartFromRow' => <integer>,
'TextQualifier' => 'DOUBLE_QUOTE|SINGLE_QUOTE',
],
],
],
// ...
],
'RowLevelPermissionDataSet' => [
'Arn' => '<string>', // REQUIRED
'PermissionPolicy' => 'GRANT_ACCESS|DENY_ACCESS', // REQUIRED
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- ColumnGroups
-
- Type: Array of ColumnGroup structures
Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.
- DataSetId
-
- Required: Yes
- Type: string
The ID for the dataset you want to create. This is unique per region per AWS account.
- ImportMode
-
- Required: Yes
- Type: string
Indicates whether or not you want to import the data into SPICE.
- LogicalTableMap
-
- Type: Associative array of custom strings keys (LogicalTableId) to LogicalTable structures
Configures the combination and transformation of the data from the physical tables.
- Name
-
- Required: Yes
- Type: string
The display name for the dataset.
- PhysicalTableMap
-
- Required: Yes
- Type: Associative array of custom strings keys (PhysicalTableId) to PhysicalTable structures
Declares the physical tables that are available in the underlying data sources.
- RowLevelPermissionDataSet
-
- Type: RowLevelPermissionDataSet structure
Row-level security configuration on the data you want to create.
Result Syntax
[
'Arn' => '<string>',
'DataSetId' => '<string>',
'IngestionArn' => '<string>',
'IngestionId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset you want to create. This is unique per region per AWS account.
- IngestionArn
-
- Type: string
The Amazon Resource Name (ARN) for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
- IngestionId
-
- Type: string
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
A limit is exceeded.
-
Access is throttled.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateDataSetPermissions
$result = $client->updateDataSetPermissions([/* ... */]); $promise = $client->updateDataSetPermissionsAsync([/* ... */]);
Updates the permissions on a dataset.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id
CLI syntax:
aws quicksight update-data-set-permissions \
--aws-account-id=111122223333 \
--data-set-id=unique-data-set-id \
--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSet","quicksight:DescribeDataSetPermissions","quicksight:PassDataSet","quicksight:ListIngestions","quicksight:DescribeIngestion"]}]' \
--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSet","quicksight:DeleteDataSet","quicksight:UpdateDataSetPermissions","quicksight:CreateIngestion","quicksight:CancelIngestion"]}]'
Parameter Syntax
$result = $client->updateDataSetPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DataSetId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- DataSetId
-
- Required: Yes
- Type: string
The ID for the dataset you want to create. This is unique per region per AWS account.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
The resource permissions that you want to grant to the dataset.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
The resource permissions that you want to revoke from the dataset.
Result Syntax
[
'DataSetArn' => '<string>',
'DataSetId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
UpdateDataSource
$result = $client->updateDataSource([/* ... */]); $promise = $client->updateDataSourceAsync([/* ... */]);
Updates a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight update-data-source \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--data-source-parameters='{"PostgreSqlParameters":{"Host":"my-db-host.example.com","Port":1234,"Database":"my-db"}}' \
--credentials='{"CredentialPair":{"Username":"username","Password":"password"}}
Parameter Syntax
$result = $client->updateDataSource([
'AwsAccountId' => '<string>', // REQUIRED
'Credentials' => [
'CredentialPair' => [
'Password' => '<string>', // REQUIRED
'Username' => '<string>', // REQUIRED
],
],
'DataSourceId' => '<string>', // REQUIRED
'DataSourceParameters' => [
'AmazonElasticsearchParameters' => [
'Domain' => '<string>', // REQUIRED
],
'AthenaParameters' => [
'WorkGroup' => '<string>',
],
'AuroraParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'AuroraPostgreSqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'AwsIotAnalyticsParameters' => [
'DataSetName' => '<string>', // REQUIRED
],
'JiraParameters' => [
'SiteBaseUrl' => '<string>', // REQUIRED
],
'MariaDbParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'MySqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'PostgreSqlParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'PrestoParameters' => [
'Catalog' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'RdsParameters' => [
'Database' => '<string>', // REQUIRED
'InstanceId' => '<string>', // REQUIRED
],
'RedshiftParameters' => [
'ClusterId' => '<string>',
'Database' => '<string>', // REQUIRED
'Host' => '<string>',
'Port' => <integer>,
],
'S3Parameters' => [
'ManifestFileLocation' => [ // REQUIRED
'Bucket' => '<string>', // REQUIRED
'Key' => '<string>', // REQUIRED
],
],
'ServiceNowParameters' => [
'SiteBaseUrl' => '<string>', // REQUIRED
],
'SnowflakeParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Warehouse' => '<string>', // REQUIRED
],
'SparkParameters' => [
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'SqlServerParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'TeradataParameters' => [
'Database' => '<string>', // REQUIRED
'Host' => '<string>', // REQUIRED
'Port' => <integer>, // REQUIRED
],
'TwitterParameters' => [
'MaxRows' => <integer>, // REQUIRED
'Query' => '<string>', // REQUIRED
],
],
'Name' => '<string>', // REQUIRED
'SslProperties' => [
'DisableSsl' => true || false,
],
'VpcConnectionProperties' => [
'VpcConnectionArn' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID.
- Credentials
-
- Type: DataSourceCredentials structure
The credentials QuickSight uses to connect to your underlying source. Currently only username/password based credentials are supported.
- DataSourceId
-
- Required: Yes
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters QuickSight uses to connect to your underlying source.
- Name
-
- Required: Yes
- Type: string
A display name for the data source.
- SslProperties
-
- Type: SslProperties structure
SSL properties that apply when QuickSight connects to your underlying source.
- VpcConnectionProperties
-
- Type: VpcConnectionProperties structure
You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
Result Syntax
[
'Arn' => '<string>',
'DataSourceId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'UpdateStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the data source.
- DataSourceId
-
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- UpdateStatus
-
- Type: string
The update status of the data source's last update.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Access is throttled.
-
One or more resources can't be found.
-
An internal failure occurred.
UpdateDataSourcePermissions
$result = $client->updateDataSourcePermissions([/* ... */]); $promise = $client->updateDataSourcePermissionsAsync([/* ... */]);
Updates the permissions to a data source.
The permissions resource is arn:aws:quicksight:region:aws-account-id:datasource/data-source-id
CLI syntax:
aws quicksight update-data-source-permissions \
--aws-account-id=111122223333 \
--data-source-id=unique-data-source-id \
--name='My Data Source' \
--grant-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user1","Actions":["quicksight:DescribeDataSource","quicksight:DescribeDataSourcePermissions","quicksight:PassDataSource"]}]' \
--revoke-permissions='[{"Principal":"arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Actions":["quicksight:UpdateDataSource","quicksight:DeleteDataSource","quicksight:UpdateDataSourcePermissions"]}]'
Parameter Syntax
$result = $client->updateDataSourcePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'DataSourceId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID.
- DataSourceId
-
- Required: Yes
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions that you want to grant on the data source.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions that you want to revoke on the data source.
Result Syntax
[
'DataSourceArn' => '<string>',
'DataSourceId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
Updating or deleting a resource can cause an inconsistent state.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
UpdateGroup
$result = $client->updateGroup([/* ... */]); $promise = $client->updateGroupAsync([/* ... */]);
Changes a group description.
The permissions resource is arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> .
The response is a group object.
CLI Sample:
aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description="Sales BI Dashboards"
Parameter Syntax
$result = $client->updateGroup([
'AwsAccountId' => '<string>', // REQUIRED
'Description' => '<string>',
'GroupName' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
- Description
-
- Type: string
The description for the group that you want to update.
- GroupName
-
- Required: Yes
- Type: string
The name of the group that you want to update.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default.
Result Syntax
[
'Group' => [
'Arn' => '<string>',
'Description' => '<string>',
'GroupName' => '<string>',
'PrincipalId' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Group
-
- Type: Group structure
The name of the group.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
UpdateIAMPolicyAssignment
$result = $client->updateIAMPolicyAssignment([/* ... */]); $promise = $client->updateIAMPolicyAssignmentAsync([/* ... */]);
Updates an existing assignment. This operation updates only the optional parameter or parameters that are specified in the request.
CLI syntax:
aws quicksight update-iam-policy-assignment --aws-account-id=111122223333 --assignment-name=FullAccessAssignment --assignment-status=DRAFT --policy-arns=arn:aws:iam::aws:policy/AdministratorAccess --identities="user=user-1,user-2,group=admin" --namespace=default --region=us-east-1
Parameter Syntax
$result = $client->updateIAMPolicyAssignment([
'AssignmentName' => '<string>', // REQUIRED
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
'AwsAccountId' => '<string>', // REQUIRED
'Identities' => [
'<String>' => ['<string>', ...],
// ...
],
'Namespace' => '<string>', // REQUIRED
'PolicyArn' => '<string>',
]);
Parameter Details
Members
- AssignmentName
-
- Required: Yes
- Type: string
The name of the assignment. It must be unique within an AWS account.
- AssignmentStatus
-
- Type: string
The status of an assignment:
-
ENABLED - Anything specified in this assignment is used while creating the data source.
-
DISABLED - This assignment isn't used while creating the data source.
-
DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID that contains the IAM policy assignment.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
QuickSight users and/or groups that you want to assign to the specified IAM policy.
- Namespace
-
- Required: Yes
- Type: string
The namespace of the assignment.
- PolicyArn
-
- Type: string
An IAM policy ARN that will be applied to specified QuickSight users and groups in this assignment.
Result Syntax
[
'AssignmentId' => '<string>',
'AssignmentName' => '<string>',
'AssignmentStatus' => 'ENABLED|DRAFT|DISABLED',
'Identities' => [
'<String>' => ['<string>', ...],
// ...
],
'PolicyArn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AssignmentId
-
- Type: string
The ID of the assignment.
- AssignmentName
-
- Type: string
The name of the assignment.
- AssignmentStatus
-
- Type: string
The status of the assignment:
-
ENABLED - Anything specified in this assignment is used while creating the data source.
-
DISABLED - This assignment isn't used while creating the data source.
-
DRAFT - Assignment is an unfinished draft and isn't used while creating the data source.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
QuickSight users and/or groups that are assigned to this IAM policy.
- PolicyArn
-
- Type: string
The IAM policy ARN assigned to the QuickSight users and groups specified in this request.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in an "actionable" state that must complete before a new update can be applied.
-
An internal failure occurred.
UpdateTemplate
$result = $client->updateTemplate([/* ... */]); $promise = $client->updateTemplateAsync([/* ... */]);
Updates a template from an existing QuickSight analysis.
CLI syntax:
aws quicksight update-template --aws-account-id 111122223333 --template-id reports_test_template --data-set-references DataSetPlaceholder=reports,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/c684a204-d134-4c53-a63c-451f72c60c28 DataSetPlaceholder=Elblogs,DataSetArn=arn:aws:quicksight:us-west-2:111122223333:dataset/15840b7d-b542-4491-937b-602416b367b3 —source-entity SourceAnalysis=’{Arn=arn:aws:quicksight:us-west-2:111122223333:analysis/c5731fe9-4708-4598-8f6d-cf2a70875b6d}
You can also pass in a json file: aws quicksight update-template —cli-input-json file://create-template.json
Parameter Syntax
$result = $client->updateTemplate([
'AwsAccountId' => '<string>', // REQUIRED
'Name' => '<string>',
'SourceEntity' => [ // REQUIRED
'SourceAnalysis' => [
'Arn' => '<string>', // REQUIRED
'DataSetReferences' => [ // REQUIRED
[
'DataSetArn' => '<string>', // REQUIRED
'DataSetPlaceholder' => '<string>', // REQUIRED
],
// ...
],
],
'SourceTemplate' => [
'Arn' => '<string>', // REQUIRED
],
],
'TemplateId' => '<string>', // REQUIRED
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template you are updating.
- Name
-
- Type: string
The name for the template.
- SourceEntity
-
- Required: Yes
- Type: TemplateSourceEntity structure
The source QuickSight entity from which this template is being created. Templates can be currently created from an Analysis or another template.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
- VersionDescription
-
- Type: string
A description of the current template version being created. This API created the first version of the template. Every time UpdateTemplate is called a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the template.
- CreationStatus
-
- Type: string
The creation status of the template.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateId
-
- Type: string
The ID for the template.
- VersionArn
-
- Type: string
The Amazon Resource Name (ARN) for the template, including the version information of the first version.
Errors
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
Updating or deleting a resource can cause an inconsistent state.
-
A limit is exceeded.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateTemplateAlias
$result = $client->updateTemplateAlias([/* ... */]); $promise = $client->updateTemplateAliasAsync([/* ... */]);
Updates the template alias of a template.
CLI syntax:
aws quicksight update-template-alias --aws-account-id 111122223333 --template-id 'reports_test_template' --alias-name STAGING —template-version-number 2
Parameter Syntax
$result = $client->updateTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'TemplateVersionNumber' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The alias name.
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template aliases you are updating.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
- TemplateVersionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the template.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'TemplateVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateAlias
-
- Type: TemplateAlias structure
The template alias.
Errors
-
Access is throttled.
-
One or more resources can't be found.
-
Updating or deleting a resource can cause an inconsistent state.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateTemplatePermissions
$result = $client->updateTemplatePermissions([/* ... */]); $promise = $client->updateTemplatePermissionsAsync([/* ... */]);
Updates the permissions on a template.
CLI syntax:
-
aws quicksight describe-template-permissions —aws-account-id 111122223333 —template-id reports_test_template -
aws quicksight update-template-permissions —cli-input-json file://update-permission.json -
The structure of
update-permissions.jsonto add permissions:{ "AwsAccountId": "111122223333","DashboardId": "reports_test_template","GrantPermissions": [{ "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3","Actions": ["quicksight:DescribeTemplate","quicksight:ListTemplateVersions"] } ] }The structure of
update-permissions.jsonto add permissions:{ "AwsAccountId": "111122223333","DashboardId": "reports_test_template","RevokePermissions": [{ "Principal": "arn:aws:quicksight:us-east-1:196359894473:user/default/user3","Actions": ["quicksight:DescribeTemplate","quicksight:ListTemplateVersions"] } ] }To obtain the principal name of a QuickSight group or user, use user describe-group or describe-user. For example:
aws quicksight describe-user--aws-account-id 111122223333--namespace default--user-name user2--region us-east-1{"User": {"Arn": "arn:aws:quicksight:us-east-1:111122223333:user/default/user2","Active": true,"Email": "user2@example.com","Role": "ADMIN","UserName": "user2","PrincipalId": "federated/iam/abcd2abcdabcdeabc5ab5"},"RequestId": "8f74bb31-6291-448a-a71c-a765a44bae31","Status": 200}
Parameter Syntax
$result = $client->updateTemplatePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
AWS account ID that contains the template.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be granted on the template. The following example shows the shorthand syntax:
Shorthand Syntax: Principal=string,Actions=string,string ... - RevokePermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be revoked from the template. Shorthand syntax:
Shorthand Syntax: Principal=string,Actions=string,string ... - TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
Result Syntax
[
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateArn' => '<string>',
'TemplateId' => '<string>',
]
Result Details
Members
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be set on the template.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- TemplateArn
-
- Type: string
The ARN of the template.
- TemplateId
-
- Type: string
The ID for the template.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
Updating or deleting a resource can cause an inconsistent state.
-
One or more resources can't be found.
-
UnsupportedUserEditionException:
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
-
An internal failure occurred.
UpdateUser
$result = $client->updateUser([/* ... */]); $promise = $client->updateUserAsync([/* ... */]);
Updates an Amazon QuickSight user.
The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN).
CLI Sample:
aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@example.com --aws-account-id=111122223333 --namespace=default --region=us-east-1
Parameter Syntax
$result = $client->updateUser([
'AwsAccountId' => '<string>', // REQUIRED
'Email' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER', // REQUIRED
'UserName' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
-
- Required: Yes
- Type: string
The email address of the user that you want to update.
- Namespace
-
- Required: Yes
- Type: string
The namespace. Currently, you should set this to
default. - Role
-
- Required: Yes
- Type: string
The Amazon QuickSight role of the user. The user role can be one of the following:
-
READER: A user who has read-only access to dashboards. -
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings.
- UserName
-
- Required: Yes
- Type: string
The Amazon QuickSight user name that you want to update.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'User' => [
'Active' => true || false,
'Arn' => '<string>',
'Email' => '<string>',
'IdentityType' => 'IAM|QUICKSIGHT',
'PrincipalId' => '<string>',
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER',
'UserName' => '<string>',
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The http status of the request.
- User
-
- Type: User structure
The Amazon QuickSight user.
Errors
-
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
-
InvalidParameterValueException:
One or more parameters don't have a valid value.
-
One or more resources can't be found.
-
Access is throttled.
-
An internal failure occurred.
-
This resource is currently unavailable.
Shapes
AccessDeniedException
Description
You don't have access to this. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Ensure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.
Members
ActiveIAMPolicyAssignment
Description
The active IAM policy assignment.
Members
AdHocFilteringOption
AmazonElasticsearchParameters
Description
Amazon Elasticsearch parameters.
Members
AthenaParameters
AuroraParameters
Description
Aurora parameters.
Members
AuroraPostgreSqlParameters
Description
Aurora PostgreSQL parameters.
Members
AwsIotAnalyticsParameters
Description
AWS IoT Analytics parameters.
Members
CalculatedColumn
Description
A calculated column for a dataset.
Members
- ColumnId
-
- Required: Yes
- Type: string
A unique ID to identify a calculated column. During dataset update, if the column ID of a calculated column matches that of an existing calculated column, QuickSight preserves the existing calculated column.
- ColumnName
-
- Required: Yes
- Type: string
Column name.
- Expression
-
- Required: Yes
- Type: string
An expression that defines the calculated column.
CastColumnTypeOperation
Description
A transform operation that casts a column to a different type.
Members
ColumnGroup
Description
Groupings of columns that work together in certain QuickSight features. This is a variant type structure. No more than one of the attributes should be non-null for this structure to be valid.
Members
- GeoSpatialColumnGroup
-
- Type: GeoSpatialColumnGroup structure
Geospatial column group that denotes a hierarchy.
ColumnGroupColumnSchema
Description
A structure describing the name, datatype, and geographic role of the columns.
Members
ColumnGroupSchema
Description
The column group schema.
Members
- ColumnGroupColumnSchemaList
-
- Type: Array of ColumnGroupColumnSchema structures
A structure containing the list of column group column schemas.
- Name
-
- Type: string
The name of the column group schema.
ColumnSchema
Description
The column schema.
Members
ColumnTag
Description
A tag for a column in a TagColumnOperation. This is a variant type structure. No more than one of the attributes should be non-null for this structure to be valid.
Members
ConcurrentUpdatingException
Description
A resource is already in an "actionable" state that must complete before a new update can be applied.
Members
ConflictException
Description
Updating or deleting a resource can cause an inconsistent state.
Members
CreateColumnsOperation
Description
A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.
Members
- Columns
-
- Required: Yes
- Type: Array of CalculatedColumn structures
Calculated columns to create.
CredentialPair
Description
The combination of username and password that are used as credentials.
Members
CustomSql
Description
A physical table type built from the results of the custom SQL query.
Members
- Columns
-
- Type: Array of InputColumn structures
The column schema from the SQL query result set.
- DataSourceArn
-
- Required: Yes
- Type: string
The ARN of the data source.
- Name
-
- Required: Yes
- Type: string
A display name for the SQL query result.
- SqlQuery
-
- Required: Yes
- Type: string
The SQL query.
Dashboard
Description
Dashboard.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the resource.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DashboardId
-
- Type: string
Dashboard ID.
- LastPublishedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was published.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- Name
-
- Type: string
A display name for the dataset.
- Version
-
- Type: DashboardVersion structure
Version.
DashboardError
DashboardPublishOptions
Description
Dashboard publish options.
Members
- AdHocFilteringOption
-
- Type: AdHocFilteringOption structure
Ad hoc filtering option.
- ExportToCSVOption
-
- Type: ExportToCSVOption structure
Export to CSV option.
- SheetControlsOption
-
- Type: SheetControlsOption structure
Sheet controls option.
DashboardSourceEntity
Description
Dashboard source entity.
Members
- SourceTemplate
-
- Type: DashboardSourceTemplate structure
Source template.
DashboardSourceTemplate
Description
Dashboard source template.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource name (ARN) of the resource.
- DataSetReferences
-
- Required: Yes
- Type: Array of DataSetReference structures
Dataset references.
DashboardSummary
Description
Dashboard summary.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the resource.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DashboardId
-
- Type: string
Dashboard ID.
- LastPublishedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was published.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- Name
-
- Type: string
A display name for the dataset.
- PublishedVersionNumber
-
- Type: long (int|float)
Published version number.
DashboardVersion
Description
Dashboard version.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the resource.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- Description
-
- Type: string
Description.
- Errors
-
- Type: Array of DashboardError structures
Errors.
- SourceEntityArn
-
- Type: string
Source entity ARN.
- Status
-
- Type: string
The http status of the request.
- VersionNumber
-
- Type: long (int|float)
Version number.
DashboardVersionSummary
Description
Dashboard version summary.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the resource.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- Description
-
- Type: string
Description.
- SourceEntityArn
-
- Type: string
Source entity ARN.
- Status
-
- Type: string
The http status of the request.
- VersionNumber
-
- Type: long (int|float)
Version number.
DataSet
Description
Dataset.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the resource.
- ColumnGroups
-
- Type: Array of ColumnGroup structures
Groupings of columns that work together in certain QuickSight features. Currently only geospatial hierarchy is supported.
- ConsumedSpiceCapacityInBytes
-
- Type: long (int|float)
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DataSetId
-
- Type: string
The ID of the dataset.
- ImportMode
-
- Type: string
Indicates whether or not you want to import the data into SPICE.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- LogicalTableMap
-
- Type: Associative array of custom strings keys (LogicalTableId) to LogicalTable structures
Configures the combination and transformation of the data from the physical tables.
- Name
-
- Type: string
A display name for the dataset.
- OutputColumns
-
- Type: Array of OutputColumn structures
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
- PhysicalTableMap
-
- Type: Associative array of custom strings keys (PhysicalTableId) to PhysicalTable structures
Declares the physical tables that are available in the underlying data sources.
- RowLevelPermissionDataSet
-
- Type: RowLevelPermissionDataSet structure
Row-level security configuration on the dataset.
DataSetConfiguration
Description
Dataset configuration.
Members
- ColumnGroupSchemaList
-
- Type: Array of ColumnGroupSchema structures
A structure containing the list of column group schemas.
- DataSetSchema
-
- Type: DataSetSchema structure
Dataset schema.
- Placeholder
-
- Type: string
Placeholder.
DataSetReference
Description
Dataset reference.
Members
DataSetSchema
Description
Dataset schema.
Members
- ColumnSchemaList
-
- Type: Array of ColumnSchema structures
A structure containing the list of column schemas.
DataSetSummary
Description
Dataset summary.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the dataset.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DataSetId
-
- Type: string
The ID of the dataset.
- ImportMode
-
- Type: string
Indicates whether or not you want to import the data into SPICE.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- Name
-
- Type: string
A display name for the dataset.
- RowLevelPermissionDataSet
-
- Type: RowLevelPermissionDataSet structure
Row-level security configuration on the dataset.
DataSource
Description
The structure of a data source.
Members
- Arn
-
- Type: string
The Amazon Resource name (ARN) of the data source.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DataSourceId
-
- Type: string
The ID of the data source. This is unique per AWS Region per AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters QuickSight uses to connect to your underlying source. This is a variant type structure. At most one of the attributes should be non-null for this structure to be valid.
- ErrorInfo
-
- Type: DataSourceErrorInfo structure
Error information from the last update or the creation of the data source.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- Name
-
- Type: string
A display name for the data source.
- SslProperties
-
- Type: SslProperties structure
SSL properties that apply when QuickSight connects to your underlying source.
- Status
-
- Type: string
The http status of the request.
- Type
-
- Type: string
The type of the data source. This indicates which database engine the data source connects to.
- VpcConnectionProperties
-
- Type: VpcConnectionProperties structure
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
DataSourceCredentials
Description
Data source credentials.
Members
- CredentialPair
-
- Type: CredentialPair structure
Credential pair.
DataSourceErrorInfo
Description
Error information on data source creation or update.
Members
DataSourceParameters
Description
The parameters QuickSight uses to connect to your underlying source. This is a variant type structure. At most one of the attributes should be non-null for this structure to be valid.
Members
- AmazonElasticsearchParameters
-
- Type: AmazonElasticsearchParameters structure
Amazon Elasticsearch parameters.
- AthenaParameters
-
- Type: AthenaParameters structure
Athena parameters.
- AuroraParameters
-
- Type: AuroraParameters structure
Aurora MySQL parameters.
- AuroraPostgreSqlParameters
-
- Type: AuroraPostgreSqlParameters structure
Aurora PostgreSQL parameters.
- AwsIotAnalyticsParameters
-
- Type: AwsIotAnalyticsParameters structure
AWS IoT Analytics parameters.
- JiraParameters
-
- Type: JiraParameters structure
Jira parameters.
- MariaDbParameters
-
- Type: MariaDbParameters structure
MariaDB parameters.
- MySqlParameters
-
- Type: MySqlParameters structure
MySQL parameters.
- PostgreSqlParameters
-
- Type: PostgreSqlParameters structure
PostgreSQL parameters.
- PrestoParameters
-
- Type: PrestoParameters structure
Presto parameters.
- RdsParameters
-
- Type: RdsParameters structure
RDS parameters.
- RedshiftParameters
-
- Type: RedshiftParameters structure
Redshift parameters.
- S3Parameters
-
- Type: S3Parameters structure
S3 parameters.
- ServiceNowParameters
-
- Type: ServiceNowParameters structure
ServiceNow parameters.
- SnowflakeParameters
-
- Type: SnowflakeParameters structure
Snowflake parameters.
- SparkParameters
-
- Type: SparkParameters structure
Spark parameters.
- SqlServerParameters
-
- Type: SqlServerParameters structure
SQL Server parameters.
- TeradataParameters
-
- Type: TeradataParameters structure
Teradata parameters.
- TwitterParameters
-
- Type: TwitterParameters structure
Twitter parameters.
DateTimeParameter
Description
Date time parameter.
Members
DecimalParameter
Description
Decimal parameter.
Members
DomainNotWhitelistedException
Description
The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
Members
ErrorInfo
Description
Error information on a data set SPICE ingestion.
Members
ExportToCSVOption
FilterOperation
Description
A transform operation that filters rows based on some condition.
Members
GeoSpatialColumnGroup
Description
Geospatial column group that denotes a hierarchy.
Members
Group
Description
A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.
Members
GroupMember
Description
A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .
Members
IAMPolicyAssignment
Description
IAM policy assignment.
Members
- AssignmentId
-
- Type: string
Assignment ID.
- AssignmentName
-
- Type: string
Assignment name.
- AssignmentStatus
-
- Type: string
Assignment status.
- AwsAccountId
-
- Type: string
AWS account ID.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
Identities.
- PolicyArn
-
- Type: string
Policy ARN.
IAMPolicyAssignmentSummary
Description
IAM policy assignment Summary.
Members
IdentityTypeNotSupportedException
Description
The identity type specified is not supported. Supported identity types include IAM and QUICKSIGHT.
Members
Ingestion
Description
Information on the SPICE ingestion for a dataset.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource name (ARN) of the resource.
- CreatedTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this ingestion started.
- ErrorInfo
-
- Type: ErrorInfo structure
Error information for this ingestion.
- IngestionId
-
- Type: string
Ingestion ID.
- IngestionSizeInBytes
-
- Type: long (int|float)
Size of the data ingested in bytes.
- IngestionStatus
-
- Required: Yes
- Type: string
Ingestion status.
- IngestionTimeInSeconds
-
- Type: long (int|float)
The time this ingestion took, measured in seconds.
- QueueInfo
-
- Type: QueueInfo structure
Information on queued dataset SPICE ingestion.
- RequestSource
-
- Type: string
Event source for this ingestion.
- RequestType
-
- Type: string
Type of this ingestion.
- RowInfo
-
- Type: RowInfo structure
Information on rows during a data set SPICE ingestion.
InputColumn
Description
Metadata on a column that is used as the input of a transform operation.
Members
IntegerParameter
Description
Integer parameter.
Members
InternalFailureException
Description
An internal failure occurred.
Members
InvalidNextTokenException
Description
The NextToken value isn't valid.
Members
InvalidParameterValueException
Description
One or more parameters don't have a valid value.
Members
JiraParameters
Description
Jira parameters.
Members
JoinInstruction
Description
Join instruction.
Members
LimitExceededException
Description
A limit is exceeded.
Members
LogicalTable
Description
A unit that joins and data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When it points to a physical table, a logical table acts as a mutable copy of that table through transform operations.
Members
- Alias
-
- Required: Yes
- Type: string
A display name for the logical table.
- DataTransforms
-
- Type: Array of TransformOperation structures
Transform operations that act on this logical table.
- Source
-
- Required: Yes
- Type: LogicalTableSource structure
Source of this logical table.
LogicalTableSource
Description
Information on the source of a logical table. This is a variant type structure. No more than one of the attributes should be non-null for this structure to be valid.
Members
- JoinInstruction
-
- Type: JoinInstruction structure
Specifies the result of a join of two logical tables.
- PhysicalTableId
-
- Type: string
Physical table ID.
ManifestFileLocation
Description
Amazon S3 manifest file location.
Members
MariaDbParameters
Description
MariaDB parameters.
Members
MySqlParameters
Description
MySQL parameters.
Members
OutputColumn
Description
Output column.
Members
Parameters
Description
Parameters.
Members
- DateTimeParameters
-
- Type: Array of DateTimeParameter structures
DateTime parameters.
- DecimalParameters
-
- Type: Array of DecimalParameter structures
Decimal parameters.
- IntegerParameters
-
- Type: Array of IntegerParameter structures
Integer parameters.
- StringParameters
-
- Type: Array of StringParameter structures
String parameters.
PhysicalTable
Description
A view of a data source. Contains information on the shape of the data in the underlying source. This is a variant type structure. No more than one of the attributes can be non-null for this structure to be valid.
Members
- CustomSql
-
- Type: CustomSql structure
A physical table type built from the results of the custom SQL query.
- RelationalTable
-
- Type: RelationalTable structure
A physical table type for relational data sources.
- S3Source
-
- Type: S3Source structure
A physical table type for as S3 data source.
PostgreSqlParameters
Description
PostgreSQL parameters.
Members
PreconditionNotMetException
Description
One or more preconditions aren't met.
Members
PrestoParameters
Description
Presto parameters.
Members
ProjectOperation
Description
A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.
Members
QueueInfo
Description
Information on queued dataset SPICE ingestion.
Members
QuickSightUserNotFoundException
Description
The user is not found. This error can happen in any operation that requires finding a user based on a provided user name, such as DeleteUser, DescribeUser, and so on.
Members
RdsParameters
Description
RDS parameters.
Members
RedshiftParameters
Description
Redshift parameters. The ClusterId field can be blank if Host and Port are both set, and the other way around.
Members
RelationalTable
Description
A physical table type for relational data sources.
Members
- DataSourceArn
-
- Required: Yes
- Type: string
Data source ARN.
- InputColumns
-
- Required: Yes
- Type: Array of InputColumn structures
The column schema of the table.
- Name
-
- Required: Yes
- Type: string
Name of the relational table.
- Schema
-
- Type: string
The schema name. Applies to certain relational database engines.
RenameColumnOperation
Description
A transform operation that renames a column.
Members
ResourceExistsException
Description
The resource specified already exists.
Members
ResourceNotFoundException
Description
One or more resources can't be found.
Members
ResourcePermission
Description
Permission for the resource.
Members
- Actions
-
- Required: Yes
- Type: Array of strings
The action to grant or revoke permissions on. For example, "quicksight:DescribeDashboard".
- Principal
-
- Required: Yes
- Type: string
The ARN of a QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .
ResourceUnavailableException
Description
This resource is currently unavailable.
Members
RowInfo
Description
Information on rows during a data set SPICE ingestion.
Members
RowLevelPermissionDataSet
Description
Row-level security configuration on the dataset.
Members
S3Parameters
Description
S3 parameters.
Members
- ManifestFileLocation
-
- Required: Yes
- Type: ManifestFileLocation structure
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
S3Source
Description
A physical table type for as S3 data source.
Members
- DataSourceArn
-
- Required: Yes
- Type: string
Data source ARN.
- InputColumns
-
- Required: Yes
- Type: Array of InputColumn structures
A physical table type for as S3 data source.
- UploadSettings
-
- Type: UploadSettings structure
Information on the S3 source file(s) format.
ServiceNowParameters
Description
ServiceNow parameters.
Members
SessionLifetimeInMinutesInvalidException
Description
The number of minutes specified for the lifetime of a session is not valid. The session lifetime must be from 15 to 600 minutes.
Members
SheetControlsOption
SnowflakeParameters
Description
Snowflake parameters.
Members
SparkParameters
Description
Spark parameters.
Members
SqlServerParameters
Description
SQL Server parameters.
Members
SslProperties
Description
SSL properties that apply when QuickSight connects to your underlying data source.
Members
StringParameter
Description
String parameter.
Members
Tag
Description
The keys of the key-value pairs for the resource tag or tags assigned to the resource.
Members
TagColumnOperation
Description
A transform operation that tags a column with additional information.
Members
- ColumnName
-
- Required: Yes
- Type: string
The column that this operation acts on.
- Tags
-
- Required: Yes
- Type: Array of ColumnTag structures
The dataset column tag, currently only used for geospatial type tagging. .
This is not tags for the AWS tagging feature. .
Template
Description
A template object. A template is an entity in QuickSight which encapsulates the metadata required to create an analysis that can be used to create dashboard. It adds a layer of abstraction by replacing the dataset associated with the analysis with placeholders. Templates can be used to create dashboards by replacing dataset placeholders with datasets which follow the same schema that was used to create the source analysis and template.
You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.
Members
- Arn
-
- Type: string
The ARN of the template.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when this was created.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Time when this was last updated.
- Name
-
- Type: string
The display name of the template.
- TemplateId
-
- Type: string
The ID for the template. This is unique per region per AWS account.
- Version
-
- Type: TemplateVersion structure
A structure describing the versions of the template.
TemplateAlias
Description
The template alias.
Members
TemplateError
Description
List of errors that occurred when the template version creation failed.
Members
TemplateSourceAnalysis
Description
The source analysis of the template.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource name (ARN) of the resource.
- DataSetReferences
-
- Required: Yes
- Type: Array of DataSetReference structures
A structure containing information about the dataset references used as placeholders in the template.
TemplateSourceEntity
Description
The source entity of the template.
Members
- SourceAnalysis
-
- Type: TemplateSourceAnalysis structure
The source analysis, if it is based on an analysis.
- SourceTemplate
-
- Type: TemplateSourceTemplate structure
The source template, if it is based on an template.
TemplateSourceTemplate
Description
The source template of the template.
Members
TemplateSummary
Description
The template summary.
Members
- Arn
-
- Type: string
A summary of a template.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was created.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time this was updated.
- LatestVersionNumber
-
- Type: long (int|float)
A structure containing a list of version numbers for the template summary.
- Name
-
- Type: string
A display name for the template.
- TemplateId
-
- Type: string
The ID of the template. This is unique per region per AWS account.
TemplateVersion
Description
A version of a template.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- DataSetConfigurations
-
- Type: Array of DataSetConfiguration structures
Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
- Description
-
- Type: string
The description of the template.
- Errors
-
- Type: Array of TemplateError structures
Errors associated with the template.
- SourceEntityArn
-
- Type: string
The ARN of the analysis or template which was used to create this template.
- Status
-
- Type: string
The http status of the request.
- VersionNumber
-
- Type: long (int|float)
The version number of the template.
TemplateVersionSummary
Description
The template version.
Members
- Arn
-
- Type: string
The ARN of the template version.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time this was created.
- Description
-
- Type: string
The desription of the template version.
- Status
-
- Type: string
The status of the template version.
- VersionNumber
-
- Type: long (int|float)
The version number of the template version.
TeradataParameters
Description
Teradata parameters.
Members
ThrottlingException
Description
Access is throttled.
Members
TransformOperation
Description
A data transformation on a logical table. This is a variant type structure. No more than one of the attributes should be non-null for this structure to be valid.
Members
- CastColumnTypeOperation
-
- Type: CastColumnTypeOperation structure
A transform operation that casts a column to a different type.
- CreateColumnsOperation
-
- Type: CreateColumnsOperation structure
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
- FilterOperation
-
- Type: FilterOperation structure
An operation that filters rows based on some condition.
- ProjectOperation
-
- Type: ProjectOperation structure
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
- RenameColumnOperation
-
- Type: RenameColumnOperation structure
An operation that renames a column.
- TagColumnOperation
-
- Type: TagColumnOperation structure
An operation that tags a column with additional information.
TwitterParameters
Description
Twitter parameters.
Members
UnsupportedUserEditionException
Description
This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.
Members
UploadSettings
Description
Information on source file(s) format.
Members
User
Description
A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.
Members
- Active
-
- Type: boolean
Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password.
- Arn
-
- Type: string
The Amazon Resource name (ARN) for the user.
-
- Type: string
The user's email address.
- IdentityType
-
- Type: string
The type of identity authentication used by the user.
- PrincipalId
-
- Type: string
The principal ID of the user.
- Role
-
- Type: string
The Amazon QuickSight role for the user. The user role can be one of the following:.
-
READER: A user who has read-only access to dashboards. -
AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. -
ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. -
RESTRICTED_READER: This role isn't currently available for use. -
RESTRICTED_AUTHOR: This role isn't currently available for use.
- UserName
-
- Type: string
The user's user name.
