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.
- CreateAccountCustomization ( array $params = [] )
Creates Amazon QuickSight customizations the current AWS Region.
- CreateAnalysis ( array $params = [] )
Creates an analysis in Amazon QuickSight.
- CreateDashboard ( array $params = [] )
Creates a dashboard from a template.
- CreateDataSet ( array $params = [] )
Creates a dataset.
- CreateDataSource ( array $params = [] )
Creates a data source.
- CreateFolder ( array $params = [] )
Creates an empty shared folder.
- CreateFolderMembership ( array $params = [] )
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
- 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.
- CreateNamespace ( array $params = [] )
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
- CreateTemplate ( array $params = [] )
Creates a template from an existing QuickSight analysis or template.
- CreateTemplateAlias ( array $params = [] )
Creates a template alias for a template.
- CreateTheme ( array $params = [] )
Creates a theme.
- CreateThemeAlias ( array $params = [] )
Creates a theme alias for a theme.
- DeleteAccountCustomization ( array $params = [] )
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
- DeleteAnalysis ( array $params = [] )
Deletes an analysis from Amazon QuickSight.
- DeleteDashboard ( array $params = [] )
Deletes a dashboard.
- DeleteDataSet ( array $params = [] )
Deletes a dataset.
- DeleteDataSource ( array $params = [] )
Deletes the data source permanently.
- DeleteFolder ( array $params = [] )
Deletes an empty folder.
- DeleteFolderMembership ( array $params = [] )
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
- 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.
- DeleteNamespace ( array $params = [] )
Deletes a namespace and the users and groups that are associated with the namespace.
- DeleteTemplate ( array $params = [] )
Deletes a template.
- DeleteTemplateAlias ( array $params = [] )
Deletes the item that the specified template alias points to.
- DeleteTheme ( array $params = [] )
Deletes a theme.
- DeleteThemeAlias ( array $params = [] )
Deletes the version of the theme that the specified theme 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.
- DescribeAccountCustomization ( array $params = [] )
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region.
- DescribeAccountSettings ( array $params = [] )
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
- DescribeAnalysis ( array $params = [] )
Provides a summary of the metadata for an analysis.
- DescribeAnalysisPermissions ( array $params = [] )
Provides the read and write permissions for an analysis.
- 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.
- DescribeFolder ( array $params = [] )
Describes a folder.
- DescribeFolderPermissions ( array $params = [] )
Describes permissions for a folder.
- DescribeFolderResolvedPermissions ( array $params = [] )
Describes the folder resolved permissions.
- 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.
- DescribeNamespace ( array $params = [] )
Describes the current namespace.
- 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.
- DescribeTheme ( array $params = [] )
Describes a theme.
- DescribeThemeAlias ( array $params = [] )
Describes the alias for a theme.
- DescribeThemePermissions ( array $params = [] )
Describes the read and write permissions for a theme.
- DescribeUser ( array $params = [] )
Returns information about a user, given the user name.
- GetDashboardEmbedUrl ( array $params = [] )
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code.
- GetSessionEmbedUrl ( array $params = [] )
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code.
- ListAnalyses ( array $params = [] )
Lists Amazon QuickSight analyses that exist in the specified AWS account.
- 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.
- ListFolderMembers ( array $params = [] )
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
- ListFolders ( array $params = [] )
Lists all folders in an 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.
- ListNamespaces ( array $params = [] )
Lists the namespaces for the specified AWS account.
- 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.
- ListThemeAliases ( array $params = [] )
Lists all the aliases of a theme.
- ListThemeVersions ( array $params = [] )
Lists all the versions of the themes in the current AWS account.
- ListThemes ( array $params = [] )
Lists all the themes in the current AWS 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.
- RestoreAnalysis ( array $params = [] )
Restores an analysis.
- SearchAnalyses ( array $params = [] )
Searches for analyses that belong to the user specified in the filter.
- SearchDashboards ( array $params = [] )
Searches for dashboards that belong to a user.
- SearchFolders ( array $params = [] )
Searches the subfolders in a folder.
- 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.
- UpdateAccountCustomization ( array $params = [] )
Updates Amazon QuickSight customizations the current AWS Region.
- UpdateAccountSettings ( array $params = [] )
Updates the Amazon QuickSight settings in your AWS account.
- UpdateAnalysis ( array $params = [] )
Updates an analysis in Amazon QuickSight
- UpdateAnalysisPermissions ( array $params = [] )
Updates the read and write permissions for an analysis.
- 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.
- UpdateFolder ( array $params = [] )
Updates the name of a folder.
- UpdateFolderPermissions ( array $params = [] )
Updates permissions of a folder.
- 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.
- UpdateTheme ( array $params = [] )
Updates a theme.
- UpdateThemeAlias ( array $params = [] )
Updates an alias of a theme.
- UpdateThemePermissions ( array $params = [] )
Updates the resource permissions for a theme.
- 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.
CreateAccountCustomization
$result = $client->createAccountCustomization([/* ... */]); $promise = $client->createAccountCustomizationAsync([/* ... */]);
Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User Guide.
You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
Parameter Syntax
$result = $client->createAccountCustomization([
'AccountCustomization' => [ // REQUIRED
'DefaultTheme' => '<string>',
],
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>',
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AccountCustomization
-
- Required: Yes
- Type: AccountCustomization structure
The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a QuickSight namespace.
For example, you can add a default theme by setting
AccountCustomizationto the midnight theme:"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying"AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }. - AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that you want to customize QuickSight for.
- Namespace
-
- Type: string
The QuickSight namespace that you want to add customizations to.
- Tags
-
- Type: Array of Tag structures
A list of the tags that you want to attach to this resource.
Result Syntax
[
'AccountCustomization' => [
'DefaultTheme' => '<string>',
],
'Arn' => '<string>',
'AwsAccountId' => '<string>',
'Namespace' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AccountCustomization
-
- Type: AccountCustomization structure
The QuickSight customizations you're adding in the current AWS Region.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
- AwsAccountId
-
- Type: string
The ID for the AWS account that you want to customize QuickSight for.
- Namespace
-
- Type: string
The namespace associated with the customization you're creating.
- 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.
-
An internal failure occurred.
-
This resource is currently unavailable.
CreateAnalysis
$result = $client->createAnalysis([/* ... */]); $promise = $client->createAnalysisAsync([/* ... */]);
Creates an analysis in Amazon QuickSight.
Parameter Syntax
$result = $client->createAnalysis([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'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
],
// ...
],
'ThemeArn' => '<string>',
]);
Parameter Details
Members
- AnalysisId
-
- Required: Yes
- Type: string
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account where you are creating an analysis.
- Name
-
- Required: Yes
- Type: string
A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
- Parameters
-
- Type: Parameters structure
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that describes the principals and the resource-level permissions on an analysis. You can use the
Permissionsstructure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).To specify no permissions, omit
Permissions. - SourceEntity
-
- Required: Yes
- Type: AnalysisSourceEntity structure
A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
- Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
- ThemeArn
-
- Type: string
The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
Result Syntax
[
'AnalysisId' => '<string>',
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
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.
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. 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
],
// ...
],
'ThemeArn' => '<string>',
'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. This option isCOLLAPSEDby default.
- Name
-
- Required: Yes
- Type: string
The display name of the dashboard.
- Parameters
-
- Type: Parameters structure
The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might 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 by providing a list of IAM action information for each principal ARN.
To specify no permissions, omit the permissions list.
- SourceEntity
-
- Required: Yes
- Type: DashboardSourceEntity structure
The entity that you are using as a source when you create the dashboard. In
SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use aSourceTemplateentity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. ForSourceTemplate, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.Use the
DataSetReferencesentity withinSourceTemplateto list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. - Tags
-
- Type: Array of Tag structures
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
- ThemeArn
-
- Type: string
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create 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|DELETED',
'DashboardId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The 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
],
],
// ...
],
'ColumnLevelPermissionRules' => [
[
'ColumnNames' => ['<string>', ...],
'Principals' => ['<string>', ...],
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'FieldFolders' => [
'<FieldFolderPath>' => [
'columns' => ['<string>', ...],
'description' => '<string>',
],
// ...
],
'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
[
'ColumnDescription' => [
'Text' => '<string>',
],
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [ // REQUIRED
'JoinInstruction' => [
'LeftJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'LeftOperand' => '<string>', // REQUIRED
'OnClause' => '<string>', // REQUIRED
'RightJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'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' => [
'Catalog' => '<string>',
'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
'FormatVersion' => 'VERSION_1|VERSION_2',
'Namespace' => '<string>',
'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.
- ColumnLevelPermissionRules
-
- Type: Array of ColumnLevelPermissionRule structures
A set of one or more definitions of a
ColumnLevelPermissionRule. - 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.
- FieldFolders
-
- Type: Associative array of custom strings keys (FieldFolderPath) to FieldFolder structures
The folder that contains fields and nested subfolders for your dataset.
- 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' => [
'CopySourceArn' => '<string>',
'CredentialPair' => [
'AlternateDataSourceParameters' => [
[
'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
],
'OracleParameters' => [
'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
],
],
// ...
],
'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
],
'OracleParameters' => [
'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|ORACLE|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER|TIMESTREAM', // 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, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. UseListDataSourcesto return a list of all data sources.AMAZON_ELASTICSEARCHis for Amazon managed Elasticsearch Service. - 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|DELETED',
'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.
CreateFolder
$result = $client->createFolder([/* ... */]); $promise = $client->createFolderAsync([/* ... */]);
Creates an empty shared folder.
Parameter Syntax
$result = $client->createFolder([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
'FolderType' => 'SHARED',
'Name' => '<string>',
'ParentFolderArn' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- FolderId
-
- Required: Yes
- Type: string
The folder ID.
- FolderType
-
- Type: string
The type of folder. By default,
folderTypeisSHARED. - Name
-
- Type: string
The name of the folder.
- ParentFolderArn
-
- Type: string
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArncan be null. An emptyparentFolderArncreates a root-level folder. - Permissions
-
- Type: Array of ResourcePermission structures
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit
Permissions. - Tags
-
- Type: Array of Tag structures
Tags for the folder.
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the newly created folder.
- FolderId
-
- Type: string
The folder ID for the newly created folder.
- RequestId
-
- Type: string
The request ID for the newly created folder.
- Status
-
- Type: int
The status of the newly created folder. If succeeded, the status is
SC_OK (200).
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.
-
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.
-
A limit is exceeded.
-
An internal failure occurred.
CreateFolderMembership
$result = $client->createFolderMembership([/* ... */]); $promise = $client->createFolderMembershipAsync([/* ... */]);
Adds an asset, such as a dashboard, analysis, or dataset into a folder.
Parameter Syntax
$result = $client->createFolderMembership([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
'MemberId' => '<string>', // REQUIRED
'MemberType' => 'DASHBOARD|ANALYSIS|DATASET', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- FolderId
-
- Required: Yes
- Type: string
The folder ID.
- MemberId
-
- Required: Yes
- Type: string
The ID of the asset (the dashboard, analysis, or dataset).
- MemberType
-
- Required: Yes
- Type: string
The type of the member, including
DASHBOARD,ANALYSIS, andDATASET.
Result Syntax
[
'FolderMember' => [
'MemberId' => '<string>',
'MemberType' => 'DASHBOARD|ANALYSIS|DATASET',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- FolderMember
-
- Type: FolderMember structure
Information about the member in the folder.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status of the folder membership. If succeeded, the status is
SC_OK (200).
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.
-
The resource specified already exists.
-
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.
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 assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
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, also called a rule. 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 operation 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.
CreateNamespace
$result = $client->createNamespace([/* ... */]); $promise = $client->createNamespaceAsync([/* ... */]);
(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.
A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support.
Parameter Syntax
$result = $client->createNamespace([
'AwsAccountId' => '<string>', // REQUIRED
'IdentityStore' => 'QUICKSIGHT', // REQUIRED
'Namespace' => '<string>', // REQUIRED
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that you want to create the QuickSight namespace in.
- IdentityStore
-
- Required: Yes
- Type: string
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT. - Namespace
-
- Required: Yes
- Type: string
The name that you want to use to describe the new namespace.
- Tags
-
- Type: Array of Tag structures
The tags that you want to associate with the namespace that you're creating.
Result Syntax
[
'Arn' => '<string>',
'CapacityRegion' => '<string>',
'CreationStatus' => 'CREATED|CREATING|DELETING|RETRYABLE_FAILURE|NON_RETRYABLE_FAILURE',
'IdentityStore' => 'QUICKSIGHT',
'Name' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the QuickSight namespace you created.
- CapacityRegion
-
- Type: string
The AWS Region that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
- CreationStatus
-
- Type: string
The status of the creation of the namespace. This is an asynchronous process. A status of
CREATEDmeans that your namespace is ready to use. If an error occurs, it indicates if the process isretryableornon-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks. - IdentityStore
-
- Type: string
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT. - Name
-
- Type: string
The name of the new namespace that you created.
- 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.
-
A limit is exceeded.
-
The resource specified already exists.
-
One or more preconditions aren't met.
-
Updating or deleting a resource can cause an inconsistent state.
-
An internal failure occurred.
-
This resource is currently unavailable.
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 entity that you are using as a source when you create the template. In
SourceEntity, you specify the type of object you're using as source:SourceTemplatefor a template orSourceAnalysisfor an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate, specify the ARN of the source template. ForSourceAnalysis, specify the ARN of the source analysis. TheSourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.Use the
DataSetReferencesentity withinSourceTemplateorSourceAnalysisto list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. - 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|DELETED',
'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.
-
Updating or deleting a resource can cause an inconsistent state.
-
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.
-
Updating or deleting a resource can cause an inconsistent state.
-
An internal failure occurred.
CreateTheme
$result = $client->createTheme([/* ... */]); $promise = $client->createThemeAsync([/* ... */]);
Creates a theme.
A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
Parameter Syntax
$result = $client->createTheme([
'AwsAccountId' => '<string>', // REQUIRED
'BaseThemeId' => '<string>', // REQUIRED
'Configuration' => [ // REQUIRED
'DataColorPalette' => [
'Colors' => ['<string>', ...],
'EmptyFillColor' => '<string>',
'MinMaxGradient' => ['<string>', ...],
],
'Sheet' => [
'Tile' => [
'Border' => [
'Show' => true || false,
],
],
'TileLayout' => [
'Gutter' => [
'Show' => true || false,
],
'Margin' => [
'Show' => true || false,
],
],
],
'UIColorPalette' => [
'Accent' => '<string>',
'AccentForeground' => '<string>',
'Danger' => '<string>',
'DangerForeground' => '<string>',
'Dimension' => '<string>',
'DimensionForeground' => '<string>',
'Measure' => '<string>',
'MeasureForeground' => '<string>',
'PrimaryBackground' => '<string>',
'PrimaryForeground' => '<string>',
'SecondaryBackground' => '<string>',
'SecondaryForeground' => '<string>',
'Success' => '<string>',
'SuccessForeground' => '<string>',
'Warning' => '<string>',
'WarningForeground' => '<string>',
],
],
'Name' => '<string>', // REQUIRED
'Permissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'Tags' => [
[
'Key' => '<string>', // REQUIRED
'Value' => '<string>', // REQUIRED
],
// ...
],
'ThemeId' => '<string>', // REQUIRED
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account where you want to store the new theme.
- BaseThemeId
-
- Required: Yes
- Type: string
The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use
ListThemesor choose Themes from within a QuickSight analysis. - Configuration
-
- Required: Yes
- Type: ThemeConfiguration structure
The theme configuration, which contains the theme display properties.
- Name
-
- Required: Yes
- Type: string
A display name for the theme.
- Permissions
-
- Type: Array of ResourcePermission structures
A valid grouping of resource permissions to apply to the new theme.
- Tags
-
- Type: Array of Tag structures
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
- ThemeId
-
- Required: Yes
- Type: string
An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.
- VersionDescription
-
- Type: string
A description of the first version of the theme that you're creating. Every time
UpdateThemeis called, a new version is created. Each version of the theme has 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|DELETED',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeId' => '<string>',
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the theme.
- CreationStatus
-
- Type: string
The theme creation status.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeId
-
- Type: string
The ID of the theme.
- VersionArn
-
- Type: string
The Amazon Resource Name (ARN) for the new theme.
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.
-
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.
-
A limit is exceeded.
-
An internal failure occurred.
CreateThemeAlias
$result = $client->createThemeAlias([/* ... */]); $promise = $client->createThemeAliasAsync([/* ... */]);
Creates a theme alias for a theme.
Parameter Syntax
$result = $client->createThemeAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
'ThemeVersionNumber' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The name that you want to give to the theme alias that you are creating. The alias name can't begin with a
$. Alias names that start with$are reserved by Amazon QuickSight. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme for the new theme alias.
- ThemeId
-
- Required: Yes
- Type: string
An ID for the theme alias.
- ThemeVersionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the theme.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'ThemeVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeAlias
-
- Type: ThemeAlias structure
Information about the theme alias.
Errors
-
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.
DeleteAccountCustomization
$result = $client->deleteAccountCustomization([/* ... */]); $promise = $client->deleteAccountCustomizationAsync([/* ... */]);
Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS account and QuickSight namespace.
Parameter Syntax
$result = $client->deleteAccountCustomization([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>',
]);
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.
-
This resource is currently unavailable.
DeleteAnalysis
$result = $client->deleteAnalysis([/* ... */]); $promise = $client->deleteAnalysisAsync([/* ... */]);
Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.
At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.
An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
Parameter Syntax
$result = $client->deleteAnalysis([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'ForceDeleteWithoutRecovery' => true || false,
'RecoveryWindowInDays' => <integer>,
]);
Parameter Details
Members
- AnalysisId
-
- Required: Yes
- Type: string
The ID of the analysis that you're deleting.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account where you want to delete an analysis.
- ForceDeleteWithoutRecovery
-
- Type: boolean
This option defaults to the value
NoForceDeleteWithoutRecovery. To immediately delete the analysis, add theForceDeleteWithoutRecoveryoption. You can't restore an analysis after it's deleted. - RecoveryWindowInDays
-
- Type: long (int|float)
A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the
ForceDeleteWithoutRecoveryoption in the same API call. The default value is 30.
Result Syntax
[
'AnalysisId' => '<string>',
'Arn' => '<string>',
'DeletionTime' => <DateTime>,
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AnalysisId
-
- Type: string
The ID of the deleted analysis.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the deleted analysis.
- DeletionTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the analysis is scheduled to be deleted.
- 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.
-
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.
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 operation 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.
DeleteFolder
$result = $client->deleteFolder([/* ... */]); $promise = $client->deleteFolderAsync([/* ... */]);
Deletes an empty folder.
Parameter Syntax
$result = $client->deleteFolder([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
Errors
-
InvalidParameterValueException:
One or more parameters has a value that isn't valid.
-
One or more preconditions aren't met.
-
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.
-
One or more resources can't be found.
-
Updating or deleting a resource can cause an inconsistent state.
-
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.
DeleteFolderMembership
$result = $client->deleteFolderMembership([/* ... */]); $promise = $client->deleteFolderMembershipAsync([/* ... */]);
Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
Parameter Syntax
$result = $client->deleteFolderMembership([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
'MemberId' => '<string>', // REQUIRED
'MemberType' => 'DASHBOARD|ANALYSIS|DATASET', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS Account ID.
- FolderId
-
- Required: Yes
- Type: string
The Folder ID.
- MemberId
-
- Required: Yes
- Type: string
The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
- MemberType
-
- Required: Yes
- Type: string
The type of the member, including
DASHBOARD,ANALYSIS, andDATASET
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.
-
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.
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 operation is happening that must complete before a new update can be applied.
-
An internal failure occurred.
DeleteNamespace
$result = $client->deleteNamespace([/* ... */]); $promise = $client->deleteNamespaceAsync([/* ... */]);
Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
Parameter Syntax
$result = $client->deleteNamespace([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<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.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
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. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or 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 template you want to delete.
- 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.
-
Updating or deleting a resource can cause an inconsistent state.
-
An internal failure occurred.
DeleteTheme
$result = $client->deleteTheme([/* ... */]); $promise = $client->deleteThemeAsync([/* ... */]);
Deletes a theme.
Parameter Syntax
$result = $client->deleteTheme([
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme that you're deleting.
- ThemeId
-
- Required: Yes
- Type: string
An ID for the theme that you want to delete.
- VersionNumber
-
- Type: long (int|float)
The version of the theme that you want to delete.
Note: If you don't provide a version number, you're using this call to
DeleteThemeto delete all versions of the theme.
Result Syntax
[
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeId' => '<string>',
]
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.
-
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.
DeleteThemeAlias
$result = $client->deleteThemeAlias([/* ... */]); $promise = $client->deleteThemeAliasAsync([/* ... */]);
Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
Parameter Syntax
$result = $client->deleteThemeAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AliasName' => '<string>',
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeId' => '<string>',
]
Result Details
Members
- AliasName
-
- Type: string
The name for the theme alias.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeId
-
- Type: string
An ID for the theme associated with the deletion.
Errors
-
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.
-
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.
-
One or more preconditions aren't met.
-
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.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
DescribeAccountCustomization
$result = $client->describeAccountCustomization([/* ... */]); $promise = $client->describeAccountCustomizationAsync([/* ... */]);
Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included.
To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved.
-
AWS Account- The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region. -
AWS Region- In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace.To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:
-
Use command line options.
-
Use named profiles.
-
Run
aws configureto change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see Configuring the AWS CLI.
-
-
Namespace- A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region. -
Applied customizations- Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run theCreateAccountCustomizationcommand in each AWS Region where you want to apply the same customizations.
Parameter Syntax
$result = $client->describeAccountCustomization([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>',
'Resolved' => true || false,
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that you want to describe QuickSight customizations for.
- Namespace
-
- Type: string
The QuickSight namespace that you want to describe QuickSight customizations for.
- Resolved
-
- Type: boolean
The
Resolvedflag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it tono-resolved, to reveal customizations that are configured at different levels.
Result Syntax
[
'AccountCustomization' => [
'DefaultTheme' => '<string>',
],
'Arn' => '<string>',
'AwsAccountId' => '<string>',
'Namespace' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AccountCustomization
-
- Type: AccountCustomization structure
The QuickSight customizations that exist in the current AWS Region.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
- AwsAccountId
-
- Type: string
The ID for the AWS account that you're describing.
- Namespace
-
- Type: string
The QuickSight namespace that you're describing.
- 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.
DescribeAccountSettings
$result = $client->describeAccountSettings([/* ... */]); $promise = $client->describeAccountSettingsAsync([/* ... */]);
Describes the settings that were used when your QuickSight subscription was first created in this AWS account.
Parameter Syntax
$result = $client->describeAccountSettings([
'AwsAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AccountSettings' => [
'AccountName' => '<string>',
'DefaultNamespace' => '<string>',
'Edition' => 'STANDARD|ENTERPRISE',
'NotificationEmail' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AccountSettings
-
- Type: AccountSettings structure
The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
- 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.
DescribeAnalysis
$result = $client->describeAnalysis([/* ... */]); $promise = $client->describeAnalysisAsync([/* ... */]);
Provides a summary of the metadata for an analysis.
Parameter Syntax
$result = $client->describeAnalysis([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Analysis' => [
'AnalysisId' => '<string>',
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'DataSetArns' => ['<string>', ...],
'Errors' => [
[
'Message' => '<string>',
'Type' => 'ACCESS_DENIED|SOURCE_NOT_FOUND|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',
],
// ...
],
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Sheets' => [
[
'Name' => '<string>',
'SheetId' => '<string>',
],
// ...
],
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'ThemeArn' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Analysis
-
- Type: Analysis structure
A metadata structure that contains summary information for the analysis that you're describing.
- 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.
-
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.
DescribeAnalysisPermissions
$result = $client->describeAnalysisPermissions([/* ... */]); $promise = $client->describeAnalysisPermissionsAsync([/* ... */]);
Provides the read and write permissions for an analysis.
Parameter Syntax
$result = $client->describeAnalysisPermissions([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AnalysisId
-
- Required: Yes
- Type: string
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.
Result Syntax
[
'AnalysisArn' => '<string>',
'AnalysisId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AnalysisArn
-
- Type: string
The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
- AnalysisId
-
- Type: string
The ID of the analysis whose permissions you're describing.
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that describes the principals and the resource-level permissions on an analysis.
- 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.
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>,
'DataSetArns' => ['<string>', ...],
'Description' => '<string>',
'Errors' => [
[
'Message' => '<string>',
'Type' => 'ACCESS_DENIED|SOURCE_NOT_FOUND|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',
],
// ...
],
'Sheets' => [
[
'Name' => '<string>',
'SheetId' => '<string>',
],
// ...
],
'SourceEntityArn' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'ThemeArn' => '<string>',
'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>',
],
],
// ...
],
'ColumnLevelPermissionRules' => [
[
'ColumnNames' => ['<string>', ...],
'Principals' => ['<string>', ...],
],
// ...
],
'ConsumedSpiceCapacityInBytes' => <integer>,
'CreatedTime' => <DateTime>,
'DataSetId' => '<string>',
'FieldFolders' => [
'<FieldFolderPath>' => [
'columns' => ['<string>', ...],
'description' => '<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' => [
[
'ColumnDescription' => [
'Text' => '<string>',
],
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [
'JoinInstruction' => [
'LeftJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'LeftOperand' => '<string>',
'OnClause' => '<string>',
'RightJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'RightOperand' => '<string>',
'Type' => 'INNER|OUTER|LEFT|RIGHT',
],
'PhysicalTableId' => '<string>',
],
],
// ...
],
'Name' => '<string>',
'OutputColumns' => [
[
'Description' => '<string>',
'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' => [
'Catalog' => '<string>',
'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>',
'FormatVersion' => 'VERSION_1|VERSION_2',
'Namespace' => '<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' => [
'AlternateDataSourceParameters' => [
[
'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>,
],
'OracleParameters' => [
'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>',
],
],
// ...
],
'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>,
],
'OracleParameters' => [
'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' => 'ACCESS_DENIED|COPY_SOURCE_NOT_FOUND|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|DELETED',
'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|ORACLE|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER|TIMESTREAM',
'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.
DescribeFolder
$result = $client->describeFolder([/* ... */]); $promise = $client->describeFolderAsync([/* ... */]);
Describes a folder.
Parameter Syntax
$result = $client->describeFolder([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Folder' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'FolderId' => '<string>',
'FolderPath' => ['<string>', ...],
'FolderType' => 'SHARED',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Folder
-
- Type: Folder structure
Information about the folder.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK (200).
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.
-
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.
DescribeFolderPermissions
$result = $client->describeFolderPermissions([/* ... */]); $promise = $client->describeFolderPermissionsAsync([/* ... */]);
Describes permissions for a folder.
Parameter Syntax
$result = $client->describeFolderPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the folder.
- FolderId
-
- Type: string
The folder ID.
- Permissions
-
- Type: Array of ResourcePermission structures
Information about the permissions on the folder.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK.
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.
-
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.
DescribeFolderResolvedPermissions
$result = $client->describeFolderResolvedPermissions([/* ... */]); $promise = $client->describeFolderResolvedPermissionsAsync([/* ... */]);
Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
Parameter Syntax
$result = $client->describeFolderResolvedPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN).
- FolderId
-
- Type: string
The folder ID.
- Permissions
-
- Type: Array of ResourcePermission structures
Information about the permissions on the dashboard.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK
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.
-
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.
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.
DescribeNamespace
$result = $client->describeNamespace([/* ... */]); $promise = $client->describeNamespaceAsync([/* ... */]);
Describes the current namespace.
Parameter Syntax
$result = $client->describeNamespace([
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Namespace' => [
'Arn' => '<string>',
'CapacityRegion' => '<string>',
'CreationStatus' => 'CREATED|CREATING|DELETING|RETRYABLE_FAILURE|NON_RETRYABLE_FAILURE',
'IdentityStore' => 'QUICKSIGHT',
'Name' => '<string>',
'NamespaceError' => [
'Message' => '<string>',
'Type' => 'PERMISSION_DENIED|INTERNAL_SERVICE_ERROR',
],
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Namespace
-
- Type: NamespaceInfoV2 structure
The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store.
DescribeNamespacealso works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process. - 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.
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
[
'RequestId' => '<string>',
'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' => 'SOURCE_NOT_FOUND|DATA_SET_NOT_FOUND|INTERNAL_FAILURE|ACCESS_DENIED',
],
// ...
],
'Sheets' => [
[
'Name' => '<string>',
'SheetId' => '<string>',
],
// ...
],
'SourceEntityArn' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'ThemeArn' => '<string>',
'VersionNumber' => <integer>,
],
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- 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.
DescribeTheme
$result = $client->describeTheme([/* ... */]); $promise = $client->describeThemeAsync([/* ... */]);
Describes a theme.
Parameter Syntax
$result = $client->describeTheme([
'AliasName' => '<string>',
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
'VersionNumber' => <integer>,
]);
Parameter Details
Members
- AliasName
-
- Type: string
The alias of the theme 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 theme by providing the keyword
$LATESTin theAliasNameparameter. The keyword$PUBLISHEDdoesn't apply to themes. - AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme that you're describing.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
- VersionNumber
-
- Type: long (int|float)
The version number for the version to describe. If a
VersionNumberparameter value isn't provided, the latest version of the theme is described.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'Theme' => [
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'ThemeId' => '<string>',
'Type' => 'QUICKSIGHT|CUSTOM|ALL',
'Version' => [
'Arn' => '<string>',
'BaseThemeId' => '<string>',
'Configuration' => [
'DataColorPalette' => [
'Colors' => ['<string>', ...],
'EmptyFillColor' => '<string>',
'MinMaxGradient' => ['<string>', ...],
],
'Sheet' => [
'Tile' => [
'Border' => [
'Show' => true || false,
],
],
'TileLayout' => [
'Gutter' => [
'Show' => true || false,
],
'Margin' => [
'Show' => true || false,
],
],
],
'UIColorPalette' => [
'Accent' => '<string>',
'AccentForeground' => '<string>',
'Danger' => '<string>',
'DangerForeground' => '<string>',
'Dimension' => '<string>',
'DimensionForeground' => '<string>',
'Measure' => '<string>',
'MeasureForeground' => '<string>',
'PrimaryBackground' => '<string>',
'PrimaryForeground' => '<string>',
'SecondaryBackground' => '<string>',
'SecondaryForeground' => '<string>',
'Success' => '<string>',
'SuccessForeground' => '<string>',
'Warning' => '<string>',
'WarningForeground' => '<string>',
],
],
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Errors' => [
[
'Message' => '<string>',
'Type' => 'INTERNAL_FAILURE',
],
// ...
],
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'VersionNumber' => <integer>,
],
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- Theme
-
- Type: Theme structure
The information about the theme that you are describing.
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.
-
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.
DescribeThemeAlias
$result = $client->describeThemeAlias([/* ... */]); $promise = $client->describeThemeAliasAsync([/* ... */]);
Describes the alias for a theme.
Parameter Syntax
$result = $client->describeThemeAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'ThemeVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeAlias
-
- Type: ThemeAlias structure
Information about the theme alias.
Errors
-
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.
-
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.
DescribeThemePermissions
$result = $client->describeThemePermissions([/* ... */]); $promise = $client->describeThemePermissionsAsync([/* ... */]);
Describes the read and write permissions for a theme.
Parameter Syntax
$result = $client->describeThemePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeArn' => '<string>',
'ThemeId' => '<string>',
]
Result Details
Members
- Permissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions set on the theme.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeArn
-
- Type: string
The Amazon Resource Name (ARN) of the theme.
- ThemeId
-
- Type: string
The ID for the theme.
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.
-
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>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>',
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginFederationProviderUrl' => '<string>',
'ExternalLoginId' => '<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.
-
One or more preconditions aren't met.
-
An internal failure occurred.
-
This resource is currently unavailable.
GetDashboardEmbedUrl
$result = $client->getDashboardEmbedUrl([/* ... */]); $promise = $client->getDashboardEmbedUrlAsync([/* ... */]);
Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.
Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:
-
They must be used together.
-
They can be used one time only.
-
They are valid for 5 minutes after you run this command.
-
The resulting user session is valid for 10 hours.
For more information, see Embedded Analytics in the Amazon QuickSight User Guide.
Parameter Syntax
$result = $client->getDashboardEmbedUrl([
'AdditionalDashboardIds' => ['<string>', ...],
'AwsAccountId' => '<string>', // REQUIRED
'DashboardId' => '<string>', // REQUIRED
'IdentityType' => 'IAM|QUICKSIGHT|ANONYMOUS', // REQUIRED
'Namespace' => '<string>',
'ResetDisabled' => true || false,
'SessionLifetimeInMinutes' => <integer>,
'StatePersistenceEnabled' => true || false,
'UndoRedoDisabled' => true || false,
'UserArn' => '<string>',
]);
Parameter Details
Members
- AdditionalDashboardIds
-
- Type: Array of strings
A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The
IdentityTypeparameter must be set toANONYMOUSfor this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards. - 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 AWS Identity and Access Management (IAM) policy.
- IdentityType
-
- Required: Yes
- Type: string
The authentication method that the user uses to sign in.
- Namespace
-
- Type: string
The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to "
default". - 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.
- StatePersistenceEnabled
-
- Type: boolean
Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to
TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default isFALSE. - 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.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
Result Syntax
[
'EmbedUrl' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- EmbedUrl
-
- Type: string
A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an
auth_codevalue that enables one (and only one) sign-on to a user session that is valid for 10 hours. - 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.
-
UnsupportedPricingPlanException:
This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your AWS account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the Manage QuickSight page.
After capacity pricing is added, you can use the GetDashboardEmbedUrl API operation with the
--identity-type ANONYMOUSoption. -
An internal failure occurred.
GetSessionEmbedUrl
$result = $client->getSessionEmbedUrl([/* ... */]); $promise = $client->getSessionEmbedUrlAsync([/* ... */]);
Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide:
Parameter Syntax
$result = $client->getSessionEmbedUrl([
'AwsAccountId' => '<string>', // REQUIRED
'EntryPoint' => '<string>',
'SessionLifetimeInMinutes' => <integer>,
'UserArn' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account associated with your QuickSight subscription.
- EntryPoint
-
- Type: string
The URL you use to access the embedded session. The entry point URL is constrained to the following paths:
-
/start -
/start/analyses -
/start/dashboards -
/start/favorites -
/dashboards/DashboardId- whereDashboardIdis the actual ID key from the QuickSight console URL of the dashboard -
/analyses/AnalysisId- whereAnalysisIdis the actual ID key from the QuickSight console URL of the analysis
- SessionLifetimeInMinutes
-
- Type: long (int|float)
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
- UserArn
-
- Type: string
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with
QUICKSIGHTidentity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:-
Active Directory (AD) users or group members
-
Invited nonfederated users
-
AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation
Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
Result Syntax
[
'EmbedUrl' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- EmbedUrl
-
- Type: string
A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an
auth_codevalue that enables one (and only one) sign-on to a user session that is valid for 10 hours. - 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.
-
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. -
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.
ListAnalyses
$result = $client->listAnalyses([/* ... */]); $promise = $client->listAnalysesAsync([/* ... */]);
Lists Amazon QuickSight analyses that exist in the specified AWS account.
Parameter Syntax
$result = $client->listAnalyses([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'AnalysisSummaryList' => [
[
'AnalysisId' => '<string>',
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AnalysisSummaryList
-
- Type: Array of AnalysisSummary structures
Metadata describing each of the analyses that are listed.
- 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
-
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.
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|DELETED',
'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 in your AWS account. 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>',
'ColumnLevelPermissionRulesApplied' => true || false,
'CreatedTime' => <DateTime>,
'DataSetId' => '<string>',
'ImportMode' => 'SPICE|DIRECT_QUERY',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'RowLevelPermissionDataSet' => [
'Arn' => '<string>',
'FormatVersion' => 'VERSION_1|VERSION_2',
'Namespace' => '<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' => [
[
'AlternateDataSourceParameters' => [
[
'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>,
],
'OracleParameters' => [
'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>',
],
],
// ...
],
'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>,
],
'OracleParameters' => [
'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' => 'ACCESS_DENIED|COPY_SOURCE_NOT_FOUND|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|DELETED',
'Type' => 'ADOBE_ANALYTICS|AMAZON_ELASTICSEARCH|ATHENA|AURORA|AURORA_POSTGRESQL|AWS_IOT_ANALYTICS|GITHUB|JIRA|MARIADB|MYSQL|ORACLE|POSTGRESQL|PRESTO|REDSHIFT|S3|SALESFORCE|SERVICENOW|SNOWFLAKE|SPARK|SQLSERVER|TERADATA|TWITTER|TIMESTREAM',
'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.
ListFolderMembers
$result = $client->listFolderMembers([/* ... */]); $promise = $client->listFolderMembersAsync([/* ... */]);
List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
Parameter Syntax
$result = $client->listFolderMembers([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'FolderMemberList' => [
[
'MemberArn' => '<string>',
'MemberId' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- FolderMemberList
-
- Type: Array of MemberIdArnPair structures
A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK
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.
-
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.
ListFolders
$result = $client->listFolders([/* ... */]); $promise = $client->listFoldersAsync([/* ... */]);
Lists all folders in an account.
Parameter Syntax
$result = $client->listFolders([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'FolderSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'FolderId' => '<string>',
'FolderType' => 'SHARED',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- FolderSummaryList
-
- Type: Array of FolderSummary structures
A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK
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.
-
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.
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 operation 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.
ListNamespaces
$result = $client->listNamespaces([/* ... */]); $promise = $client->listNamespacesAsync([/* ... */]);
Lists the namespaces for the specified AWS account.
Parameter Syntax
$result = $client->listNamespaces([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Namespaces' => [
[
'Arn' => '<string>',
'CapacityRegion' => '<string>',
'CreationStatus' => 'CREATED|CREATING|DELETING|RETRYABLE_FAILURE|NON_RETRYABLE_FAILURE',
'IdentityStore' => 'QUICKSIGHT',
'Name' => '<string>',
'NamespaceError' => [
'Message' => '<string>',
'Type' => 'PERMISSION_DENIED|INTERNAL_SERVICE_ERROR',
],
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Namespaces
-
- Type: Array of NamespaceInfoV2 structures
The information about the namespaces in this AWS account. The response includes the namespace ARN, name, AWS Region, notification email address, creation status, and identity store.
- 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.
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
-
The
NextTokenvalue isn't valid. -
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|DELETED',
'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.
ListThemeAliases
$result = $client->listThemeAliases([/* ... */]); $promise = $client->listThemeAliasesAsync([/* ... */]);
Lists all the aliases of a theme.
Parameter Syntax
$result = $client->listThemeAliases([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme 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.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeAliasList' => [
[
'AliasName' => '<string>',
'Arn' => '<string>',
'ThemeVersionNumber' => <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.
- ThemeAliasList
-
- Type: Array of ThemeAlias structures
A structure containing the list of the theme's aliases.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
The
NextTokenvalue isn't valid. -
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.
ListThemeVersions
$result = $client->listThemeVersions([/* ... */]); $promise = $client->listThemeVersionsAsync([/* ... */]);
Lists all the versions of the themes in the current AWS account.
Parameter Syntax
$result = $client->listThemeVersions([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the themes 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.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeVersionSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'Description' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'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.
- ThemeVersionSummaryList
-
- Type: Array of ThemeVersionSummary structures
A structure containing a list of all the versions of the specified theme.
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.
-
The
NextTokenvalue isn't valid. -
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.
ListThemes
$result = $client->listThemes([/* ... */]); $promise = $client->listThemesAsync([/* ... */]);
Lists all the themes in the current AWS account.
Parameter Syntax
$result = $client->listThemes([
'AwsAccountId' => '<string>', // REQUIRED
'MaxResults' => <integer>,
'NextToken' => '<string>',
'Type' => 'QUICKSIGHT|CUSTOM|ALL',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the themes 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.
- Type
-
- Type: string
The type of themes that you want to list. Valid options include the following:
-
ALL (default)- Display all existing themes. -
CUSTOM- Display only the themes created by people using Amazon QuickSight. -
QUICKSIGHT- Display only the starting themes defined by QuickSight.
Result Syntax
[
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'LatestVersionNumber' => <integer>,
'Name' => '<string>',
'ThemeId' => '<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.
- ThemeSummaryList
-
- Type: Array of ThemeSummary structures
Information about the themes in the list.
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
NextTokenvalue 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.
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.
-
One or more preconditions aren't met.
-
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>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>',
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginFederationProviderUrl' => '<string>',
'ExternalLoginId' => '<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. -
One or more preconditions aren't met.
-
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
'CustomFederationProviderUrl' => '<string>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>', // REQUIRED
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginId' => '<string>',
'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.
- CustomFederationProviderUrl
-
- Type: string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should only be used when
ExternalLoginFederationProviderTypeparameter is set toCUSTOM_OIDC. - CustomPermissionsName
-
- Type: string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
-
Create and update data sources
-
Create and update datasets
-
Create and update email reports
-
Subscribe to email reports
To add custom permissions to an existing user, use
UpdateUserinstead.A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the
RegisterUserAPI operation to assign the named set of permissions to a QuickSight user.QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
-
- Required: Yes
- Type: string
The email address of the user that you want to register.
- ExternalLoginFederationProviderType
-
- Type: string
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
-
COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing theCOGNITOprovider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. -
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosingCUSTOM_OIDCtype, use theCustomFederationProviderUrlparameter to provide the custom OIDC provider URL.
- ExternalLoginId
-
- Type: string
The identity ID for a user in the external login provider.
- 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>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>',
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginFederationProviderUrl' => '<string>',
'ExternalLoginId' => '<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's 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.
RestoreAnalysis
$result = $client->restoreAnalysis([/* ... */]); $promise = $client->restoreAnalysisAsync([/* ... */]);
Restores an analysis.
Parameter Syntax
$result = $client->restoreAnalysis([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'AnalysisId' => '<string>',
'Arn' => '<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.
SearchAnalyses
$result = $client->searchAnalyses([/* ... */]); $promise = $client->searchAnalysesAsync([/* ... */]);
Searches for analyses that belong to the user specified in the filter.
Parameter Syntax
$result = $client->searchAnalyses([
'AwsAccountId' => '<string>', // REQUIRED
'Filters' => [ // REQUIRED
[
'Name' => 'QUICKSIGHT_USER',
'Operator' => 'StringEquals',
'Value' => '<string>',
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the analyses that you're searching for.
- Filters
-
- Required: Yes
- Type: Array of AnalysisSearchFilter structures
The structure for the search filters that you want to apply to your search.
- MaxResults
-
- Type: int
The maximum number of results to return.
- NextToken
-
- Type: string
A pagination token that can be used in a subsequent request.
Result Syntax
[
'AnalysisSummaryList' => [
[
'AnalysisId' => '<string>',
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
'Status' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AnalysisSummaryList
-
- Type: Array of AnalysisSummary structures
Metadata describing the analyses that you searched for.
- 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
-
Access is throttled.
-
One or more resources can't be found.
-
InvalidParameterValueException:
One or more parameters has a value that 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.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
SearchDashboards
$result = $client->searchDashboards([/* ... */]); $promise = $client->searchDashboardsAsync([/* ... */]);
Searches for dashboards that belong to a user.
Parameter Syntax
$result = $client->searchDashboards([
'AwsAccountId' => '<string>', // REQUIRED
'Filters' => [ // REQUIRED
[
'Name' => 'QUICKSIGHT_USER',
'Operator' => 'StringEquals', // REQUIRED
'Value' => '<string>',
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the user whose dashboards you're searching for.
- Filters
-
- Required: Yes
- Type: Array of DashboardSearchFilter structures
The filters to apply to the search. Currently, you can search only by user name, for example,
"Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ] - 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
[
'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
The list of dashboards owned by the user specified in
Filtersin your request. - 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.
-
One or more resources can't be found.
-
InvalidParameterValueException:
One or more parameters has a value that 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.
-
The
NextTokenvalue isn't valid. -
An internal failure occurred.
SearchFolders
$result = $client->searchFolders([/* ... */]); $promise = $client->searchFoldersAsync([/* ... */]);
Searches the subfolders in a folder.
Parameter Syntax
$result = $client->searchFolders([
'AwsAccountId' => '<string>', // REQUIRED
'Filters' => [ // REQUIRED
[
'Name' => 'PARENT_FOLDER_ARN',
'Operator' => 'StringEquals',
'Value' => '<string>',
],
// ...
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The AWS account ID.
- Filters
-
- Required: Yes
- Type: Array of FolderSearchFilter structures
The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example,
"Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ]. - 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
[
'FolderSummaryList' => [
[
'Arn' => '<string>',
'CreatedTime' => <DateTime>,
'FolderId' => '<string>',
'FolderType' => 'SHARED',
'LastUpdatedTime' => <DateTime>,
'Name' => '<string>',
],
// ...
],
'NextToken' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- FolderSummaryList
-
- Type: Array of FolderSummary structures
A structure that contains all of the folders in your AWS account. This structure provides basic information about the folders.
- NextToken
-
- Type: string
The token for the next set of results, or null if there are no more results.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK.
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.
-
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.
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.
UpdateAccountCustomization
$result = $client->updateAccountCustomization([/* ... */]); $promise = $client->updateAccountCustomizationAsync([/* ... */]);
Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.
You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
Parameter Syntax
$result = $client->updateAccountCustomization([
'AccountCustomization' => [ // REQUIRED
'DefaultTheme' => '<string>',
],
'AwsAccountId' => '<string>', // REQUIRED
'Namespace' => '<string>',
]);
Parameter Details
Members
- AccountCustomization
-
- Required: Yes
- Type: AccountCustomization structure
The QuickSight customizations you're updating in the current AWS Region.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that you want to update QuickSight customizations for.
- Namespace
-
- Type: string
The namespace that you want to update QuickSight customizations for.
Result Syntax
[
'AccountCustomization' => [
'DefaultTheme' => '<string>',
],
'Arn' => '<string>',
'AwsAccountId' => '<string>',
'Namespace' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AccountCustomization
-
- Type: AccountCustomization structure
The QuickSight customizations you're updating in the current AWS Region.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the updated customization for this AWS account.
- AwsAccountId
-
- Type: string
The ID for the AWS account that you want to update QuickSight customizations for.
- Namespace
-
- Type: string
The namespace associated with the customization that you're updating.
- 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.
UpdateAccountSettings
$result = $client->updateAccountSettings([/* ... */]); $promise = $client->updateAccountSettingsAsync([/* ... */]);
Updates the Amazon QuickSight settings in your AWS account.
Parameter Syntax
$result = $client->updateAccountSettings([
'AwsAccountId' => '<string>', // REQUIRED
'DefaultNamespace' => '<string>', // REQUIRED
'NotificationEmail' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID for the AWS account that contains the QuickSight settings that you want to list.
- DefaultNamespace
-
- Required: Yes
- Type: string
The default namespace for this AWS account. Currently, the default is
default. AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace. - NotificationEmail
-
- Type: string
The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.
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.
UpdateAnalysis
$result = $client->updateAnalysis([/* ... */]); $promise = $client->updateAnalysisAsync([/* ... */]);
Updates an analysis in Amazon QuickSight
Parameter Syntax
$result = $client->updateAnalysis([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'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
],
// ...
],
],
],
'ThemeArn' => '<string>',
]);
Parameter Details
Members
- AnalysisId
-
- Required: Yes
- Type: string
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the analysis that you're updating.
- Name
-
- Required: Yes
- Type: string
A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
- Parameters
-
- Type: Parameters structure
The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
- SourceEntity
-
- Required: Yes
- Type: AnalysisSourceEntity structure
A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
- ThemeArn
-
- Type: string
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.
Result Syntax
[
'AnalysisId' => '<string>',
'Arn' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
'UpdateStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
]
Result Details
Members
- AnalysisId
-
- Type: string
The ID of the analysis.
- Arn
-
- Type: string
The ARN of the analysis that you're updating.
- 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 last update that was made to the analysis.
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.
UpdateAnalysisPermissions
$result = $client->updateAnalysisPermissions([/* ... */]); $promise = $client->updateAnalysisPermissionsAsync([/* ... */]);
Updates the read and write permissions for an analysis.
Parameter Syntax
$result = $client->updateAnalysisPermissions([
'AnalysisId' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
]);
Parameter Details
Members
- AnalysisId
-
- Required: Yes
- Type: string
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
A structure that describes the permissions to add and the principal to add them to.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
A structure that describes the permissions to remove and the principal to remove them from.
Result Syntax
[
'AnalysisArn' => '<string>',
'AnalysisId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- AnalysisArn
-
- Type: string
The Amazon Resource Name (ARN) of the analysis that you updated.
- AnalysisId
-
- Type: string
The ID of the analysis that you updated permissions for.
- Permissions
-
- Type: Array of ResourcePermission structures
A structure that describes the principals and the resource-level permissions on an analysis.
- 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.
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
],
// ...
],
],
],
'ThemeArn' => '<string>',
'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. 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.
- SourceEntity
-
- Required: Yes
- Type: DashboardSourceEntity structure
The entity that you are using as a source when you update the dashboard. In
SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use aSourceTemplateentity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. ForSourceTemplate, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.Use the
DataSetReferencesentity withinSourceTemplateto list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. - ThemeArn
-
- Type: string
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create 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|DELETED',
'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
],
],
// ...
],
'ColumnLevelPermissionRules' => [
[
'ColumnNames' => ['<string>', ...],
'Principals' => ['<string>', ...],
],
// ...
],
'DataSetId' => '<string>', // REQUIRED
'FieldFolders' => [
'<FieldFolderPath>' => [
'columns' => ['<string>', ...],
'description' => '<string>',
],
// ...
],
'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
[
'ColumnDescription' => [
'Text' => '<string>',
],
'ColumnGeographicRole' => 'COUNTRY|STATE|COUNTY|CITY|POSTCODE|LONGITUDE|LATITUDE',
],
// ...
],
],
],
// ...
],
'Source' => [ // REQUIRED
'JoinInstruction' => [
'LeftJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'LeftOperand' => '<string>', // REQUIRED
'OnClause' => '<string>', // REQUIRED
'RightJoinKeyProperties' => [
'UniqueKey' => true || false,
],
'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' => [
'Catalog' => '<string>',
'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
'FormatVersion' => 'VERSION_1|VERSION_2',
'Namespace' => '<string>',
'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.
- ColumnLevelPermissionRules
-
- Type: Array of ColumnLevelPermissionRule structures
A set of one or more definitions of a
ColumnLevelPermissionRule. - 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.
- FieldFolders
-
- Type: Associative array of custom strings keys (FieldFolderPath) to FieldFolder structures
The folder that contains fields and nested subfolders for your dataset.
- 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' => [
'CopySourceArn' => '<string>',
'CredentialPair' => [
'AlternateDataSourceParameters' => [
[
'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
],
'OracleParameters' => [
'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
],
],
// ...
],
'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
],
'OracleParameters' => [
'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|DELETED',
]
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.
UpdateFolder
$result = $client->updateFolder([/* ... */]); $promise = $client->updateFolderAsync([/* ... */]);
Updates the name of a folder.
Parameter Syntax
$result = $client->updateFolder([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
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.
-
Updating or deleting a resource can cause an inconsistent state.
-
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.
UpdateFolderPermissions
$result = $client->updateFolderPermissions([/* ... */]); $promise = $client->updateFolderPermissionsAsync([/* ... */]);
Updates permissions of a folder.
Parameter Syntax
$result = $client->updateFolderPermissions([
'AwsAccountId' => '<string>', // REQUIRED
'FolderId' => '<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.
- FolderId
-
- Required: Yes
- Type: string
The folder ID.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
The permissions that you want to grant on a resource.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
The permissions that you want to revoke from a resource.
Result Syntax
[
'Arn' => '<string>',
'FolderId' => '<string>',
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN).
- FolderId
-
- Type: string
The folder ID.
- Permissions
-
- Type: Array of ResourcePermission structures
Information about the permissions on the dashboard.
- RequestId
-
- Type: string
The request ID.
- Status
-
- Type: int
The status. If succeeded, the status is
SC_OK.
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.
-
A limit is exceeded.
-
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.
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. This overwrites all of the users included in Identities.
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, also called a rule. 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 or rule.
- 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 operation 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 entity that you are using as a source when you update the template. In
SourceEntity, you specify the type of object you're using as source:SourceTemplatefor a template orSourceAnalysisfor an analysis. Both of these require an Amazon Resource Name (ARN). ForSourceTemplate, specify the ARN of the source template. ForSourceAnalysis, specify the ARN of the source analysis. TheSourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.Use the
DataSetReferencesentity withinSourceTemplateorSourceAnalysisto list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. - 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|DELETED',
'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.
-
Updating or deleting a resource can cause an inconsistent state.
-
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.
UpdateTheme
$result = $client->updateTheme([/* ... */]); $promise = $client->updateThemeAsync([/* ... */]);
Updates a theme.
Parameter Syntax
$result = $client->updateTheme([
'AwsAccountId' => '<string>', // REQUIRED
'BaseThemeId' => '<string>', // REQUIRED
'Configuration' => [
'DataColorPalette' => [
'Colors' => ['<string>', ...],
'EmptyFillColor' => '<string>',
'MinMaxGradient' => ['<string>', ...],
],
'Sheet' => [
'Tile' => [
'Border' => [
'Show' => true || false,
],
],
'TileLayout' => [
'Gutter' => [
'Show' => true || false,
],
'Margin' => [
'Show' => true || false,
],
],
],
'UIColorPalette' => [
'Accent' => '<string>',
'AccentForeground' => '<string>',
'Danger' => '<string>',
'DangerForeground' => '<string>',
'Dimension' => '<string>',
'DimensionForeground' => '<string>',
'Measure' => '<string>',
'MeasureForeground' => '<string>',
'PrimaryBackground' => '<string>',
'PrimaryForeground' => '<string>',
'SecondaryBackground' => '<string>',
'SecondaryForeground' => '<string>',
'Success' => '<string>',
'SuccessForeground' => '<string>',
'Warning' => '<string>',
'WarningForeground' => '<string>',
],
],
'Name' => '<string>',
'ThemeId' => '<string>', // REQUIRED
'VersionDescription' => '<string>',
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme that you're updating.
- BaseThemeId
-
- Required: Yes
- Type: string
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
- Configuration
-
- Type: ThemeConfiguration structure
The theme configuration, which contains the theme display properties.
- Name
-
- Type: string
The name for the theme.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
- VersionDescription
-
- Type: string
A description of the theme version that you're updating Every time that you call
UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version inVersionDescription.
Result Syntax
[
'Arn' => '<string>',
'CreationStatus' => 'CREATION_IN_PROGRESS|CREATION_SUCCESSFUL|CREATION_FAILED|UPDATE_IN_PROGRESS|UPDATE_SUCCESSFUL|UPDATE_FAILED|DELETED',
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeId' => '<string>',
'VersionArn' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the theme.
- CreationStatus
-
- Type: string
The creation status of the theme.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeId
-
- Type: string
The ID for the theme.
- VersionArn
-
- Type: string
The Amazon Resource Name (ARN) for the new version of the theme.
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.
-
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.
UpdateThemeAlias
$result = $client->updateThemeAlias([/* ... */]); $promise = $client->updateThemeAliasAsync([/* ... */]);
Updates an alias of a theme.
Parameter Syntax
$result = $client->updateThemeAlias([
'AliasName' => '<string>', // REQUIRED
'AwsAccountId' => '<string>', // REQUIRED
'ThemeId' => '<string>', // REQUIRED
'ThemeVersionNumber' => <integer>, // REQUIRED
]);
Parameter Details
Members
- AliasName
-
- Required: Yes
- Type: string
The name of the theme alias that you want to update.
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme alias that you're updating.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
- ThemeVersionNumber
-
- Required: Yes
- Type: long (int|float)
The version number of the theme that the alias should reference.
Result Syntax
[
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeAlias' => [
'AliasName' => '<string>',
'Arn' => '<string>',
'ThemeVersionNumber' => <integer>,
],
]
Result Details
Members
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeAlias
-
- Type: ThemeAlias structure
Information about the theme alias.
Errors
-
Updating or deleting a resource can cause an inconsistent state.
-
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.
-
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.
UpdateThemePermissions
$result = $client->updateThemePermissions([/* ... */]); $promise = $client->updateThemePermissionsAsync([/* ... */]);
Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme".
Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:
-
User
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions"
-
-
Owner
-
"quicksight:DescribeTheme" -
"quicksight:DescribeThemeAlias" -
"quicksight:ListThemeAliases" -
"quicksight:ListThemeVersions" -
"quicksight:DeleteTheme" -
"quicksight:UpdateTheme" -
"quicksight:CreateThemeAlias" -
"quicksight:DeleteThemeAlias" -
"quicksight:UpdateThemeAlias" -
"quicksight:UpdateThemePermissions" -
"quicksight:DescribeThemePermissions"
-
-
To specify no permissions, omit the permissions list.
Parameter Syntax
$result = $client->updateThemePermissions([
'AwsAccountId' => '<string>', // REQUIRED
'GrantPermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'RevokePermissions' => [
[
'Actions' => ['<string>', ...], // REQUIRED
'Principal' => '<string>', // REQUIRED
],
// ...
],
'ThemeId' => '<string>', // REQUIRED
]);
Parameter Details
Members
- AwsAccountId
-
- Required: Yes
- Type: string
The ID of the AWS account that contains the theme.
- GrantPermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be granted for the theme.
- RevokePermissions
-
- Type: Array of ResourcePermission structures
A list of resource permissions to be revoked from the theme.
- ThemeId
-
- Required: Yes
- Type: string
The ID for the theme.
Result Syntax
[
'Permissions' => [
[
'Actions' => ['<string>', ...],
'Principal' => '<string>',
],
// ...
],
'RequestId' => '<string>',
'Status' => <integer>,
'ThemeArn' => '<string>',
'ThemeId' => '<string>',
]
Result Details
Members
- Permissions
-
- Type: Array of ResourcePermission structures
The resulting list of resource permissions for the theme.
- RequestId
-
- Type: string
The AWS request ID for this operation.
- Status
-
- Type: int
The HTTP status of the request.
- ThemeArn
-
- Type: string
The Amazon Resource Name (ARN) of the theme.
- ThemeId
-
- Type: string
The ID for the theme.
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.
-
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
'CustomFederationProviderUrl' => '<string>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>', // REQUIRED
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginId' => '<string>',
'Namespace' => '<string>', // REQUIRED
'Role' => 'ADMIN|AUTHOR|READER|RESTRICTED_AUTHOR|RESTRICTED_READER', // REQUIRED
'UnapplyCustomPermissions' => true || false,
'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.
- CustomFederationProviderUrl
-
- Type: string
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should only be used when
ExternalLoginFederationProviderTypeparameter is set toCUSTOM_OIDC. - CustomPermissionsName
-
- Type: string
(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:
-
Create and update data sources
-
Create and update datasets
-
Create and update email reports
-
Subscribe to email reports
A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the
RegisterUserAPI operation to assign the named set of permissions to a QuickSight user.QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).
This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
-
- Required: Yes
- Type: string
The email address of the user that you want to update.
- ExternalLoginFederationProviderType
-
- Type: string
The type of supported external login provider that provides identity to let a user federate into QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
-
COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing theCOGNITOprovider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. -
CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosingCUSTOM_OIDCtype, use theCustomFederationProviderUrlparameter to provide the custom OIDC provider URL. -
NONE: This clears all the previously saved external login information for a user. UseDescribeUserAPI to check the external login information.
- ExternalLoginId
-
- Type: string
The identity ID for a user in the external login provider.
- 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 role can be one of the following default security cohorts:
-
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.
The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
- UnapplyCustomPermissions
-
- Type: boolean
A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
- 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>',
'CustomPermissionsName' => '<string>',
'Email' => '<string>',
'ExternalLoginFederationProviderType' => '<string>',
'ExternalLoginFederationProviderUrl' => '<string>',
'ExternalLoginId' => '<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.
-
One or more preconditions aren't met.
-
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
AccountCustomization
Description
The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
Members
AccountSettings
Description
The QuickSight settings associated with your AWS account.
Members
- AccountName
-
- Type: string
The "account name" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.
- DefaultNamespace
-
- Type: string
The default QuickSight namespace for your AWS account.
- Edition
-
- Type: string
The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
- NotificationEmail
-
- Type: string
The main notification email for your QuickSight subscription.
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
Analysis
Description
Metadata structure for an analysis in Amazon QuickSight
Members
- AnalysisId
-
- Type: string
The ID of the analysis.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the analysis.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the analysis was created.
- DataSetArns
-
- Type: Array of strings
The ARNs of the datasets of the analysis.
- Errors
-
- Type: Array of AnalysisError structures
Errors associated with the analysis.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the analysis was last updated.
- Name
-
- Type: string
The descriptive name of the analysis.
- Sheets
-
- Type: Array of Sheet structures
A list of the associated sheets with the unique identifier and name of each sheet.
- Status
-
- Type: string
Status associated with the analysis.
- ThemeArn
-
- Type: string
The ARN of the theme of the analysis.
AnalysisError
Description
A metadata error structure for an analysis.
Members
AnalysisSearchFilter
Description
A filter that you apply when searching for one or more analyses.
Members
- Name
-
- Type: string
The name of the value that you want to use as a filter, for example
"Name": "QUICKSIGHT_USER". - Operator
-
- Type: string
The comparison operator that you want to use as a filter, for example
"Operator": "StringEquals". - Value
-
- Type: string
The value of the named item, in this case
QUICKSIGHT_USER, that you want to use as a filter, for example"Value". An example is"arn:aws:quicksight:us-east-1:1:user/default/UserName1".
AnalysisSourceEntity
Description
The source entity of an analysis.
Members
- SourceTemplate
-
- Type: AnalysisSourceTemplate structure
The source template for the source entity of the analysis.
AnalysisSourceTemplate
Description
The source template of an analysis.
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the source template of an analysis.
- DataSetReferences
-
- Required: Yes
- Type: Array of DataSetReference structures
The dataset references of the source template of an analysis.
AnalysisSummary
Description
The summary metadata that describes an analysis.
Members
- AnalysisId
-
- Type: string
The ID of the analysis. This ID displays in the URL.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) for the analysis.
- CreatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the analysis was created.
- LastUpdatedTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the analysis was last updated.
- Name
-
- Type: string
The name of the analysis. This name is displayed in the QuickSight console.
- Status
-
- Type: string
The last known status for the analysis.
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
BorderStyle
Description
The display options for tile borders for visuals.
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
ColumnDescription
Description
Metadata that contains a description for a column.