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 ongoing 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, identified by its Amazon Resource Name (ARN).
- 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 IAM policy assignment.
- DeleteTemplate ( array $params = [] )
Deletes a template.
- DeleteTemplateAlias ( array $params = [] )
Deletes the item that the specified template alias points to.
- 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 for 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 IAM policy assignment, as specified by the assignment name.
- DescribeIngestion ( array $params = [] )
Describes a SPICE ingestion.
- DescribeTemplate ( array $params = [] )
Describes a template's metadata.
- DescribeTemplateAlias ( array $params = [] )
Describes the template alias for 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 an AWS account.
- ListDataSets ( array $params = [] )
Lists all of the datasets belonging to the current AWS 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 IAM policy assignments in the current Amazon QuickSight account.
- ListIAMPolicyAssignmentsForUser ( array $params = [] )
Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and 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 current Amazon QuickSight account.
- ListTemplates ( array $params = [] )
Lists all the templates in the current Amazon 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 one or more tags (key-value pairs) to the specified QuickSight resource.
- UntagResource ( array $params = [] )
Removes a tag or tags from a resource.
- UpdateDashboard ( array $params = [] )
Updates a dashboard in an 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 IAM policy assignment.
- UpdateTemplate ( array $params = [] )
Updates a template from an existing Amazon QuickSight analysis or another template.
- UpdateTemplateAlias ( array $params = [] )
Updates the template alias of a template.
- UpdateTemplatePermissions ( array $params = [] )
Updates the resource permissions for 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 ongoing 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations 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.
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
The ID of the AWS account where you want to create the dashboard.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard, also added to the IAM policy.
- DashboardPublishOptions
-
- Type: DashboardPublishOptions structure
Options for publishing the dashboard when you create it:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .csv format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. The sheet controls pane is collapsed by default when set to true. This option isCOLLAPSEDby 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. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values. You can use the dashboard permissions structure described following 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 structure for granting permissions with principal and action information.
- SourceEntity
-
- Required: Yes
- Type: DashboardSourceEntity structure
The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (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 Amazon Resource Name (ARN) of the dashboard.
- CreationStatus
-
- Type: string
The status of the dashboard creation 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 has a value that isn't valid.
-
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.
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 that you want to create. This ID is unique per AWS Region for each AWS account.
- ImportMode
-
- Required: Yes
- Type: string
Indicates whether 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
The row-level security configuration for the data that 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 Amazon Resource Name (ARN) of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
- IngestionArn
-
- Type: string
The 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
- DataSourceId
-
- Required: Yes
- Type: string
An ID for the data source. This ID is unique per AWS Region for each AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters that 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
Secure Socket Layer (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
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 Amazon Resource Name (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 ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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, identified by its Amazon Resource Name (ARN). This policy will be assigned to specified groups or users of Amazon QuickSight. The users and groups need to be in the same namespace.
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 the assignment. Possible values are as follows:
-
ENABLED- Anything specified in this assignment is used when creating the data source. -
DISABLED- This assignment isn't used when creating the data source. -
DRAFT- This assignment is an unfinished draft and isn't used when creating the data source.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
The QuickSight users, groups, or both that you want to assign the policy to.
- Namespace
-
- Required: Yes
- Type: string
The namespace that contains the assignment.
- PolicyArn
-
- Type: string
The ARN for the IAM policy 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
The ID for the assignment.
- AssignmentName
-
- Type: string
The name of the assignment. This name must be unique within the AWS account.
- AssignmentStatus
-
- Type: string
The status of the assignment. Possible values are as follows:
-
ENABLED- Anything specified in this assignment is used when creating the data source. -
DISABLED- This assignment isn't used when creating the data source. -
DRAFT- This assignment is an unfinished draft and isn't used when creating the data source.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
The QuickSight users, groups, or both that the IAM policy is assigned to.
- PolicyArn
-
- Type: string
The ARN for the IAM policy 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in a state that indicates an action is happening 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? in the AWS Knowledge Center. Tags are 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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. You can use the resulting template to create a dashboard.
A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
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.
- SourceEntity
-
- Required: Yes
- Type: TemplateSourceEntity structure
The Amazon Resource Name (ARN) of the source entity from which this template is being created. Currently, you can create a template from an analysis or another template. If the ARN is for an analysis, 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 that you want to create. This template is unique per AWS Region in each AWS account.
- VersionDescription
-
- Type: string
A description of the current template version being created. This API operation creates the first version of the template. Every time
UpdateTemplateis called, a new version is created. Each version of the template maintains a description of the version in theVersionDescriptionfield.
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 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 ARN for the template, including the version information of the first version.
Errors
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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.
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 that you want to give to the template alias that you're creating. Don't start the alias name with the
$character. Alias names that start with$are reserved by QuickSight. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template that you creating an alias for.
- 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 about 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.
Parameter Syntax
$result = $client->deleteDashboard([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the dashboard that you're deleting.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- VersionNumber
-
- Type: long (int|float)
The version number of the dashboard. If the 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 has a value that isn't valid.
-
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.
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
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset that you want to create. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the data source that you deleted.
- DataSourceId
-
- Type: string
The ID of the data source. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 IAM policy assignment.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in a state that indicates an action is happening that must complete before a new update can be applied.
-
An internal failure occurred.
DeleteTemplate
$result = $client->deleteTemplate([/* ... */]); $promise = $client->deleteTemplateAsync([/* ... */]);
Deletes a template.
Parameter Syntax
$result = $client->deleteTemplate([
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template that you're deleting.
- TemplateId
-
- Required: Yes
- Type: string
An ID for the template you want to delete.
- VersionNumber
-
- Type: long (int|float)
Specifies the version of the template that you want to delete. If you don't provide a version number,
DeleteTemplatedeletes all versions of the template.
Result Syntax
[
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
]
Result Details
Members
Errors
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
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([/* ... */]);
Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
Parameter Syntax
$result = $client->deleteTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The name for the template alias. If you name a specific alias, you delete the version that the alias points to. You can specify the latest version of the template by providing the keyword
$LATESTin theAliasNameparameter. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the item to delete.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template that the specified alias is for.
Result Syntax
[
'AliasName' => '<string>',
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'TemplateId' => '<string>',
]
Result Details
Members
- AliasName
-
- Type: string
The name for the template alias.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the resource.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- TemplateId
-
- Type: string
An ID for the template associated with the deletion.
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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
The ID of the AWS account that contains the dashboard that you're describing.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- VersionNumber
-
- Type: long (int|float)
The version number for the dashboard. If a 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 has a value that isn't valid.
-
One or more resources can't be found.
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 for a dashboard.
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 Amazon Resource Name (ARN) of the dashboard.
- DashboardId
-
- Type: string
The ID for the dashboard.
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that contains the permissions for 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 Amazon Resource Name (ARN) of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset that you want to create. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 Amazon Resource Name (ARN) of the data source.
- DataSourceId
-
- Type: string
The ID of the data source. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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).
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 IAM policy assignment, as specified by the assignment name.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
Parameter Syntax
$result = $client->describeTemplate([
'AliasName' => '<string>',
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AliasName
-
- Type: string
The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword
$LATESTin theAliasNameparameter. The keyword$PUBLISHEDdoesn't apply to templates. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template that you're describing.
- TemplateId
-
- Required: Yes
- Type: string
The ID for the template.
- VersionNumber
-
- Type: long (int|float)
(Optional) The number for the version to describe. If a
VersionNumberparameter value isn't 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 for the object you want to describe.
Errors
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 alias for a template.
Parameter Syntax
$result = $client->describeTemplateAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword
$LATESTin theAliasNameparameter. The keyword$PUBLISHEDdoesn't apply to templates. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template alias that you're describing.
- TemplateId
-
- Required: Yes
- Type: string
The ID for 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 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.
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 Amazon Resource Name (ARN) of the template.
- TemplateId
-
- Type: string
The ID for the template.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.
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
The ID for the AWS account that contains the dashboard that you're embedding.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard, also added to the IAM policy.
- IdentityType
-
- Required: Yes
- Type: string
The authentication method that the user uses to sign in.
- ResetDisabled
-
- Type: boolean
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
- SessionLifetimeInMinutes
-
- Type: long (int|float)
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
- UndoRedoDisabled
-
- Type: boolean
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
- UserArn
-
- Type: string
The Amazon QuickSight user's Amazon Resource Name (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 nonfederated 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
An 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_codevalue that enables a single sign-on 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
DomainNotWhitelistedException:
The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
-
QuickSightUserNotFoundException:
The user with the provided name isn't 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 isn't supported. Supported identity types include
IAMandQUICKSIGHT. -
SessionLifetimeInMinutesInvalidException:
The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-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.
Parameter Syntax
$result = $client->listDashboardVersions([
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the dashboard that you're listing versions for.
- 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 has a value that isn't valid.
-
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 an AWS account.
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. This structure 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 the current AWS account in an AWS Region.
The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 IAM policy assignments in the current Amazon QuickSight account.
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 assignments.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains these IAM policy assignments.
- MaxResults
-
- Type: int
The maximum number of results to be returned per request.
- Namespace
-
- Required: Yes
- Type: string
The namespace for the assignments.
- 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.
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 ID of the AWS account that contains the assignments.
- 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
The 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in a state that indicates an action is happening 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
Parameter Syntax
$result = $client->listTemplateAliases([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template aliases that you're 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 the template's 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 current Amazon QuickSight account.
Parameter Syntax
$result = $client->listTemplateVersions([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'TemplateId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the templates that you're 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 has a value that isn't valid.
-
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 current Amazon QuickSight account.
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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 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 operation 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, and template.
Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:
-
You can't use tags to track AWS costs for QuickSight. This restriction is 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.
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 Amazon Resource Name (ARN) of the resource that 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 an AWS account.
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
The ID of the AWS account that contains the dashboard that you're updating.
- DashboardId
-
- Required: Yes
- Type: string
The ID for the dashboard.
- DashboardPublishOptions
-
- Type: DashboardPublishOptions structure
Options for publishing the dashboard when you create it:
-
AvailabilityStatusforAdHocFilteringOption- This status can be eitherENABLEDorDISABLED. When this is set toDISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLEDby default. -
AvailabilityStatusforExportToCSVOption- This status can be eitherENABLEDorDISABLED. The visual option to export data to .csv format isn't enabled when this is set toDISABLED. This option isENABLEDby default. -
VisibilityStateforSheetControlsOption- This visibility state can be eitherCOLLAPSEDorEXPANDED. The sheet controls pane is collapsed by default when set to true. This option isCOLLAPSEDby 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
SouceTemplateentity accepts the Amazon Resource Name (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 Amazon Resource Name (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 has a value that isn't valid.
-
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.
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
The ID of the AWS account that contains the dashboard whose permissions you're 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 Amazon Resource Name (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 has a value that isn't valid.
-
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.
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 has a value that isn't valid.
-
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.
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 that you want to update. This ID is unique per AWS Region for each AWS account.
- ImportMode
-
- Required: Yes
- Type: string
Indicates whether 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
The row-level security configuration for 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 Amazon Resource Name (ARN) of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
- IngestionArn
-
- Type: string
The 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 whose permissions you want to update. This ID is unique per AWS Region for each 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
- DataSetArn
-
- Type: string
The Amazon Resource Name (ARN) of the dataset.
- DataSetId
-
- Type: string
The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
- DataSourceId
-
- Required: Yes
- Type: string
The ID of the data source. This ID is unique per AWS Region for each AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters that QuickSight uses to connect to your underlying source.
- Name
-
- Required: Yes
- Type: string
A display name for the data source.
- SslProperties
-
- Type: SslProperties structure
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
- VpcConnectionProperties
-
- Type: VpcConnectionProperties structure
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 Amazon Resource Name (ARN) of the data source.
- DataSourceId
-
- Type: string
The ID of the data source. This ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 ID is unique per AWS Region for each 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request.
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. This name must be unique within an AWS account.
- AssignmentStatus
-
- Type: string
The status of the assignment. Possible values are as follows:
-
ENABLED- Anything specified in this assignment is used when creating the data source. -
DISABLED- This assignment isn't used when creating the data source. -
DRAFT- This assignment is an unfinished draft and isn't used when creating the data source.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the IAM policy assignment.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
The QuickSight users, groups, or both that you want to assign the policy to.
- Namespace
-
- Required: Yes
- Type: string
The namespace of the assignment.
- PolicyArn
-
- Type: string
The ARN for the IAM policy 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
The ID of the assignment.
- AssignmentName
-
- Type: string
The name of the assignment.
- AssignmentStatus
-
- Type: string
The status of the assignment. Possible values are as follows:
-
ENABLED- Anything specified in this assignment is used when creating the data source. -
DISABLED- This assignment isn't used when creating the data source. -
DRAFT- This assignment is an unfinished draft and isn't used when creating the data source.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
The QuickSight users, groups, or both that the IAM policy is assigned to.
- PolicyArn
-
- Type: string
The ARN for the IAM policy 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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
The resource specified already exists.
-
One or more resources can't be found.
-
Access is throttled.
-
A resource is already in a state that indicates an action is happening 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 Amazon QuickSight analysis or another template.
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
The ID of the AWS account that contains the template that you're 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 updated. You can currently update templates 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 that is being updated. Every time you call
UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in theVersionDescriptionfield.
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 ARN for the template, including the version information of the first version.
Errors
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
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.
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 of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword
$LATESTin theAliasNameparameter. The keyword$PUBLISHEDdoesn't apply to templates. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the template alias that you're 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 resource permissions for a template.
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
The ID of the AWS account that contains the template.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be granted on the template.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be revoked from the template.
- 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 Amazon Resource Name (ARN) of the template.
- TemplateId
-
- Type: string
The ID for the template.
Errors
-
Access is throttled.
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
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.
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 has a value that isn't valid.
-
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 item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure 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 AWS Identity and Access Management (IAM) policy assignment.
Members
AdHocFilteringOption
Description
Ad hoc (one-time) filtering option.
Members
AmazonElasticsearchParameters
Description
Amazon Elasticsearch Service parameters.
Members
AthenaParameters
Description
Amazon Athena parameters.
Members
AuroraParameters
Description
Amazon Aurora parameters.
Members
AuroraPostgreSqlParameters
Description
Amazon Aurora with PostgreSQL compatibility 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 a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon 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 Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Members
- GeoSpatialColumnGroup
-
- Type: GeoSpatialColumnGroup structure
Geospatial column group that denotes a hierarchy.
ColumnGroupColumnSchema
Description
A structure describing the name, data type, 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 schemas for column group columns.
- 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 structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Members
ConcurrentUpdatingException
Description
A resource is already in a state that indicates an action is happening 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 user name 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 Amazon Resource Name (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 that this dataset was created.
- DashboardId
-
- Type: string
Dashboard ID.
- LastPublishedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dataset was published.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dataset 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 (one-time) 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 that this dashboard was created.
- DashboardId
-
- Type: string
Dashboard ID.
- LastPublishedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dashboard was published.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dashboard was updated.
- Name
-
- Type: string
A display name for the dashboard.
- 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 that this dashboard version 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 that this dashboard version 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 Amazon 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 that this dataset was created.
- DataSetId
-
- Type: string
The ID of the dataset.
- ImportMode
-
- Type: string
Indicates whether you want to import the data into SPICE.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dataset 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
The row-level security configuration for 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 that this dataset was created.
- DataSetId
-
- Type: string
The ID of the dataset.
- ImportMode
-
- Type: string
Indicates whether you want to import the data into SPICE.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this dataset was updated.
- Name
-
- Type: string
A display name for the dataset.
- RowLevelPermissionDataSet
-
- Type: RowLevelPermissionDataSet structure
The row-level security configuration for 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 that this data source was created.
- DataSourceId
-
- Type: string
The ID of the data source. This ID is unique per AWS Region for each AWS account.
- DataSourceParameters
-
- Type: DataSourceParameters structure
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
- 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 that this data source was updated.
- Name
-
- Type: string
A display name for the data source.
- SslProperties
-
- Type: SslProperties structure
Secure Socket Layer (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 type 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 for the data source creation or update.
Members
DataSourceParameters
Description
The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
Members
- AmazonElasticsearchParameters
-
- Type: AmazonElasticsearchParameters structure
Amazon Elasticsearch Service parameters.
- AthenaParameters
-
- Type: AthenaParameters structure
Amazon Athena parameters.
- AuroraParameters
-
- Type: AuroraParameters structure
Amazon 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
Amazon RDS parameters.
- RedshiftParameters
-
- Type: RedshiftParameters structure
Amazon 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 isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.
Members
ErrorInfo
Description
Error information for the SPICE ingestion of a dataset.
Members
ExportToCSVOption
FilterOperation
Description
A transform operation that filters rows based on a 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
An IAM policy assignment.
Members
- AssignmentId
-
- Type: string
Assignment ID.
- AssignmentName
-
- Type: string
Assignment name.
- AssignmentStatus
-
- Type: string
Assignment status.
- AwsAccountId
-
- Type: string
The AWS account ID.
- Identities
-
- Type: Associative array of custom strings keys (String) to stringss
Identities.
- PolicyArn
-
- Type: string
The Amazon Resource Name (ARN) for the IAM policy.
IAMPolicyAssignmentSummary
Description
IAM policy assignment summary.
Members
IdentityTypeNotSupportedException
Description
The identity type specified isn't supported. Supported identity types include IAM and QUICKSIGHT.
Members
Ingestion
Description
Information about 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 that this ingestion started.
- ErrorInfo
-
- Type: ErrorInfo structure
Error information for this ingestion.
- IngestionId
-
- Type: string
Ingestion ID.
- IngestionSizeInBytes
-
- Type: long (int|float)
The size of the data ingested, in bytes.
- IngestionStatus
-
- Required: Yes
- Type: string
Ingestion status.
- IngestionTimeInSeconds
-
- Type: long (int|float)
The time that this ingestion took, measured in seconds.
- QueueInfo
-
- Type: QueueInfo structure
Information about a queued dataset SPICE ingestion.
- RequestSource
-
- Type: string
Event source for this ingestion.
- RequestType
-
- Type: string
Type of this ingestion.
- RowInfo
-
- Type: RowInfo structure
Information about rows for a data set SPICE ingestion.
InputColumn
Description
Metadata for 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 has a value that isn't valid.
Members
JiraParameters
Description
Jira parameters.
Members
JoinInstruction
Description
Join instruction.
Members
LimitExceededException
Description
A limit is exceeded.
Members
LogicalTable
Description
A logical table is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.
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 about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
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 that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
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 about a queued dataset SPICE ingestion.
Members
QuickSightUserNotFoundException
Description
The user with the provided name isn't 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
Amazon RDS parameters.
Members
RedshiftParameters
Description
Amazon Redshift parameters. The ClusterId field can be blank if Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.
Members
RelationalTable
Description
A physical table type for relational data sources.
Members
- DataSourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) for the data source.
- InputColumns
-
- Required: Yes
- Type: Array of InputColumn structures
The column schema of the table.
- Name
-
- Required: Yes
- Type: string
The name of the relational table.
- Schema
-
- Type: string
The schema name. This 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 Amazon Resource Name (ARN) of an Amazon 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 about rows for a data set SPICE ingestion.
Members
RowLevelPermissionDataSet
Description
The row-level security configuration for 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
The amazon Resource Name (ARN) for the data source.
- InputColumns
-
- Required: Yes
- Type: Array of InputColumn structures
A physical table type for as S3 data source.
- UploadSettings
-
- Type: UploadSettings structure
Information about the format for the S3 source file or files.
ServiceNowParameters
Description
ServiceNow parameters.
Members
SessionLifetimeInMinutesInvalidException
Description
The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.
Members
SheetControlsOption
SnowflakeParameters
Description
Snowflake parameters.
Members
SparkParameters
Description
Spark parameters.
Members
SqlServerParameters
Description
SQL Server parameters.
Members
SslProperties
Description
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
Members
StringParameter
Description
String parameter.
Members
Tag
Description
The key or 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 that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that 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 Amazon Resource Name (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 AWS Region for each 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 that this template was created.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that this template 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 ID is unique per AWS Region for each AWS account.
TemplateVersion
Description
A version of a template.
Members
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that this template version 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 Amazon Resource Name (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 that this template version was created.
- Description
-
- Type: string
The description 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. For this structure to be valid, only one of the attributes can be non-null.
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 about the format for a source file or files.
Members
- ContainsHeader
-
- Type: boolean
Whether the file has a header row, or the files each have a header row.
- Delimiter
-
- Type: string
The delimiter between values in the file.
- Format
-
- Type: string
File format.
- StartFromRow
-
- Type: int
A row number to start reading data from.
- TextQualifier
-
- Type: string
Text qualifier.
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
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory 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.
