String requestId
The Amazon Web Services request ID for this request.
String accountName
The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
String edition
The edition of your Amazon QuickSight account.
String notificationEmail
The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
String authenticationType
The way that your Amazon QuickSight account is authenticated.
String accountSubscriptionStatus
The status of your account subscription.
String accountName
The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
String edition
The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
String defaultNamespace
The default Amazon QuickSight namespace for your Amazon Web Services account.
String notificationEmail
The main notification email for your Amazon QuickSight subscription.
Boolean publicSharingEnabled
A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.
Boolean terminationProtectionEnabled
A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a
DeleteAccountSubsctiption
request. A False
value will allow the ccount to be deleted.
String availabilityStatus
Availability status.
String domain
The OpenSearch domain.
String domain
The OpenSearch domain.
String analysisId
The ID of the analysis.
String arn
The Amazon Resource Name (ARN) of the analysis.
String name
The descriptive name of the analysis.
String status
Status associated with the analysis.
List<E> errors
Errors associated with the analysis.
List<E> dataSetArns
The ARNs of the datasets of the analysis.
String themeArn
The ARN of the theme of the analysis.
Date createdTime
The time that the analysis was created.
Date lastUpdatedTime
The time that the analysis was last updated.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals"
.
Valid values are "StringEquals"
and "StringLike"
.
If you set the operator value to "StringEquals"
, you need to provide an ownership related filter in
the "NAME"
field and the arn of the user or group whose folders you want to search in the
"Value"
field. For example,
"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
If you set the value to "StringLike"
, you need to provide the name of the folders you are searching
for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test"
. The
"StringLike"
operator only supports the NAME
value ANALYSIS_NAME
.
String name
The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER"
.
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any analyses with that ARN listed
as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are
considered.
QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any analyses with that ARN listed as one of
the owners of the analyses are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any analyses with that ARN
listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any analyses with that ARN listed as
one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any analyses with that ARN
listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups
are not considered.
ANALYSIS_NAME
: Any analyses whose names have a substring match to this value will be returned.
String value
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"
.
AnalysisSourceTemplate sourceTemplate
The source template for the source entity of the analysis.
String arn
The Amazon Resource Name (ARN) for the analysis.
String analysisId
The ID of the analysis. This ID displays in the URL.
String name
The name of the analysis. This name is displayed in the Amazon QuickSight console.
String status
The last known status for the analysis.
Date createdTime
The time that the analysis was created.
Date lastUpdatedTime
The time that the analysis was last updated.
String initialDashboardId
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard.
The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
DashboardVisualId initialDashboardVisualId
The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
AuthorizedResourceArns
parameter. Otherwise, the request will fail with
InvalidParameterValueException
.
AnonymousUserDashboardEmbeddingConfiguration dashboard
The type of embedding experience. In this case, Amazon QuickSight dashboards.
AnonymousUserDashboardVisualEmbeddingConfiguration dashboardVisual
The type of embedding experience. In this case, Amazon QuickSight visuals.
AnonymousUserQSearchBarEmbeddingConfiguration qSearchBar
The Q search bar that you want to use for anonymous user embedding.
String initialTopicId
The QuickSight Q topic ID of the topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this topic pre-selected.
The Amazon Resource Name (ARN) of this Q topic must be included in the AuthorizedResourceArns
parameter. Otherwise, the request will fail with InvalidParameterValueException
.
String workGroup
The workgroup that Amazon Athena uses.
String roleArn
Use the RoleArn
structure to override an account-wide role for a specific Athena data source. For
example, say an account administrator has turned off all Athena access with an account-wide role. The
administrator can then use RoleArn
to bypass the account-wide role and allow Athena access for the
single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena
access is still active.
String dataSetName
Dataset name.
Boolean show
The option to enable display of borders for visuals.
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.
String text
The text of a description for a 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.
ColumnDescription columnDescription
A description for a column.
String requestId
String requestId
The Amazon Web Services request ID for this request.
String awsAccountId
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
String namespace
The Amazon QuickSight namespace that you want to add customizations to.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace.
For example, you can add a default theme by setting AccountCustomization
to 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" }
.
List<E> tags
A list of the tags that you want to attach to this resource.
String arn
The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
String namespace
The namespace associated with the customization you're creating.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String edition
The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from
ENTERPRISE
or ENTERPRISE_AND_Q
.
If you choose ENTERPRISE_AND_Q
, the following parameters are required:
FirstName
LastName
EmailAddress
ContactNumber
String authenticationMethod
The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for
this parameter are IAM_AND_QUICKSIGHT
, IAM_ONLY
, and ACTIVE_DIRECTORY
.
If you choose ACTIVE_DIRECTORY
, provide an ActiveDirectoryName
and an
AdminGroup
associated with your Active Directory.
String awsAccountId
The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
String accountName
The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears
only when users sign in. You can't change AccountName
value after the Amazon QuickSight account is
created.
String notificationEmail
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
String activeDirectoryName
The name of your Active Directory. This field is required if ACTIVE_DIRECTORY
is the selected
authentication method of the new Amazon QuickSight account.
String realm
The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required
if ACTIVE_DIRECTORY
is the selected authentication method of the new Amazon QuickSight account.
String directoryId
The ID of the Active Directory that is associated with your Amazon QuickSight account.
List<E> adminGroup
The admin group associated with your Active Directory. This field is required if ACTIVE_DIRECTORY
is
the selected authentication method of the new Amazon QuickSight account. For more information about using Active
Directory in Amazon QuickSight, see Using Active Directory with
Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
List<E> authorGroup
The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
List<E> readerGroup
The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
String firstName
The first name of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String lastName
The last name of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String emailAddress
The email address of the author of the Amazon QuickSight account to use for future communications. This field is
required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
String contactNumber
A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This
field is required if ENTERPPRISE_AND_Q
is the selected edition of the new Amazon QuickSight account.
SignupResponse signupResponse
A SignupResponse
object that returns information about a newly created Amazon QuickSight account.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account where you are creating an analysis.
String analysisId
The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
String name
A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
Parameters parameters
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.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis. You can use the
Permissions
structure to grant permissions by providing a list of Identity and Access Management
(IAM) action information for each principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions
.
AnalysisSourceEntity sourceEntity
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.
String themeArn
The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
String arn
The ARN for the analysis.
String analysisId
The ID of the analysis.
String creationStatus
The status of the creation of the analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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
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.
List<E> permissions
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.
DashboardSourceEntity sourceEntity
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 a
SourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the
analysis to a template by using the
CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template.
The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon
QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets
for the placeholders listed in the original. The schema in each dataset must match its placeholder.
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
, Amazon 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
. This option is COLLAPSED
by default.
String themeArn
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 Amazon Web Services account where you create the dashboard.
String arn
The 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 Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String 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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
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.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
List<E> tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
DataSetUsageConfiguration dataSetUsageConfiguration
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 Amazon Web Services Region for each Amazon Web Services 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the data source.
String type
The type of the data source. To return a list of all data sources, use ListDataSources
.
Use AMAZON_ELASTICSEARCH
for Amazon OpenSearch Service.
DataSourceParameters dataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials Amazon 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 Amazon QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon 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 Amazon Web Services Region for each Amazon Web Services account.
String creationStatus
The status of creating the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The ID of the folder.
String memberId
The ID of the asset (the dashboard, analysis, or dataset).
String memberType
The type of the member, including DASHBOARD
, ANALYSIS
, and DATASET
.
Integer status
The HTTP status of the request.
FolderMember folderMember
Information about the member in the folder.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account where you want to create the folder.
String folderId
The ID of the folder.
String name
The name of the folder.
String folderType
The type of folder. By default, folderType
is SHARED
.
String parentFolderArn
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn
can be null. An empty parentFolderArn
creates a root-level folder.
List<E> permissions
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit Permissions
.
List<E> tags
Tags for the folder.
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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that you want the user to be a part of.
GroupMember groupMember
The group member.
String requestId
The Amazon Web Services 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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that you want the group to be a part of.
String awsAccountId
The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
String assignmentName
The name of the assignment, also called a rule. It must be unique within an Amazon Web Services 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 Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon 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 Amazon Web Services 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 Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
String requestId
The Amazon Web Services 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
String namespace
The name that you want to use to describe the new namespace.
String identityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT
.
List<E> tags
The tags that you want to associate with the namespace that you're creating.
String arn
The ARN of the Amazon QuickSight namespace you created.
String name
The name of the new namespace that you created.
String capacityRegion
The Amazon Web Services 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.
String creationStatus
The status of the creation of the namespace. This is an asynchronous process. A status of CREATED
means that your namespace is ready to use. If an error occurs, it indicates if the process is
retryable
or non-retryable
. In the case of a non-retryable error, refer to the error
message for follow-up tasks.
String identityStore
Specifies the type of your user identity directory. Currently, this supports users with an identity type of
QUICKSIGHT
.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String templateId
An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services 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 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: SourceTemplate
for a template or
SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For
SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the
ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and
any Amazon QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must
match its placeholder.
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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme for the new theme alias.
String themeId
An ID for the theme alias.
String aliasName
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.
Long themeVersionNumber
The version number of the theme.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account where you want to store the new theme.
String themeId
An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
String name
A display name for the theme.
String baseThemeId
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 ListThemes
or choose
Themes from within an analysis.
String versionDescription
A description of the first version of the theme that you're creating. Every time UpdateTheme
is
called, a new version is created. Each version of the theme has a description of the version in the
VersionDescription
field.
ThemeConfiguration configuration
The theme configuration, which contains the theme display properties.
List<E> permissions
A valid grouping of resource permissions to apply to the new theme.
List<E> tags
A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
String arn
The Amazon Resource Name (ARN) for the theme.
String versionArn
The Amazon Resource Name (ARN) for the new theme.
String themeId
The ID of the theme.
String creationStatus
The theme creation status.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String username
User name.
String password
Password.
List<E> alternateDataSourceParameters
A set of alternate data source parameters that you want to share for these credentials. The credentials are
applied in tandem with the data source parameters when you copy a data source by using a create or update
request. The API operation compares the DataSourceParameters
structure that's in the request with
the structures in the AlternateDataSourceParameters
allow list. If the structures are an exact
match, the request is allowed to use the new data source with the existing credentials. If the
AlternateDataSourceParameters
list is null, the DataSourceParameters
originally used
with these Credentials
is automatically allowed.
String dashboardId
Dashboard ID.
String arn
The Amazon Resource Name (ARN) of the resource.
String name
A display name for the dashboard.
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"
.
Valid values are "StringEquals"
and "StringLike"
.
If you set the operator value to "StringEquals"
, you need to provide an ownership related filter in
the "NAME"
field and the arn of the user or group whose folders you want to search in the
"Value"
field. For example,
"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
If you set the value to "StringLike"
, you need to provide the name of the folders you are searching
for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test"
. The
"StringLike"
operator only supports the NAME
value DASHBOARD_NAME
.
String name
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER"
.
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any dashboards with that ARN
listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are
considered.
QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any dashboards with that ARN listed as one
of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any dashboards with that ARN
listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any dashboards with that ARN listed
as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any dashboards with that
ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or
groups are not considered.
DASHBOARD_NAME
: Any dashboards whose names have a substring match to this value will be returned.
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 associated with this dashboard version.
Long versionNumber
Version number for this version of the dashboard.
String status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the resource.
String sourceEntityArn
Source entity ARN.
List<E> dataSetArns
The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
String description
Description.
String themeArn
The ARN of the theme associated with a version of the dashboard.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
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 dashboardId
The ID of the dashboard that has the visual that you want to embed. The DashboardId
can be found in
the IDs for developers
section of the Embed visual
pane of the visual's on-visual menu
of the Amazon QuickSight console. You can also get the DashboardId
with a
ListDashboards
API operation.
String sheetId
The ID of the sheet that the has visual that you want to embed. The SheetId
can be found in the
IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of
the Amazon QuickSight console.
String visualId
The ID of the visual that you want to embed. The VisualID
can be found in the
IDs for developers
section of the Embed visual
pane of the visual's on-visual menu of
the Amazon QuickSight console.
List<E> colors
The hexadecimal codes for the colors.
List<E> minMaxGradient
The minimum and maximum hexadecimal codes that describe a color gradient.
String emptyFillColor
The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
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
A value that 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.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The element you can use to define tags for row-level security.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
DataSetUsageConfiguration dataSetUsageConfiguration
The usage configuration to apply to child datasets that reference this dataset as a source.
String placeholder
Placeholder.
DataSetSchema dataSetSchema
Dataset schema.
List<E> columnGroupSchemaList
A structure containing the list of column group schemas.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals"
.
Valid values are "StringEquals"
and "StringLike"
.
If you set the operator value to "StringEquals"
, you need to provide an ownership related filter in
the "NAME"
field and the arn of the user or group whose datasets you want to search in the
"Value"
field. For example,
"Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1"
.
If you set the value to "StringLike"
, you need to provide the name of the datasets you are searching
for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test"
. The
"StringLike"
operator only supports the NAME
value DATASET_NAME
.
String name
The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER"
.
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any datasets with that ARN listed
as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered.
QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any datasets with that ARN listed as one of
the owners of the dataset are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any datasets with that ARN
listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any datasets with that ARN listed as
one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any datasets with that ARN
listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups
are not considered.
DATASET_NAME
: Any datasets whose names have a substring match to this value will be returned.
String value
The value of the named item, in this case QUICKSIGHT_OWNER
, that you want to use as a filter, for
example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
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
A value that indicates whether you want to import the data into SPICE.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the dataset.
Boolean rowLevelPermissionTagConfigurationApplied
Whether or not the row level permission tags are applied.
Boolean columnLevelPermissionRulesApplied
A value that indicates if the dataset has column level permission configured.
Boolean disableUseAsDirectQuerySource
An option that controls whether a child dataset of a direct query can use this dataset as a source.
Boolean disableUseAsImportedSource
An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a 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 Amazon Web Services Region for each Amazon Web Services 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.
List<E> alternateDataSourceParameters
A set of alternate data source parameters that you want to share for the credentials stored with this data
source. The credentials are applied in tandem with the data source parameters when you copy a data source by
using a create or update request. The API operation compares the DataSourceParameters
structure
that's in the request with the structures in the AlternateDataSourceParameters
allow list. If the
structures are an exact match, the request is allowed to use the credentials from this existing data source. If
the AlternateDataSourceParameters
list is null, the Credentials
originally used with
this DataSourceParameters
are automatically allowed.
VpcConnectionProperties vpcConnectionProperties
The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
DataSourceErrorInfo errorInfo
Error information from the last update or the creation of the data source.
String secretArn
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
CredentialPair credentialPair
Credential pair. For more information, see
CredentialPair
.
String copySourceArn
The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When
CopySourceArn
is not null, the credential pair from the data source in the ARN is used as the
credentials for the DataSourceCredentials
structure.
String secretArn
The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
AmazonElasticsearchParameters amazonElasticsearchParameters
The parameters for OpenSearch.
AthenaParameters athenaParameters
The parameters for Amazon Athena.
AuroraParameters auroraParameters
The parameters for Amazon Aurora MySQL.
AuroraPostgreSqlParameters auroraPostgreSqlParameters
The parameters for Amazon Aurora.
AwsIotAnalyticsParameters awsIotAnalyticsParameters
The parameters for IoT Analytics.
JiraParameters jiraParameters
The parameters for Jira.
MariaDbParameters mariaDbParameters
The parameters for MariaDB.
MySqlParameters mySqlParameters
The parameters for MySQL.
OracleParameters oracleParameters
The parameters for Oracle.
PostgreSqlParameters postgreSqlParameters
The parameters for PostgreSQL.
PrestoParameters prestoParameters
The parameters for Presto.
RdsParameters rdsParameters
The parameters for Amazon RDS.
RedshiftParameters redshiftParameters
The parameters for Amazon Redshift.
S3Parameters s3Parameters
The parameters for S3.
ServiceNowParameters serviceNowParameters
The parameters for ServiceNow.
SnowflakeParameters snowflakeParameters
The parameters for Snowflake.
SparkParameters sparkParameters
The parameters for Spark.
SqlServerParameters sqlServerParameters
The parameters for SQL Server.
TeradataParameters teradataParameters
The parameters for Teradata.
TwitterParameters twitterParameters
The parameters for Twitter.
AmazonOpenSearchParameters amazonOpenSearchParameters
The parameters for OpenSearch.
ExasolParameters exasolParameters
The parameters for Exasol.
DatabricksParameters databricksParameters
The required parameters that are needed to connect to a Databricks data source.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals"
.
Valid values are "StringEquals"
and "StringLike"
.
If you set the operator value to "StringEquals"
, you need to provide an ownership related filter in
the "NAME"
field and the arn of the user or group whose data sources you want to search in the
"Value"
field. For example,
"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
If you set the value to "StringLike"
, you need to provide the name of the data sources you are
searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test"
. The
"StringLike"
operator only supports the NAME
value DATASOURCE_NAME
.
String name
The name of the value that you want to use as a filter, for example,
"Name": "DIRECT_QUICKSIGHT_OWNER"
.
Valid values are defined as follows:
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any data sources with that
ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or
groups are not considered.
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any data sources with that ARN
listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any data sources with that ARN
listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not
considered.
DATASOURCE_NAME
: Any data sources whose names have a substring match to the provided value are
returned.
String value
The value of the named item, for example DIRECT_QUICKSIGHT_OWNER
, that you want to use as a filter,
for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
String arn
The arn of the datasource.
String dataSourceId
The unique ID of the data source.
String name
The name of the data source.
String type
The type of the data source.
Date createdTime
The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
Date lastUpdatedTime
The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
String awsAccountId
The Amazon Web Services account ID of the account that you want to delete.
String awsAccountId
The ID of the Amazon Web Services account where you want to delete an analysis.
String analysisId
The ID of the analysis that you're deleting.
Long recoveryWindowInDays
A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't
use this parameter with the ForceDeleteWithoutRecovery
option in the same API call. The default
value is 30.
Boolean forceDeleteWithoutRecovery
This option defaults to the value NoForceDeleteWithoutRecovery
. To immediately delete the analysis,
add the ForceDeleteWithoutRecovery
option. You can't restore an analysis after it's deleted.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the deleted analysis.
String analysisId
The ID of the deleted analysis.
Date deletionTime
The date and time that the analysis is scheduled to be deleted.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The Folder ID.
String memberId
The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.
String memberType
The type of the member, including DASHBOARD
, ANALYSIS
, and DATASET
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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to remove a user from.
String groupName
The name of the group that you want to delete.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to delete.
String awsAccountId
The ID of the Amazon Web Services 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. 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
$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 template you want to delete.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 aliasName
The name for the theme alias.
String arn
The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String themeId
An ID for the theme associated with the deletion.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're deleting.
String themeId
An ID for the theme that you want to delete.
Long versionNumber
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 DeleteTheme
to delete
all versions of the theme.
String principalId
The principal ID of the user.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String awsAccountId
The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
String namespace
The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
Boolean resolved
The Resolved
flag works with the other parameters to determine which view of Amazon QuickSight
customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight
uses to identify which customizations to apply to the console. Omit this flag, or set it to
no-resolved
, to reveal customizations that are configured at different levels.
String arn
The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you're describing.
String namespace
The Amazon QuickSight namespace that you're describing.
AccountCustomization accountCustomization
The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the settings that you want to list.
AccountSettings accountSettings
The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription.
In the QuickSight console, the Amazon 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 Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID associated with your Amazon QuickSight account.
AccountInfo accountInfo
A structure that contains the following elements:
Your Amazon QuickSight account name.
The edition of Amazon QuickSight that your account is using.
The notification email address that is associated with the Amazon QuickSight account.
The authentication type of the Amazon QuickSight account.
The status of the Amazon QuickSight account's subscription.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
String analysisId
The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
String analysisId
The ID of the analysis whose permissions you're describing.
String analysisArn
The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
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 Amazon Web Services request ID for this operation.
LinkSharingConfiguration linkSharingConfiguration
A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
List<E> permissions
A list of resource permissions on the dataset.
String requestId
The Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
List<E> permissions
A list of resource permissions on the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
DataSource dataSource
The information on the data source.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
Integer status
The HTTP status of the request.
String folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) for the folder.
List<E> permissions
Information about the permissions on the folder.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) of the folder.
List<E> permissions
Information about the permissions for the folder.
String requestId
The Amazon Web Services request ID for this operation.
String memberName
The user name of the user that you want to search for.
String groupName
The name of the group that you want to search.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace that includes the group you are searching within.
GroupMember groupMember
String requestId
The Amazon Web Services 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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want described.
IAMPolicyAssignment iAMPolicyAssignment
Information describing the IAM policy assignment.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
Map<K,V> ipRestrictionRuleMap
A map that describes the IP rules with CIDR range and description.
Boolean enabled
A value that specifies whether IP rules are turned on.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
NamespaceInfoV2 namespace
The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon
Web Services Region, creation status, and identity store. DescribeNamespace
also 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.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services 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.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String themeId
The ID for the theme.
String themeArn
The Amazon Resource Name (ARN) of the theme.
List<E> permissions
A list of resource permissions set on the theme.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're describing.
String themeId
The ID for the theme.
Long versionNumber
The version number for the version to describe. If a VersionNumber
parameter value isn't provided,
the latest version of the theme is described.
String aliasName
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 $LATEST
in
the AliasName
parameter. The keyword $PUBLISHED
doesn't apply to themes.
String userName
The name of the user that you want to describe.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace. Currently, you should set this to default
.
String requestId
The Amazon Web Services 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 folderId
The ID of the folder.
String arn
The Amazon Resource Name (ARN) for the folder.
String name
A display name for the folder.
String folderType
The type of folder it is.
List<E> folderPath
An array of ancestor ARN strings for the folder.
Date createdTime
The time that the folder was created.
Date lastUpdatedTime
The time that the folder was last updated.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StringEquals"
.
Valid values are "StringEquals"
and "StringLike"
.
If you set the operator value to "StringEquals"
, you need to provide an ownership related filter in
the "NAME"
field and the arn of the user or group whose folders you want to search in the
"Value"
field. For example,
"Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1"
.
If you set the value to "StringLike"
, you need to provide the name of the folders you are searching
for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test"
. The
"StringLike"
operator only supports the NAME
value FOLDER_NAME
.
String name
The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER"
.
Valid values are defined as follows:
QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed
as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are
considered.
QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as one of
the owners of the folders are returned. Implicit permissions from folders or groups are considered.
DIRECT_QUICKSIGHT_SOLE_OWNER
: Provide an ARN of a user or group, and any folders with that ARN
listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not
considered.
DIRECT_QUICKSIGHT_OWNER
: Provide an ARN of a user or group, and any folders with that ARN listed as
one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered.
DIRECT_QUICKSIGHT_VIEWER_OR_OWNER
: Provide an ARN of a user or group, and any folders with that ARN
listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups
are not considered.
FOLDER_NAME
: Any folders whose names have a substring match to this value will be returned.
PARENT_FOLDER_ARN
: Provide an ARN of a folder, and any folders that are directly under that parent
folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the
account are returned.
String value
The value of the named item (in this example, PARENT_FOLDER_ARN
), that you want to use as a filter.
For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId"
.
String arn
The Amazon Resource Name (ARN) of the folder.
String folderId
The ID of the folder.
String name
The display name of the folder.
String folderType
The type of folder.
Date createdTime
The time that the folder was created.
Date lastUpdatedTime
The time that the folder was last updated.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
String namespace
The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon
QuickSight custom namespace, set this to default
.
List<E> sessionTags
The session tags used for row-level security. Before you use this parameter, make sure that you have configured
the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration
parameter so that session
tags can be used to provide row-level security.
These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
List<E> authorizedResourceArns
The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during
the lifetime of the session. If you choose Dashboard
embedding experience, pass the list of
dashboard ARNs in the account that you want the user to be able to view. Currently, you can pass up to 25
dashboard ARNs in each API call.
AnonymousUserEmbeddingExperienceConfiguration experienceConfiguration
The configuration of the experience that you are embedding.
List<E> allowedDomains
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example,
https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
String embedUrl
The embed URL for the dashboard.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String anonymousUserArn
The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
String userArn
The Amazon Resource Name for the registered user.
RegisteredUserEmbeddingExperienceConfiguration experienceConfiguration
The experience you are embedding. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, or the entire Amazon QuickSight console.
List<E> allowedDomains
The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call.
To include all subdomains under a specific domain to the allow list, use *
. For example,
https://*.sapp.amazon.com
includes all subdomains under https://sapp.amazon.com
.
String awsAccountId
The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
String dashboardId
The ID for the dashboard, also added to the Identity and Access Management (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.
Boolean statePersistenceEnabled
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 (Amazon 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 Amazon QuickSight, not in a browser cookie. If this is set
to FALSE, the state of the user session is not persisted. The default is FALSE
.
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.
Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
String namespace
The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom
namespace, set Namespace = default
.
List<E> additionalDashboardIds
A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the
IdentityType
parameter must be set to ANONYMOUS
because other identity types
authenticate as Amazon 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.
String embedUrl
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_code
value that enables one (and only one)
sign-on to a user session that is valid for 10 hours.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
String entryPoint
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
- where DashboardId
is the actual ID key from the
Amazon QuickSight console URL of the dashboard
/analyses/AnalysisId
- where AnalysisId
is the actual ID key from the Amazon
QuickSight console URL of the analysis
Long sessionLifetimeInMinutes
How many minutes the session is valid. The session lifetime must be 15-600 minutes.
String userArn
The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
identity 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
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.
String embedUrl
A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This
URL is valid for 5 minutes. The API operation provides the URL with an auth_code
value that enables
one (and only one) sign-on to a user session that is valid for 10 hours.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String operator
The comparison operator that you want to use as a filter, for example "Operator": "StartsWith"
.
Currently, the only supported operator is StartsWith
.
String name
The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME"
. Currently,
the only supported name is GROUP_NAME
.
String value
The value of the named item, in this case GROUP_NAME
, that you want to use as a filter.
Boolean show
This Boolean value controls whether to display a gutter space between sheet tiles.
String awsAccountId
The Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String siteBaseUrl
The base URL of the Jira site.
String leftOperand
The operand on the left side of a join.
String rightOperand
The operand on the right side of a join.
JoinKeyProperties leftJoinKeyProperties
Join key properties of the left operand.
JoinKeyProperties rightJoinKeyProperties
Join key properties of the right operand.
String type
The type of join that it is.
String onClause
The join instructions provided in the ON
clause of a join.
Boolean uniqueKey
A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
List<E> analysisSummaryList
Metadata describing each of the analyses that are listed.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 in your Amazon Web Services account. 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services request ID for this operation.
List<E> dataSetSummaries
The list of dataset summaries.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
String folderId
The ID of the folder.
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.
Integer status
The HTTP status of the request.
List<E> folderMemberList
A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
List<E> folderSummaryList
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services 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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want a list of users from.
List<E> groupMemberList
The list of the members of the group.
String nextToken
A pagination token that can be used in a subsequent request.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 that you want a list of groups from.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services account ID.
Integer maxResults
The maximum number of results to be returned per request.
String awsAccountId
The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
String nextToken
A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the
response body of a previous ListNameSpaces
API call if there is more data that can be returned. To
receive the data, make another ListNamespaces
API call with the returned token to retrieve the next
page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces
API call with an
expired token, you will receive a HTTP 400 InvalidNextTokenException
error.
Integer maxResults
The maximum number of results to return.
List<E> namespaces
The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
String nextToken
A unique pagination token that can be used in a subsequent request. Receiving NextToken
in your
response inticates that there is more data that can be returned. To receive the data, make another
ListNamespaces
API call with the returned token to retrieve the next page of data. Each token is
valid for 24 hours. If you try to make a ListNamespaces
API call with an expired token, you will
receive a HTTP 400 InvalidNextTokenException
error.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the 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 Amazon Web Services 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 Amazon Web Services request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The ID of the Amazon Web Services account that contains the templates 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> 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
String themeId
The ID for the theme.
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> themeAliasList
A structure containing the list of the theme's aliases.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String nextToken
The token for the next set of results, or null if there are no more results.
String awsAccountId
The ID of the Amazon Web Services account that contains the themes 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.
String type
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 Amazon QuickSight.
List<E> themeSummaryList
Information about the themes 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the themes that you're listing.
String themeId
The ID for the theme.
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> themeVersionSummaryList
A structure containing a list of all the versions of the specified theme.
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 Amazon Web Services request ID for this operation.
String userName
The Amazon QuickSight user name that you want to list group memberships for.
String awsAccountId
The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services 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 Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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.
String dataSetArn
The Amazon Resource Number (ARN) of the parent dataset.
Boolean show
This Boolean value controls whether to display sheet margins.
String name
The name of the error.
String arn
The namespace ARN.
String capacityRegion
The namespace Amazon Web Services Region.
String creationStatus
The creation status of a namespace that is not yet completely created.
String identityStore
The identity store used for the namespace.
NamespaceError namespaceError
An error that occurred when the namespace was created.
List<E> stringParameters
The parameters that have a data type of string.
List<E> integerParameters
The parameters that have a data type of integer.
List<E> decimalParameters
The parameters that have a data type of decimal.
List<E> dateTimeParameters
The parameters that have a data type of date-time.
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 Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String initialDashboardId
The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it.
If the user does not have permission to view this dashboard, they see a permissions error message.
DashboardVisualId initialDashboardVisualId
The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual.
The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the
AuthorizedResourceArns
parameter. Otherwise, the request will fail with
InvalidParameterValueException
.
RegisteredUserDashboardEmbeddingConfiguration dashboard
The configuration details for providing a dashboard embedding experience.
RegisteredUserQuickSightConsoleEmbeddingConfiguration quickSightConsole
The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide.
Use
GenerateEmbedUrlForRegisteredUser
where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and
dashboards. The users who accesses an embedded Amazon QuickSight console needs to 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 the
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:
For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
RegisteredUserQSearchBarEmbeddingConfiguration qSearchBar
The configuration details for embedding the Q search bar.
For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
RegisteredUserDashboardVisualEmbeddingConfiguration dashboardVisual
The type of embedding experience. In this case, Amazon QuickSight visuals.
String initialTopicId
The ID of the Q topic that you want to make the starting topic in the Q search bar. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open.
If you don't specify an initial topic, a list of all shared topics is shown in the Q bar for your readers. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the available ones in the list.
String initialPath
The initial URL path for the Amazon QuickSight console. InitialPath
is required.
The entry point URL is constrained to the following paths:
/start
/start/analyses
/start/dashboards
/start/favorites
/dashboards/DashboardId
. DashboardId is the actual ID key from the Amazon QuickSight console
URL of the dashboard.
/analyses/AnalysisId
. AnalysisId is the actual ID key from the Amazon QuickSight console URL
of the analysis.
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 CLI Reference.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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.
String customPermissionsName
(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
UpdateUser
instead.
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 Amazon QuickSight console. Then, you use the
RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
String externalLoginFederationProviderType
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated 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 the
COGNITO
provider 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 choosing CUSTOM_OIDC
type, use
the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
String customFederationProviderUrl
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon
QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
String externalLoginId
The identity ID for a user in the external login provider.
User user
The user's 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String dataSourceArn
The Amazon Resource Name (ARN) for the data source.
String catalog
The catalog associated with a table.
String schema
The schema name. This name applies to certain relational database engines.
String name
The name of the relational table.
List<E> inputColumns
The column schema of the table.
String principal
The Amazon Resource Name (ARN) of the principal. This can be one of the following:
The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
List<E> actions
The IAM action to grant or revoke permissions on.
String namespace
The namespace associated with the dataset that contains permissions for RLS.
String arn
The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
String permissionPolicy
The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS
is included
for backward compatibility only.
String formatVersion
The user or group rules associated with the dataset that contains permissions for RLS.
By default, FormatVersion
is VERSION_1
. When FormatVersion
is
VERSION_1
, UserName
and GroupName
are required. When
FormatVersion
is VERSION_2
, UserARN
and GroupARN
are
required, and Namespace
must not exist.
String status
The status of the row-level security permission dataset. If enabled, the status is ENABLED
. If
disabled, the status is DISABLED
.
String tagKey
The unique key for a tag.
String columnName
The column name that a tag key is assigned to.
String tagMultiValueDelimiter
A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
String matchAllValue
A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
ManifestFileLocation manifestFileLocation
Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
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 an S3 data source.
For files that aren't JSON, only STRING
data types are supported in input columns.
String awsAccountId
The ID of the Amazon Web Services account that contains the analyses that you're searching for.
List<E> filters
The structure for the search filters that you want to apply to your search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to return.
List<E> analysisSummaryList
Metadata describing the analyses that you searched for.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
List<E> filters
The filters to apply to the search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dataSetSummaries
A DataSetSummaries
object that returns a summary of a dataset.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
List<E> filters
The filters to apply to the search.
String nextToken
A pagination token that can be used in a subsequent request.
Integer maxResults
The maximum number of results to be returned per request.
List<E> dataSourceSummaries
A DataSourceSummaries
object that returns a summary of a data source.
String nextToken
A pagination token that can be used in a subsequent request.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder.
List<E> filters
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" } ]
.
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.
Integer status
The HTTP status of the request.
List<E> folderSummaryList
A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
String nextToken
The token for the next set of results, or null if there are no more results.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services 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 that you want to search.
List<E> filters
The structure for the search filters that you want to apply to your search.
List<E> groupList
A list of groups in a specified namespace that match the filters you set in your SearchGroups
request.
String nextToken
A pagination token that can be used in a subsequent request.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String siteBaseUrl
URL of the base site.
String requestId
The Amazon Web Services request ID for this request.
String visibilityState
Visibility state.
TileStyle tile
The display options for tiles.
TileLayoutStyle tileLayout
The layout options for tiles.
Boolean iAMUser
A Boolean that is TRUE
if the Amazon QuickSight uses IAM as an authentication method.
String userLoginName
The user login name for your Amazon QuickSight account.
String accountName
The name of your Amazon QuickSight account.
String directoryType
The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are
SIMPLE_AD
, AD_CONNECTOR
, and MICROSOFT_AD
.
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 Amazon Web Services Region for each Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services 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 this template version.
Long versionNumber
The version number of the template version.
String status
The HTTP status of the request.
List<E> dataSetConfigurations
Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
String description
The description of the template.
String sourceEntityArn
The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
String themeArn
The ARN of the theme associated with this version of the template.
List<E> sheets
A list of the associated sheets with the unique identifier and name of each sheet.
String arn
The Amazon Resource Name (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 arn
The Amazon Resource Name (ARN) of the theme.
String name
The name that the user gives to the theme.
String themeId
The identifier that the user gives to the theme.
ThemeVersion version
Date createdTime
The date and time that the theme was created.
Date lastUpdatedTime
The date and time that the theme was last updated.
String type
The type of theme, based on how it was created. Valid values include: QUICKSIGHT
and
CUSTOM
.
DataColorPalette dataColorPalette
Color properties that apply to chart data colors.
UIColorPalette uIColorPalette
Color properties that apply to the UI and to charts, excluding the colors that apply to data.
SheetStyle sheet
Display options related to sheets.
String arn
The Amazon Resource Name (ARN) of the resource.
String name
the display name for the theme.
String themeId
The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
Long latestVersionNumber
The latest version number for the theme.
Date createdTime
The date and time that this theme was created.
Date lastUpdatedTime
The last date and time that this theme was updated.
Long versionNumber
The version number of the theme.
String arn
The Amazon Resource Name (ARN) of the resource.
String description
The description of the theme.
String baseThemeId
The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
Date createdTime
The date and time that this theme version was created.
ThemeConfiguration configuration
The theme configuration, which contains all the theme display properties.
List<E> errors
Errors associated with the theme.
String status
The status of the theme version.
Long versionNumber
The version number of the theme version.
String arn
The Amazon Resource Name (ARN) of the theme version.
String description
The description of the theme version.
Date createdTime
The date and time that this theme version was created.
String status
The status of the theme version.
String requestId
The Amazon Web Services request ID for this request.
GutterStyle gutter
The gutter settings that apply between tiles.
MarginStyle margin
The margin settings that apply around the outside edge of sheets.
BorderStyle border
The border around a tile.
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.
UntagColumnOperation untagColumnOperation
String primaryForeground
The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.
String primaryBackground
The background color that applies to visuals and other high emphasis UI.
String secondaryForeground
The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
String secondaryBackground
The background color that applies to the sheet background and sheet controls.
String accent
This color is that applies to selected states and buttons.
String accentForeground
The foreground color that applies to any text or other elements that appear over the accent color.
String danger
The color that applies to error messages.
String dangerForeground
The foreground color that applies to any text or other elements that appear over the error color.
String warning
This color that applies to warning and informational messages.
String warningForeground
The foreground color that applies to any text or other elements that appear over the warning color.
String success
The color that applies to success messages, for example the check mark for a successful download.
String successForeground
The foreground color that applies to any text or other elements that appear over the success color.
String dimension
The color that applies to the names of fields that are identified as dimensions.
String dimensionForeground
The foreground color that applies to any text or other elements that appear over the dimension color.
String measure
The color that applies to the names of fields that are identified as measures.
String measureForeground
The foreground color that applies to any text or other elements that appear over the measure color.
String requestId
The Amazon Web Services request ID for this request.
String requestId
The Amazon Web Services request ID for this request.
String awsAccountId
The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
String namespace
The namespace that you want to update Amazon QuickSight customizations for.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
String arn
The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.
String awsAccountId
The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
String namespace
The namespace associated with the customization that you're updating.
AccountCustomization accountCustomization
The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
String defaultNamespace
The default namespace for this Amazon Web Services account. Currently, the default is default
.
Identity and Access Management (IAM) users that register for the first time with Amazon QuickSight provide an
email address that becomes associated with the default namespace.
String notificationEmail
The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
Boolean terminationProtectionEnabled
A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True
value doesn't allow the account to be deleted and results in an error message if a user tries to make a
DeleteAccountSubscription
request. A False
value will allow the account to be deleted.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
String analysisId
The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
List<E> grantPermissions
A structure that describes the permissions to add and the principal to add them to.
List<E> revokePermissions
A structure that describes the permissions to remove and the principal to remove them from.
String analysisArn
The Amazon Resource Name (ARN) of the analysis that you updated.
String analysisId
The ID of the analysis that you updated permissions for.
List<E> permissions
A structure that describes the principals and the resource-level permissions on an analysis.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the analysis that you're updating.
String analysisId
The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
String name
A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
Parameters parameters
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.
AnalysisSourceEntity sourceEntity
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.
String themeArn
The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
String arn
The ARN of the analysis that you're updating.
String analysisId
The ID of the analysis.
String updateStatus
The update status of the last update that was made to the analysis.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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.
List<E> grantLinkPermissions
Grants link permissions to all users in a defined namespace.
List<E> revokeLinkPermissions
Revokes link permissions from all users in a defined namespace.
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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
LinkSharingConfiguration linkSharingConfiguration
Updates the permissions of a shared link to an Amazon QuickSight dashboard.
String awsAccountId
The ID of the Amazon Web Services 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 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 a
SourceTemplate
entity. If you need to update a dashboard from an analysis, first convert the
analysis to a template by using the
CreateTemplate
API operation. For SourceTemplate
, specify the Amazon Resource Name (ARN) of the source template.
The SourceTemplate
ARN can contain any Amazon Web Services account and any Amazon
QuickSight-supported Amazon Web Services Region.
Use the DataSetReferences
entity within SourceTemplate
to list the replacement datasets
for the placeholders listed in the original. The schema in each dataset must match its placeholder.
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.
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
, Amazon 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
. This option is COLLAPSED
by default.
String themeArn
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 Amazon Web Services account where you create the dashboard.
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 Amazon Web Services request ID for this operation.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSetId
The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String 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 Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Map<K,V> fieldFolders
The folder that contains fields and nested subfolders for your dataset.
RowLevelPermissionDataSet rowLevelPermissionDataSet
The row-level security configuration for the data you want to create.
RowLevelPermissionTagConfiguration rowLevelPermissionTagConfiguration
The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
List<E> columnLevelPermissionRules
A set of one or more definitions of a
ColumnLevelPermissionRule
.
DataSetUsageConfiguration dataSetUsageConfiguration
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 Amazon Web Services Region for each Amazon Web Services 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services 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 Amazon Web Services Region for each Amazon Web Services account.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The Amazon Web Services account ID.
String dataSourceId
The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
String name
A display name for the data source.
DataSourceParameters dataSourceParameters
The parameters that Amazon QuickSight uses to connect to your underlying source.
DataSourceCredentials credentials
The credentials that Amazon 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 Amazon QuickSight to use a VPC connection when connecting to your underlying source.
SslProperties sslProperties
Secure Socket Layer (SSL) properties that apply when Amazon 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 Amazon Web Services Region for each Amazon Web Services account.
String updateStatus
The update status of the data source's last update.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID for the Amazon Web Services account that contains the folder to update.
String folderId
The ID of the folder.
List<E> grantPermissions
The permissions that you want to grant on a resource.
List<E> revokePermissions
The permissions that you want to revoke from a resource.
Integer status
The HTTP status of the request.
String arn
The Amazon Resource Name (ARN) of the folder.
String folderId
The ID of the folder.
List<E> permissions
Information about the permissions for the folder.
String requestId
The Amazon Web Services request ID for this operation.
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 Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
String namespace
The namespace of the group that you want to update.
String awsAccountId
The ID of the Amazon Web Services account that contains the IAM policy assignment.
String assignmentName
The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services 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 Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon QuickSight users, groups, or both that you want to assign the policy to.
String assignmentName
The name of the assignment or rule.
String assignmentId
The ID of the assignment.
String policyArn
The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.
Map<K,V> identities
The Amazon 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the IP rules.
Map<K,V> ipRestrictionRuleMap
A map that describes the updated IP rules with CIDR ranges and descriptions.
Boolean enabled
A value that specifies whether IP rules are turned on.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services 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 Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the template that you're updating.
String templateId
The ID for the template.
TemplateSourceEntity sourceEntity
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: SourceTemplate
for a template or
SourceAnalysis
for an analysis. Both of these require an Amazon Resource Name (ARN). For
SourceTemplate
, specify the ARN of the source template. For SourceAnalysis
, specify the
ARN of the source analysis. The SourceTemplate
ARN can contain any Amazon Web Services account and
any Amazon QuickSight-supported Amazon Web Services Region;.
Use the DataSetReferences
entity within SourceTemplate
or SourceAnalysis
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must
match its placeholder.
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 Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme alias that you're updating.
String themeId
The ID for the theme.
String aliasName
The name of the theme alias that you want to update.
Long themeVersionNumber
The version number of the theme that the alias should reference.
ThemeAlias themeAlias
Information about the theme alias.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme.
String themeId
The ID for the theme.
List<E> grantPermissions
A list of resource permissions to be granted for the theme.
List<E> revokePermissions
A list of resource permissions to be revoked from the theme.
String themeId
The ID for the theme.
String themeArn
The Amazon Resource Name (ARN) of the theme.
List<E> permissions
The resulting list of resource permissions for the theme.
String requestId
The Amazon Web Services request ID for this operation.
Integer status
The HTTP status of the request.
String awsAccountId
The ID of the Amazon Web Services account that contains the theme that you're updating.
String themeId
The ID for the theme.
String name
The name for the theme.
String baseThemeId
The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
String versionDescription
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 in
VersionDescription
.
ThemeConfiguration configuration
The theme configuration, which contains the theme display properties.
String themeId
The ID for the theme.
String arn
The Amazon Resource Name (ARN) for the theme.
String versionArn
The Amazon Resource Name (ARN) for the new version of the theme.
String creationStatus
The creation status of the theme.
Integer status
The HTTP status of the request.
String requestId
The Amazon Web Services request ID for this operation.
String userName
The Amazon QuickSight user name that you want to update.
String awsAccountId
The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services 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 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 Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
String customPermissionsName
(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 Amazon QuickSight console. Then, you use the
RegisterUser
API operation to assign the named set of permissions to a Amazon QuickSight user.
Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).
This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
Boolean unapplyCustomPermissions
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.
String externalLoginFederationProviderType
The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated 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 the
COGNITO
provider 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 choosing CUSTOM_OIDC
type, use
the CustomFederationProviderUrl
parameter to provide the custom OIDC provider URL.
NONE
: This clears all the previously saved external login information for a user. Use the
DescribeUser
API operation to check the external login information.
String customFederationProviderUrl
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon
QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when
ExternalLoginFederationProviderType
parameter is set to CUSTOM_OIDC
.
String externalLoginId
The identity ID for a user in the external login provider.
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. This value is required if you are registering a user that will be managed in Amazon
QuickSight. In the output, the value for UserName
is N/A
when the value for
IdentityType
is IAM
and the corresponding IAM user is deleted.
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 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 customPermissionsName
The custom permissions profile associated with this user.
String externalLoginFederationProviderType
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider.
String externalLoginFederationProviderUrl
The URL of the external login provider.
String externalLoginId
The identity ID for the user in the external login provider.
String vpcConnectionArn
The Amazon Resource Name (ARN) for the VPC connection.
Copyright © 2022. All rights reserved.