String requestId
The AWS request ID for this request.
String availabilityStatus
Availability status.
String domain
The Amazon Elasticsearch Service domain.
String workGroup
The workgroup that Amazon Athena uses.
String dataSetName
Dataset name.
String columnName
Column name.
String columnId
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.
String expression
An expression that defines the calculated column.
GeoSpatialColumnGroup geoSpatialColumnGroup
Geospatial column group that denotes a hierarchy.
String name
The name of the column group's column schema.
String columnGeographicRole
A geospatial role for a column.
String requestId
String requestId
The AWS request ID for this request.
String awsAccountId
The ID of the AWS account where you want to create the dashboard.
String dashboardId
The ID for the dashboard, also added to the IAM policy.
String name
The display name of the dashboard.
Parameters parameters
A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values. You can use the dashboard permissions structure described following to override two string parameters that accept multiple values.
List<E> permissions
A structure that contains the permissions of the dashboard. You can use this structure for granting permissions with principal and action information.
DashboardSourceEntity sourceEntity
The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.
If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
String versionDescription
A description for the first version of the dashboard being created.
DashboardPublishOptions dashboardPublishOptions
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either
ENABLED
or DISABLED
. When this is set to DISABLED
, QuickSight disables the
left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is
ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either
ENABLED
or DISABLED
. The visual option to export data to .csv format isn't enabled when
this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either
COLLAPSED
or EXPANDED
. The sheet controls pane is collapsed by default when set to
true. This option is COLLAPSED
by default.
String arn
The Amazon Resource Name (ARN) of the dashboard.
String versionArn
The ARN of the dashboard, including the version number of the first version that is created.
String dashboardId
The ID for the dashboard.
String creationStatus
The status of the dashboard creation request.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The AWS account ID.
String dataSetId
An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
String name
The display name for the dataset.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
String importMode
Indicates whether you want to import the data into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
List<E> permissions
A list of resource permissions on the dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the data that you want to create.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
String ingestionArn
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String ingestionId
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The AWS account ID.
String dataSourceId
An ID for the data source. This ID is unique per AWS Region for each AWS account.
String name
A display name for the data source.
String type
The type of the data source. Currently, the supported types for this operation are:
ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA
. Use ListDataSources
to return a list of all data sources.
DataSourceParameters dataSourceParameters
The parameters that QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
List<E> permissions
A list of resource permissions on the data source.
VpcConnectionProperties vpcConnectionProperties
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String creationStatus
The status of creating the data source.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String memberName
The name of the user that you want to add to the group membership.
String groupName
The name of the group that you want to add the user to.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
GroupMember groupMember
The group member.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String groupName
A name for the group that you want to create.
String description
A description for the group that you want to create.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.
String assignmentName
The name of the assignment. It must be unique within an AWS account.
String assignmentStatus
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.
String policyArn
The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
Map<K,V> identities
The QuickSight users, groups, or both that you want to assign the policy to.
String namespace
The namespace that contains the assignment.
String assignmentName
The name of the assignment. This name must be unique within the AWS account.
String assignmentId
The ID for the assignment.
String assignmentStatus
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.
String policyArn
The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
Map<K,V> identities
The QuickSight users, groups, or both that the IAM policy is assigned to.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) for the data ingestion.
String ingestionId
An ID for the ingestion.
String ingestionStatus
The ingestion status.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the template that you creating an alias for.
String templateId
An ID for the template.
String aliasName
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.
Long templateVersionNumber
The version number of the template.
TemplateAlias templateAlias
Information about the template alias.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
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.
String templateId
An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.
String name
A display name for the template.
List<E> permissions
A list of resource permissions to be set on the template.
TemplateSourceEntity sourceEntity
The Amazon Resource Name (ARN) of the source entity from which this template is being created. Currently, you can create a template from an analysis or another template. If the ARN is for an analysis, include its dataset references.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
String versionDescription
A description of the current template version being created. This API operation creates the first version of the
template. Every time UpdateTemplate
is called, a new version is created. Each version of the
template maintains a description of the version in the VersionDescription
field.
String arn
The ARN for the template.
String versionArn
The ARN for the template, including the version information of the first version.
String templateId
The ID of the template.
String creationStatus
The template creation status.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String dashboardId
Dashboard ID.
String arn
The Amazon Resource Name (ARN) of the resource.
String name
A display name for the dataset.
DashboardVersion version
Version.
Date createdTime
The time that this dataset was created.
Date lastPublishedTime
The last time that this dataset was published.
Date lastUpdatedTime
The last time that this dataset was updated.
AdHocFilteringOption adHocFilteringOption
Ad hoc (one-time) filtering option.
ExportToCSVOption exportToCSVOption
Export to .csv option.
SheetControlsOption sheetControlsOption
Sheet controls option.
String operator
The comparison operator that you want to use as a filter. For example, "Operator": "StringEquals"
.
String name
The name of the value that you want to use as a filter. For example, "Name": "QUICKSIGHT_USER"
.
String value
The value of the named item, in this case QUICKSIGHT_USER
, that you want to use as a filter. For
example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
DashboardSourceTemplate sourceTemplate
Source template.
String arn
The Amazon Resource Name (ARN) of the resource.
String dashboardId
Dashboard ID.
String name
A display name for the dashboard.
Date createdTime
The time that this dashboard was created.
Date lastUpdatedTime
The last time that this dashboard was updated.
Long publishedVersionNumber
Published version number.
Date lastPublishedTime
The last time that this dashboard was published.
Date createdTime
The time that this dashboard version was created.
List<E> errors
Errors.
Long versionNumber
Version number.
String status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the resource.
String sourceEntityArn
Source entity ARN.
String description
Description.
String arn
The Amazon Resource Name (ARN) of the resource.
Date createdTime
The time that this dashboard version was created.
Long versionNumber
Version number.
String status
The HTTP status of the request.
String sourceEntityArn
Source entity ARN.
String description
Description.
String arn
The Amazon Resource Name (ARN) of the resource.
String dataSetId
The ID of the dataset.
String name
A display name for the dataset.
Date createdTime
The time that this dataset was created.
Date lastUpdatedTime
The last time that this dataset was updated.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
List<E> outputColumns
The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
String importMode
Indicates whether you want to import the data into SPICE.
Long consumedSpiceCapacityInBytes
The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
String placeholder
Placeholder.
DataSetSchema dataSetSchema
Dataset schema.
List<E> columnGroupSchemaList
A structure containing the list of column group schemas.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID of the dataset.
String name
A display name for the dataset.
Date createdTime
The time that this dataset was created.
Date lastUpdatedTime
The last time that this dataset was updated.
String importMode
Indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String name
A display name for the data source.
String type
The type of the data source. This type indicates which database engine the data source connects to.
String status
The HTTP status of the request.
Date createdTime
The time that this data source was created.
Date lastUpdatedTime
The last time that this data source was updated.
DataSourceParameters dataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
VpcConnectionProperties vpcConnectionProperties
The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
DataSourceErrorInfo errorInfo
Error information from the last update or the creation of the data source.
CredentialPair credentialPair
Credential pair.
AmazonElasticsearchParameters amazonElasticsearchParameters
Amazon Elasticsearch Service parameters.
AthenaParameters athenaParameters
Amazon Athena parameters.
AuroraParameters auroraParameters
Amazon Aurora MySQL parameters.
AuroraPostgreSqlParameters auroraPostgreSqlParameters
Aurora PostgreSQL parameters.
AwsIotAnalyticsParameters awsIotAnalyticsParameters
AWS IoT Analytics parameters.
JiraParameters jiraParameters
Jira parameters.
MariaDbParameters mariaDbParameters
MariaDB parameters.
MySqlParameters mySqlParameters
MySQL parameters.
PostgreSqlParameters postgreSqlParameters
PostgreSQL parameters.
PrestoParameters prestoParameters
Presto parameters.
RdsParameters rdsParameters
Amazon RDS parameters.
RedshiftParameters redshiftParameters
Amazon Redshift parameters.
S3Parameters s3Parameters
S3 parameters.
ServiceNowParameters serviceNowParameters
ServiceNow parameters.
SnowflakeParameters snowflakeParameters
Snowflake parameters.
SparkParameters sparkParameters
Spark parameters.
SqlServerParameters sqlServerParameters
SQL Server parameters.
TeradataParameters teradataParameters
Teradata parameters.
TwitterParameters twitterParameters
Twitter parameters.
String awsAccountId
The ID of the AWS account that contains the dashboard that you're deleting.
String dashboardId
The ID for the dashboard.
Long versionNumber
The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the data source that you deleted.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String memberName
The name of the user that you want to delete from the group membership.
String groupName
The name of the group that you want to delete the user from.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String groupName
The name of the group that you want to delete.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID of the AWS account that contains the item to delete.
String templateId
The ID for the template that the specified alias is for.
String aliasName
The name for the template alias. If you name a specific alias, you delete the version that the alias points to.
You can specify the latest version of the template by providing the keyword $LATEST
in the
AliasName
parameter.
Integer status
The HTTP status of the request.
String templateId
An ID for the template associated with the deletion.
String aliasName
The name for the template alias.
String arn
The Amazon Resource Name (ARN) of the resource.
String requestId
The AWS request ID for this operation.
String awsAccountId
The ID of the AWS account that contains the template that you're deleting.
String templateId
An ID for the template you want to delete.
Long versionNumber
Specifies the version of the template that you want to delete. If you don't provide a version number,
DeleteTemplate
deletes all versions of the template.
String principalId
The principal ID of the user.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String userName
The name of the user that you want to delete.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String dashboardId
The ID for the dashboard.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
List<E> permissions
A structure that contains the permissions for the dashboard.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The ID of the AWS account that contains the dashboard that you're describing.
String dashboardId
The ID for the dashboard.
Long versionNumber
The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
String aliasName
The alias name.
String dataSetArn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
List<E> permissions
A list of resource permissions on the dataset.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String dataSourceArn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
List<E> permissions
A list of resource permissions on the data source.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
DataSource dataSource
The information on the data source.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String groupName
The name of the group that you want to describe.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
IAMPolicyAssignment iAMPolicyAssignment
Information describing the IAM policy assignment.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the template alias that you're describing.
String templateId
The ID for the template.
String aliasName
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
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply
to templates.
TemplateAlias templateAlias
Information about the template alias.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String templateId
The ID for the template.
String templateArn
The Amazon Resource Name (ARN) of the template.
List<E> permissions
A list of resource permissions to be set on the template.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the template that you're describing.
String templateId
The ID for the template.
Long versionNumber
(Optional) The number for the version to describe. If a VersionNumber
parameter value isn't
provided, the latest version of the template is described.
String aliasName
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
$LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply
to templates.
String userName
The name of the user that you want to describe.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String requestId
The AWS request ID for this request.
String availabilityStatus
Availability status.
String conditionExpression
An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
String awsAccountId
The ID for the AWS account that contains the dashboard that you're embedding.
String dashboardId
The ID for the dashboard, also added to the IAM policy.
String identityType
The authentication method that the user uses to sign in.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
Boolean undoRedoDisabled
Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
Boolean resetDisabled
Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
String userArn
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
identity 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.
String embedUrl
An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes,
and the resulting session is valid for 10 hours. The API provides the URL with an auth_code
value
that enables a single sign-on session.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The AWS account ID.
String assignmentId
Assignment ID.
String assignmentName
Assignment name.
String policyArn
The Amazon Resource Name (ARN) for the IAM policy.
Map<K,V> identities
Identities.
String assignmentStatus
Assignment status.
String requestId
The AWS request ID for this request.
String arn
The Amazon Resource Name (ARN) of the resource.
String ingestionId
Ingestion ID.
String ingestionStatus
Ingestion status.
ErrorInfo errorInfo
Error information for this ingestion.
RowInfo rowInfo
QueueInfo queueInfo
Date createdTime
The time that this ingestion started.
Long ingestionTimeInSeconds
The time that this ingestion took, measured in seconds.
Long ingestionSizeInBytes
The size of the data ingested, in bytes.
String requestSource
Event source for this ingestion.
String requestType
Type of this ingestion.
String requestId
The AWS request ID for this request.
String requestId
The AWS request ID for this request.
String requestId
The AWS request ID for this request.
String siteBaseUrl
The base URL of the Jira site.
String awsAccountId
The ID of the AWS account that contains the dashboards that you're listing.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardSummaryList
A structure that contains all of the dashboards shared with the user. This structure provides basic information about the dashboards.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The ID of the AWS account that contains the dashboard that you're listing versions for.
String dashboardId
The ID for the dashboard.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardVersionSummaryList
A structure that contains information about each version of the dashboard.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String groupName
The name of the group that you want to see a membership list of.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
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.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID of the AWS account that contains the assignments.
String userName
The name of the user.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
String namespace
The namespace of the assignment.
List<E> activeAssignments
The active assignments for this user.
String requestId
The AWS request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains these IAM policy assignments.
String assignmentStatus
The status of the assignments.
String namespace
The namespace for the assignments.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> iAMPolicyAssignments
Information describing the IAM policy assignments.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String dataSetId
The ID of the dataset used in the ingestion.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The AWS account ID.
Integer maxResults
The maximum number of results to be returned per request.
String resourceArn
The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
String awsAccountId
The ID of the AWS account that contains the template aliases that you're listing.
String templateId
The ID for the template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> templateAliasList
A structure containing the list of the template's aliases.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
List<E> templateSummaryList
A structure containing information about the templates in the list.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The ID of the AWS account that contains the templates that you're listing.
String templateId
The ID for the template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> templateVersionSummaryList
A structure containing a list of all the versions of the specified template.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String userName
The Amazon QuickSight user name that you want to list group memberships for.
String awsAccountId
The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String awsAccountId
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.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return from this request.
String namespace
The namespace. Currently, you should set this to default
.
String alias
A display name for the logical table.
List<E> dataTransforms
Transform operations that act on this logical table.
LogicalTableSource source
Source of this logical table.
JoinInstruction joinInstruction
Specifies the result of a join of two logical tables.
String physicalTableId
Physical table ID.
RelationalTable relationalTable
A physical table type for relational data sources.
CustomSql customSql
A physical table type built from the results of the custom SQL query.
S3Source s3Source
A physical table type for as S3 data source.
String requestId
The AWS request ID for this request.
String requestId
The AWS request ID for this request.
String identityType
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.
String email
The email address of the user that you want to register.
String userRole
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.
String iamArn
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
String sessionName
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-role
in
the AWS CLI Reference.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String userName
The Amazon QuickSight user name that you want to create for the user you are registering.
User user
The user name.
String userInvitationUrl
The URL the user visits to complete registration and provide a password. This is returned only for users with an
identity type of QUICKSIGHT
.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String principal
The Amazon Resource Name (ARN) of an Amazon QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .
List<E> actions
The action to grant or revoke permissions on, for example "quicksight:DescribeDashboard"
.
ManifestFileLocation manifestFileLocation
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded in the console.
String dataSourceArn
The amazon Resource Name (ARN) for the data source.
UploadSettings uploadSettings
Information about the format for the S3 source file or files.
List<E> inputColumns
A physical table type for as S3 data source.
String awsAccountId
The ID of the AWS account that contains the user whose dashboards you're searching for.
List<E> filters
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" } ]
String nextToken
The token for the next set of results, or null if there are no more results.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dashboardSummaryList
The list of dashboards owned by the user specified in Filters
in your request.
String nextToken
The token for the next set of results, or null if there are no more results.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String siteBaseUrl
URL of the base site.
String requestId
The AWS request ID for this request.
String visibilityState
Visibility state.
Boolean disableSsl
A Boolean option to control whether SSL should be disabled.
String arn
The Amazon Resource Name (ARN) of the template.
String name
The display name of the template.
TemplateVersion version
A structure describing the versions of the template.
String templateId
The ID for the template. This is unique per AWS Region for each AWS account.
Date lastUpdatedTime
Time when this was last updated.
Date createdTime
Time when this was created.
TemplateSourceAnalysis sourceAnalysis
The source analysis, if it is based on an analysis.
TemplateSourceTemplate sourceTemplate
The source template, if it is based on an template.
String arn
The Amazon Resource Name (ARN) of the resource.
String arn
A summary of a template.
String templateId
The ID of the template. This ID is unique per AWS Region for each AWS account.
String name
A display name for the template.
Long latestVersionNumber
A structure containing a list of version numbers for the template summary.
Date createdTime
The last time that this template was created.
Date lastUpdatedTime
The last time that this template was updated.
Date createdTime
The time that this template version was created.
List<E> errors
Errors associated with the template.
Long versionNumber
The version number of the template.
String status
The HTTP status of the request.
List<E> dataSetConfigurations
Schema of the dataset identified by the placeholder. The idea is that any dashboard created from the template should be bound to new datasets matching the same schema described through this API. .
String description
The description of the template.
String sourceEntityArn
The Amazon Resource Name (ARN) of the analysis or template which was used to create this template.
String arn
The ARN of the template version.
Long versionNumber
The version number of the template version.
Date createdTime
The time that this template version was created.
String status
The status of the template version.
String description
The description of the template version.
String requestId
The AWS request ID for this request.
ProjectOperation projectOperation
An operation that projects columns. Operations that come after a projection can only refer to projected columns.
FilterOperation filterOperation
An operation that filters rows based on some condition.
CreateColumnsOperation createColumnsOperation
An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
RenameColumnOperation renameColumnOperation
An operation that renames a column.
CastColumnTypeOperation castColumnTypeOperation
A transform operation that casts a column to a different type.
TagColumnOperation tagColumnOperation
An operation that tags a column with additional information.
String requestId
The AWS request ID for this request.
String awsAccountId
The ID of the AWS account that contains the dashboard whose permissions you're updating.
String dashboardId
The ID for the dashboard.
List<E> grantPermissions
The permissions that you want to grant on this resource.
List<E> revokePermissions
The permissions that you want to revoke from this resource.
String dashboardArn
The Amazon Resource Name (ARN) of the dashboard.
String dashboardId
The ID for the dashboard.
List<E> permissions
Information about the permissions on the dashboard.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the dashboard that you're updating.
String dashboardId
The ID for the dashboard.
String name
The display name of the dashboard.
DashboardSourceEntity sourceEntity
The template or analysis from which the dashboard is created. The SouceTemplate
entity accepts the
Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set
when creating the template. The replacement datasets need to follow the same schema as the datasets for which
placeholders were created when creating the template.
Parameters parameters
A structure that contains the parameters of the dashboard.
String versionDescription
A description for the first version of the dashboard being created.
DashboardPublishOptions dashboardPublishOptions
Options for publishing the dashboard when you create it:
AvailabilityStatus
for AdHocFilteringOption
- This status can be either
ENABLED
or DISABLED
. When this is set to DISABLED
, QuickSight disables the
left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is
ENABLED
by default.
AvailabilityStatus
for ExportToCSVOption
- This status can be either
ENABLED
or DISABLED
. The visual option to export data to .csv format isn't enabled when
this is set to DISABLED
. This option is ENABLED
by default.
VisibilityState
for SheetControlsOption
- This visibility state can be either
COLLAPSED
or EXPANDED
. The sheet controls pane is collapsed by default when set to
true. This option is COLLAPSED
by default.
String arn
The Amazon Resource Name (ARN) of the resource.
String versionArn
The ARN of the dashboard, including the version number.
String dashboardId
The ID for the dashboard.
String creationStatus
The creation status of the request.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The AWS account ID.
String dataSetId
The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
List<E> grantPermissions
The resource permissions that you want to grant to the dataset.
List<E> revokePermissions
The resource permissions that you want to revoke from the dataset.
String dataSetArn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset whose permissions you want to update. This ID is unique per AWS Region for each AWS account.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The AWS account ID.
String dataSetId
The ID for the dataset that you want to update. This ID is unique per AWS Region for each AWS account.
String name
The display name for the dataset.
Map<K,V> physicalTableMap
Declares the physical tables that are available in the underlying data sources.
Map<K,V> logicalTableMap
Configures the combination and transformation of the data from the physical tables.
String importMode
Indicates whether you want to import the data into SPICE.
List<E> columnGroups
Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the data you want to create.
String arn
The Amazon Resource Name (ARN) of the dataset.
String dataSetId
The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
String ingestionArn
The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String ingestionId
The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The AWS account ID.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
List<E> grantPermissions
A list of resource permissions that you want to grant on the data source.
List<E> revokePermissions
A list of resource permissions that you want to revoke on the data source.
String dataSourceArn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The AWS account ID.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String name
A display name for the data source.
DataSourceParameters dataSourceParameters
The parameters that QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
VpcConnectionProperties vpcConnectionProperties
Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
String arn
The Amazon Resource Name (ARN) of the data source.
String dataSourceId
The ID of the data source. This ID is unique per AWS Region for each AWS account.
String updateStatus
The update status of the data source's last update.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String groupName
The name of the group that you want to update.
String description
The description for the group that you want to update.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID of the AWS account that contains the IAM policy assignment.
String assignmentName
The name of the assignment. This name must be unique within an AWS account.
String namespace
The namespace of the assignment.
String assignmentStatus
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.
String policyArn
The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.
Map<K,V> identities
The QuickSight users, groups, or both that you want to assign the policy to.
String assignmentName
The name of the assignment.
String assignmentId
The ID of the assignment.
String policyArn
The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.
Map<K,V> identities
The QuickSight users, groups, or both that the IAM policy is assigned to.
String assignmentStatus
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.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the template alias that you're updating.
String templateId
The ID for the template.
String aliasName
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 $LATEST
in the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to templates.
Long templateVersionNumber
The version number of the template.
TemplateAlias templateAlias
The template alias.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String awsAccountId
The ID of the AWS account that contains the template.
String templateId
The ID for the template.
List<E> grantPermissions
A list of resource permissions to be granted on the template.
List<E> revokePermissions
A list of resource permissions to be revoked from the template.
String templateId
The ID for the template.
String templateArn
The Amazon Resource Name (ARN) of the template.
List<E> permissions
A list of resource permissions to be set on the template.
String requestId
The AWS request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the AWS account that contains the template that you're updating.
String templateId
The ID for the template.
TemplateSourceEntity sourceEntity
The source QuickSight entity from which this template is being updated. You can currently update templates from an Analysis or another template.
String versionDescription
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 the VersionDescription
field.
String name
The name for the template.
String templateId
The ID for the template.
String arn
The Amazon Resource Name (ARN) for the template.
String versionArn
The ARN for the template, including the version information of the first version.
String creationStatus
The creation status of the template.
Integer status
The HTTP status of the request.
String requestId
The AWS request ID for this operation.
String userName
The Amazon QuickSight user name that you want to update.
String awsAccountId
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.
String namespace
The namespace. Currently, you should set this to default
.
String email
The email address of the user that you want to update.
String role
The Amazon QuickSight role of the user. The user role can be one of the following:
READER
: A user who has read-only access to dashboards.
AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.
ADMIN
: A user who is an author, who can also manage Amazon QuickSight settings.
String format
File format.
Integer startFromRow
A row number to start reading data from.
Boolean containsHeader
Whether the file has a header row, or the files each have a header row.
String textQualifier
Text qualifier.
String delimiter
The delimiter between values in the file.
String arn
The Amazon Resource Name (ARN) for the user.
String userName
The user's user name.
String email
The user's email address.
String role
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.
String identityType
The type of identity authentication used by the user.
Boolean active
The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
String principalId
The principal ID of the user.
String vpcConnectionArn
The Amazon Resource Name (ARN) for the VPC connection.
Copyright © 2020. All rights reserved.