@datafire/amazonaws_quicksight

Client library for Amazon QuickSight

Installation and Usage

npm install --save @datafire/amazonaws_quicksight

let amazonaws_quicksight = require('@datafire/amazonaws_quicksight').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Amazon QuickSight API Reference Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight.

Actions

CreateNamespace

amazonaws_quicksight.CreateNamespace({
  "AwsAccountId": "",
  "Namespace": "",
  "IdentityStore": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • IdentityStore required string (values: QUICKSIGHT): Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
  • Namespace required string: The name that you want to use to describe the new namespace.
  • Tags array: The tags that you want to associate with the namespace that you're creating.
    • items Tag

Output

• output CreateNamespaceResponse

ListAnalyses

amazonaws_quicksight.ListAnalyses({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListAnalysesResponse

DeleteAnalysis

amazonaws_quicksight.DeleteAnalysis({
  "AwsAccountId": "",
  "AnalysisId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string
  • recovery-window-in-days integer
  • force-delete-without-recovery boolean

Output

• output DeleteAnalysisResponse

DescribeAnalysis

amazonaws_quicksight.DescribeAnalysis({
  "AwsAccountId": "",
  "AnalysisId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string

Output

• output DescribeAnalysisResponse

CreateAnalysis

amazonaws_quicksight.CreateAnalysis({
  "AwsAccountId": "",
  "AnalysisId": "",
  "Name": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string
  • Name required string: A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console.
  • Parameters object: A list of QuickSight parameters and the list's override values.
    • DateTimeParameters
      • items DateTimeParameter
    • DecimalParameters
      • items DecimalParameter
    • IntegerParameters
      • items IntegerParameter
    • StringParameters
      • items StringParameter
  • Permissions array: 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 AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). To specify no permissions, omit Permissions.
    • items ResourcePermission
  • SourceEntity required object: The source entity of an analysis.
    • SourceTemplate
      • Arn required
      • DataSetReferences required
        • items DataSetReference
  • Tags array: Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
    • items Tag
  • ThemeArn string: The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

Output

• output CreateAnalysisResponse

UpdateAnalysis

amazonaws_quicksight.UpdateAnalysis({
  "AwsAccountId": "",
  "AnalysisId": "",
  "Name": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string
  • Name required string: A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.
  • Parameters object: A list of QuickSight parameters and the list's override values.
    • DateTimeParameters
      • items DateTimeParameter
    • DecimalParameters
      • items DecimalParameter
    • IntegerParameters
      • items IntegerParameter
    • StringParameters
      • items StringParameter
  • SourceEntity required object: The source entity of an analysis.
    • SourceTemplate
      • Arn required
      • DataSetReferences required
        • items DataSetReference
  • ThemeArn string: The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.

Output

• output UpdateAnalysisResponse

DescribeAnalysisPermissions

amazonaws_quicksight.DescribeAnalysisPermissions({
  "AwsAccountId": "",
  "AnalysisId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string

Output

• output DescribeAnalysisPermissionsResponse

UpdateAnalysisPermissions

amazonaws_quicksight.UpdateAnalysisPermissions({
  "AwsAccountId": "",
  "AnalysisId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string
  • GrantPermissions array: A structure that describes the permissions to add and the principal to add them to.
    • items ResourcePermission
  • RevokePermissions array: A structure that describes the permissions to remove and the principal to remove them from.
    • items ResourcePermission

Output

• output UpdateAnalysisPermissionsResponse

DeleteAccountCustomization

amazonaws_quicksight.DeleteAccountCustomization({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • namespace string

Output

• output DeleteAccountCustomizationResponse

DescribeAccountCustomization

amazonaws_quicksight.DescribeAccountCustomization({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • namespace string
  • resolved boolean

Output

• output DescribeAccountCustomizationResponse

CreateAccountCustomization

amazonaws_quicksight.CreateAccountCustomization({
  "AwsAccountId": "",
  "AccountCustomization": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • namespace string
  • AccountCustomization required object: The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
    • DefaultTheme
  • Tags array: A list of the tags that you want to attach to this resource.
    • items Tag

Output

• output CreateAccountCustomizationResponse

UpdateAccountCustomization

amazonaws_quicksight.UpdateAccountCustomization({
  "AwsAccountId": "",
  "AccountCustomization": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • namespace string
  • AccountCustomization required object: The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
    • DefaultTheme

Output

• output UpdateAccountCustomizationResponse

ListDashboards

amazonaws_quicksight.ListDashboards({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListDashboardsResponse

DeleteDashboard

amazonaws_quicksight.DeleteDashboard({
  "AwsAccountId": "",
  "DashboardId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • version-number integer

Output

• output DeleteDashboardResponse

DescribeDashboard

amazonaws_quicksight.DescribeDashboard({
  "AwsAccountId": "",
  "DashboardId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • version-number integer
  • alias-name string

Output

• output DescribeDashboardResponse

CreateDashboard

amazonaws_quicksight.CreateDashboard({
  "AwsAccountId": "",
  "DashboardId": "",
  "Name": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • DashboardPublishOptions object: Dashboard publish options.
    • AdHocFilteringOption
      • AvailabilityStatus
    • ExportToCSVOption
      • AvailabilityStatus
    • SheetControlsOption
      • VisibilityState
  • Name required string: The display name of the dashboard.
  • Parameters object: A list of QuickSight parameters and the list's override values.
    • DateTimeParameters
      • items DateTimeParameter
    • DecimalParameters
      • items DecimalParameter
    • IntegerParameters
      • items IntegerParameter
    • StringParameters
      • items StringParameter
  • Permissions array: 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.
    • items ResourcePermission
  • SourceEntity required object: Dashboard source entity.
    • SourceTemplate
      • Arn required
      • DataSetReferences required
        • items DataSetReference
  • Tags array: Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
    • items Tag
  • ThemeArn string: The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
  • VersionDescription string: A description for the first version of the dashboard being created.

Output

• output CreateDashboardResponse

UpdateDashboard

amazonaws_quicksight.UpdateDashboard({
  "AwsAccountId": "",
  "DashboardId": "",
  "Name": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • DashboardPublishOptions object: Dashboard publish options.
    • AdHocFilteringOption
      • AvailabilityStatus
    • ExportToCSVOption
      • AvailabilityStatus
    • SheetControlsOption
      • VisibilityState
  • Name required string: The display name of the dashboard.
  • Parameters object: A list of QuickSight parameters and the list's override values.
    • DateTimeParameters
      • items DateTimeParameter
    • DecimalParameters
      • items DecimalParameter
    • IntegerParameters
      • items IntegerParameter
    • StringParameters
      • items StringParameter
  • SourceEntity required object: Dashboard source entity.
    • SourceTemplate
      • Arn required
      • DataSetReferences required
        • items DataSetReference
  • ThemeArn string: The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.
  • VersionDescription string: A description for the first version of the dashboard being created.

Output

• output UpdateDashboardResponse

GetDashboardEmbedUrl

amazonaws_quicksight.GetDashboardEmbedUrl({
  "AwsAccountId": "",
  "DashboardId": "",
  "creds-type": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • creds-type required string
  • session-lifetime integer
  • undo-redo-disabled boolean
  • reset-disabled boolean
  • state-persistence-enabled boolean
  • user-arn string
  • namespace string
  • additional-dashboard-ids array

Output

• output GetDashboardEmbedUrlResponse

DescribeDashboardPermissions

amazonaws_quicksight.DescribeDashboardPermissions({
  "AwsAccountId": "",
  "DashboardId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string

Output

• output DescribeDashboardPermissionsResponse

UpdateDashboardPermissions

amazonaws_quicksight.UpdateDashboardPermissions({
  "AwsAccountId": "",
  "DashboardId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • GrantPermissions array: The permissions that you want to grant on this resource.
    • items ResourcePermission
  • RevokePermissions array: The permissions that you want to revoke from this resource.
    • items ResourcePermission

Output

• output UpdateDashboardPermissionsResponse

ListDashboardVersions

amazonaws_quicksight.ListDashboardVersions({
  "AwsAccountId": "",
  "DashboardId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListDashboardVersionsResponse

UpdateDashboardPublishedVersion

amazonaws_quicksight.UpdateDashboardPublishedVersion({
  "AwsAccountId": "",
  "DashboardId": "",
  "VersionNumber": 0
}, context)

Input

• input object
  • AwsAccountId required string
  • DashboardId required string
  • VersionNumber required integer

Output

• output UpdateDashboardPublishedVersionResponse

ListDataSets

amazonaws_quicksight.ListDataSets({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListDataSetsResponse

CreateDataSet

amazonaws_quicksight.CreateDataSet({
  "AwsAccountId": "",
  "DataSetId": "",
  "Name": "",
  "PhysicalTableMap": {},
  "ImportMode": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ColumnGroups array: Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
    • items ColumnGroup
  • ColumnLevelPermissionRules array: A set of one or more definitions of a ColumnLevelPermissionRule .
    • items ColumnLevelPermissionRule
  • DataSetId required string: An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
  • ImportMode required string (values: SPICE, DIRECT_QUERY): Indicates whether you want to import the data into SPICE.
  • LogicalTableMap object: Configures the combination and transformation of the data from the physical tables.
  • Name required string: The display name for the dataset.
  • Permissions array: A list of resource permissions on the dataset.
    • items ResourcePermission
  • PhysicalTableMap required object: Declares the physical tables that are available in the underlying data sources.
  • RowLevelPermissionDataSet object: The row-level security configuration for the dataset.
    • Arn
    • Namespace
    • PermissionPolicy
  • Tags array: Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
    • items Tag

Output

• output CreateDataSetResponse

DeleteDataSet

amazonaws_quicksight.DeleteDataSet({
  "AwsAccountId": "",
  "DataSetId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string

Output

• output DeleteDataSetResponse

DescribeDataSet

amazonaws_quicksight.DescribeDataSet({
  "AwsAccountId": "",
  "DataSetId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string

Output

• output DescribeDataSetResponse

UpdateDataSet

amazonaws_quicksight.UpdateDataSet({
  "AwsAccountId": "",
  "DataSetId": "",
  "Name": "",
  "PhysicalTableMap": {},
  "ImportMode": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string
  • ColumnGroups array: Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
    • items ColumnGroup
  • ColumnLevelPermissionRules array: A set of one or more definitions of a ColumnLevelPermissionRule .
    • items ColumnLevelPermissionRule
  • ImportMode required string (values: SPICE, DIRECT_QUERY): Indicates whether you want to import the data into SPICE.
  • LogicalTableMap object: Configures the combination and transformation of the data from the physical tables.
  • Name required string: The display name for the dataset.
  • PhysicalTableMap required object: Declares the physical tables that are available in the underlying data sources.
  • RowLevelPermissionDataSet object: The row-level security configuration for the dataset.
    • Arn
    • Namespace
    • PermissionPolicy

Output

• output UpdateDataSetResponse

ListIngestions

amazonaws_quicksight.ListIngestions({
  "DataSetId": "",
  "AwsAccountId": ""
}, context)

Input

• input object
  • DataSetId required string
  • next-token string
  • AwsAccountId required string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListIngestionsResponse

CancelIngestion

amazonaws_quicksight.CancelIngestion({
  "AwsAccountId": "",
  "DataSetId": "",
  "IngestionId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string
  • IngestionId required string

Output

• output CancelIngestionResponse

DescribeIngestion

amazonaws_quicksight.DescribeIngestion({
  "AwsAccountId": "",
  "DataSetId": "",
  "IngestionId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string
  • IngestionId required string

Output

• output DescribeIngestionResponse

CreateIngestion

amazonaws_quicksight.CreateIngestion({
  "DataSetId": "",
  "IngestionId": "",
  "AwsAccountId": ""
}, context)

Input

• input object
  • DataSetId required string
  • IngestionId required string
  • AwsAccountId required string

Output

• output CreateIngestionResponse

DescribeDataSetPermissions

amazonaws_quicksight.DescribeDataSetPermissions({
  "AwsAccountId": "",
  "DataSetId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string

Output

• output DescribeDataSetPermissionsResponse

UpdateDataSetPermissions

amazonaws_quicksight.UpdateDataSetPermissions({
  "AwsAccountId": "",
  "DataSetId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSetId required string
  • GrantPermissions array: The resource permissions that you want to grant to the dataset.
    • items ResourcePermission
  • RevokePermissions array: The resource permissions that you want to revoke from the dataset.
    • items ResourcePermission

Output

• output UpdateDataSetPermissionsResponse

ListDataSources

amazonaws_quicksight.ListDataSources({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListDataSourcesResponse

CreateDataSource

amazonaws_quicksight.CreateDataSource({
  "AwsAccountId": "",
  "DataSourceId": "",
  "Name": "",
  "Type": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Credentials object: Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
    • CopySourceArn
    • CredentialPair
      • AlternateDataSourceParameters
        • items DataSourceParameters
      • Password required
      • Username required
  • DataSourceId required string: An ID for the data source. This ID is unique per AWS Region for each AWS account.
  • DataSourceParameters object: The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
    • AmazonElasticsearchParameters
      • Domain required
    • AthenaParameters
      • WorkGroup
    • AuroraParameters
      • Database required
      • Host required
      • Port required
    • AuroraPostgreSqlParameters
      • Database required
      • Host required
      • Port required
    • AwsIotAnalyticsParameters
      • DataSetName required
    • JiraParameters
      • SiteBaseUrl required
    • MariaDbParameters
      • Database required
      • Host required
      • Port required
    • MySqlParameters
      • Database required
      • Host required
      • Port required
    • OracleParameters
      • Database required
      • Host required
      • Port required
    • PostgreSqlParameters
      • Database required
      • Host required
      • Port required
    • PrestoParameters
      • Catalog required
      • Host required
      • Port required
    • RdsParameters
      • Database required
      • InstanceId required
    • RedshiftParameters
      • ClusterId
      • Database required
      • Host
      • Port
    • S3Parameters
      • ManifestFileLocation required
        • Bucket required
        • Key required
    • ServiceNowParameters
      • SiteBaseUrl required
    • SnowflakeParameters
      • Database required
      • Host required
      • Warehouse required
    • SparkParameters
      • Host required
      • Port required
    • SqlServerParameters
      • Database required
      • Host required
      • Port required
    • TeradataParameters
      • Database required
      • Host required
      • Port required
    • TwitterParameters
      • MaxRows required
      • Query required
  • Name required string: A display name for the data source.
  • Permissions array: A list of resource permissions on the data source.
    • items ResourcePermission
  • SslProperties object: Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
    • DisableSsl
  • Tags array: Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
    • items Tag
  • Type required string (values: ADOBE_ANALYTICS, AMAZON_ELASTICSEARCH, ATHENA, AURORA, AURORA_POSTGRESQL, AWS_IOT_ANALYTICS, GITHUB, JIRA, MARIADB, MYSQL, ORACLE, POSTGRESQL, PRESTO, REDSHIFT, S3, SALESFORCE, SERVICENOW, SNOWFLAKE, SPARK, SQLSERVER, TERADATA, TWITTER, TIMESTREAM): The type of the data source. Currently, the supported types for this operation are: ATHENA, AURORA, AURORA_POSTGRESQL, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA. Use ListDataSources to return a list of all data sources.
  • VpcConnectionProperties object: VPC connection properties.
    • VpcConnectionArn

Output

• output CreateDataSourceResponse

DeleteDataSource

amazonaws_quicksight.DeleteDataSource({
  "AwsAccountId": "",
  "DataSourceId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSourceId required string

Output

• output DeleteDataSourceResponse

DescribeDataSource

amazonaws_quicksight.DescribeDataSource({
  "AwsAccountId": "",
  "DataSourceId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSourceId required string

Output

• output DescribeDataSourceResponse

UpdateDataSource

amazonaws_quicksight.UpdateDataSource({
  "AwsAccountId": "",
  "DataSourceId": "",
  "Name": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSourceId required string
  • Credentials object: Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
    • CopySourceArn
    • CredentialPair
      • AlternateDataSourceParameters
        • items DataSourceParameters
      • Password required
      • Username required
  • DataSourceParameters object: The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
    • AmazonElasticsearchParameters
      • Domain required
    • AthenaParameters
      • WorkGroup
    • AuroraParameters
      • Database required
      • Host required
      • Port required
    • AuroraPostgreSqlParameters
      • Database required
      • Host required
      • Port required
    • AwsIotAnalyticsParameters
      • DataSetName required
    • JiraParameters
      • SiteBaseUrl required
    • MariaDbParameters
      • Database required
      • Host required
      • Port required
    • MySqlParameters
      • Database required
      • Host required
      • Port required
    • OracleParameters
      • Database required
      • Host required
      • Port required
    • PostgreSqlParameters
      • Database required
      • Host required
      • Port required
    • PrestoParameters
      • Catalog required
      • Host required
      • Port required
    • RdsParameters
      • Database required
      • InstanceId required
    • RedshiftParameters
      • ClusterId
      • Database required
      • Host
      • Port
    • S3Parameters
      • ManifestFileLocation required
        • Bucket required
        • Key required
    • ServiceNowParameters
      • SiteBaseUrl required
    • SnowflakeParameters
      • Database required
      • Host required
      • Warehouse required
    • SparkParameters
      • Host required
      • Port required
    • SqlServerParameters
      • Database required
      • Host required
      • Port required
    • TeradataParameters
      • Database required
      • Host required
      • Port required
    • TwitterParameters
      • MaxRows required
      • Query required
  • Name required string: A display name for the data source.
  • SslProperties object: Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying data source.
    • DisableSsl
  • VpcConnectionProperties object: VPC connection properties.
    • VpcConnectionArn

Output

• output UpdateDataSourceResponse

DescribeDataSourcePermissions

amazonaws_quicksight.DescribeDataSourcePermissions({
  "AwsAccountId": "",
  "DataSourceId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSourceId required string

Output

• output DescribeDataSourcePermissionsResponse

UpdateDataSourcePermissions

amazonaws_quicksight.UpdateDataSourcePermissions({
  "AwsAccountId": "",
  "DataSourceId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DataSourceId required string
  • GrantPermissions array: A list of resource permissions that you want to grant on the data source.
    • items ResourcePermission
  • RevokePermissions array: A list of resource permissions that you want to revoke on the data source.
    • items ResourcePermission

Output

• output UpdateDataSourcePermissionsResponse

DeleteIAMPolicyAssignment

amazonaws_quicksight.DeleteIAMPolicyAssignment({
  "AwsAccountId": "",
  "AssignmentName": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AssignmentName required string
  • Namespace required string

Output

• output DeleteIAMPolicyAssignmentResponse

ListNamespaces

amazonaws_quicksight.ListNamespaces({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListNamespacesResponse

DeleteNamespace

amazonaws_quicksight.DeleteNamespace({
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string

Output

• output DeleteNamespaceResponse

DescribeNamespace

amazonaws_quicksight.DescribeNamespace({
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string

Output

• output DescribeNamespaceResponse

ListGroups

amazonaws_quicksight.ListGroups({
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • Namespace required string

Output

• output ListGroupsResponse

CreateGroup

amazonaws_quicksight.CreateGroup({
  "AwsAccountId": "",
  "Namespace": "",
  "GroupName": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string
  • Description string: A description for the group that you want to create.
  • GroupName required string: A name for the group that you want to create.

Output

• output CreateGroupResponse

DeleteGroup

amazonaws_quicksight.DeleteGroup({
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • GroupName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DeleteGroupResponse

DescribeGroup

amazonaws_quicksight.DescribeGroup({
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • GroupName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DescribeGroupResponse

UpdateGroup

amazonaws_quicksight.UpdateGroup({
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • GroupName required string
  • AwsAccountId required string
  • Namespace required string
  • Description string: The description for the group that you want to update.

Output

• output UpdateGroupResponse

ListGroupMemberships

amazonaws_quicksight.ListGroupMemberships({
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • GroupName required string
  • next-token string
  • max-results integer
  • AwsAccountId required string
  • Namespace required string

Output

• output ListGroupMembershipsResponse

DeleteGroupMembership

amazonaws_quicksight.DeleteGroupMembership({
  "MemberName": "",
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • MemberName required string
  • GroupName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DeleteGroupMembershipResponse

CreateGroupMembership

amazonaws_quicksight.CreateGroupMembership({
  "MemberName": "",
  "GroupName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • MemberName required string
  • GroupName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output CreateGroupMembershipResponse

ListIAMPolicyAssignments

amazonaws_quicksight.ListIAMPolicyAssignments({
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string
  • next-token string
  • max-results integer
  • AssignmentStatus string (values: ENABLED, DRAFT, DISABLED): The status of the assignments.

Output

• output ListIAMPolicyAssignmentsResponse

CreateIAMPolicyAssignment

amazonaws_quicksight.CreateIAMPolicyAssignment({
  "AwsAccountId": "",
  "Namespace": "",
  "AssignmentName": "",
  "AssignmentStatus": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string
  • AssignmentName required string: The name of the assignment, also called a rule. It must be unique within an AWS account.
  • AssignmentStatus required string (values: ENABLED, DRAFT, DISABLED): The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • Identities object: The QuickSight users, groups, or both that you want to assign the policy to.
  • PolicyArn string: The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

Output

• output CreateIAMPolicyAssignmentResponse

DescribeIAMPolicyAssignment

amazonaws_quicksight.DescribeIAMPolicyAssignment({
  "AwsAccountId": "",
  "AssignmentName": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AssignmentName required string
  • Namespace required string

Output

• output DescribeIAMPolicyAssignmentResponse

UpdateIAMPolicyAssignment

amazonaws_quicksight.UpdateIAMPolicyAssignment({
  "AwsAccountId": "",
  "AssignmentName": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AssignmentName required string
  • Namespace required string
  • AssignmentStatus string (values: ENABLED, DRAFT, DISABLED): The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  • Identities object: The QuickSight users, groups, or both that you want to assign the policy to.
  • PolicyArn string: The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.

Output

• output UpdateIAMPolicyAssignmentResponse

DeleteUserByPrincipalId

amazonaws_quicksight.DeleteUserByPrincipalId({
  "PrincipalId": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • PrincipalId required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DeleteUserByPrincipalIdResponse

ListUsers

amazonaws_quicksight.ListUsers({
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • Namespace required string

Output

• output ListUsersResponse

RegisterUser

amazonaws_quicksight.RegisterUser({
  "AwsAccountId": "",
  "Namespace": "",
  "IdentityType": "",
  "Email": "",
  "UserRole": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • Namespace required string
  • CustomPermissionsName string: (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use 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 QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader). This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
  • Email required string: The email address of the user that you want to register.
  • IamArn string: The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  • IdentityType required string (values: IAM, QUICKSIGHT): 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.
  • SessionName string: You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the AWS CLI Reference.
  • UserName string: The Amazon QuickSight user name that you want to create for the user you are registering.
  • UserRole required string (values: ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER): 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.

Output

• output RegisterUserResponse

DeleteUser

amazonaws_quicksight.DeleteUser({
  "UserName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • UserName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DeleteUserResponse

DescribeUser

amazonaws_quicksight.DescribeUser({
  "UserName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • UserName required string
  • AwsAccountId required string
  • Namespace required string

Output

• output DescribeUserResponse

UpdateUser

amazonaws_quicksight.UpdateUser({
  "UserName": "",
  "AwsAccountId": "",
  "Namespace": "",
  "Email": "",
  "Role": ""
}, context)

Input

• input object
  • UserName required string
  • AwsAccountId required string
  • Namespace required string
  • CustomPermissionsName string: (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a QuickSight user. QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader). This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).
  • Email required string: The email address of the user that you want to update.
  • Role required string (values: ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER): The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.
  • UnapplyCustomPermissions boolean: A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Output

• output UpdateUserResponse

ListUserGroups

amazonaws_quicksight.ListUserGroups({
  "UserName": "",
  "AwsAccountId": "",
  "Namespace": ""
}, context)

Input

• input object
  • UserName required string
  • AwsAccountId required string
  • Namespace required string
  • next-token string
  • max-results integer

Output

• output ListUserGroupsResponse

ListIAMPolicyAssignmentsForUser

amazonaws_quicksight.ListIAMPolicyAssignmentsForUser({
  "AwsAccountId": "",
  "UserName": "",
  "Namespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • UserName required string
  • next-token string
  • max-results integer
  • Namespace required string

Output

• output ListIAMPolicyAssignmentsForUserResponse

RestoreAnalysis

amazonaws_quicksight.RestoreAnalysis({
  "AwsAccountId": "",
  "AnalysisId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • AnalysisId required string

Output

• output RestoreAnalysisResponse

SearchAnalyses

amazonaws_quicksight.SearchAnalyses({
  "AwsAccountId": "",
  "Filters": []
}, context)

Input

• input object
  • AwsAccountId required string
  • MaxResults string
  • NextToken string
  • Filters required array: The structure for the search filters that you want to apply to your search.
    • items AnalysisSearchFilter
  • MaxResults integer: The maximum number of results to return.
  • NextToken string: A pagination token that can be used in a subsequent request.

Output

• output SearchAnalysesResponse

SearchDashboards

amazonaws_quicksight.SearchDashboards({
  "AwsAccountId": "",
  "Filters": []
}, context)

Input

• input object
  • AwsAccountId required string
  • MaxResults string
  • NextToken string
  • Filters required array: 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" } ]
    • items DashboardSearchFilter
  • MaxResults integer: The maximum number of results to be returned per request.
  • NextToken string: The token for the next set of results, or null if there are no more results.

Output

• output SearchDashboardsResponse

GetSessionEmbedUrl

amazonaws_quicksight.GetSessionEmbedUrl({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • entry-point string
  • session-lifetime integer
  • user-arn string

Output

• output GetSessionEmbedUrlResponse

DescribeAccountSettings

amazonaws_quicksight.DescribeAccountSettings({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string

Output

• output DescribeAccountSettingsResponse

UpdateAccountSettings

amazonaws_quicksight.UpdateAccountSettings({
  "AwsAccountId": "",
  "DefaultNamespace": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • DefaultNamespace required string: The default namespace for this AWS account. Currently, the default is default. AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.
  • NotificationEmail string: The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.

Output

• output UpdateAccountSettingsResponse

ListTemplates

amazonaws_quicksight.ListTemplates({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-result integer
  • MaxResults string
  • NextToken string

Output

• output ListTemplatesResponse

DeleteTemplate

amazonaws_quicksight.DeleteTemplate({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • version-number integer

Output

• output DeleteTemplateResponse

DescribeTemplate

amazonaws_quicksight.DescribeTemplate({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • version-number integer
  • alias-name string

Output

• output DescribeTemplateResponse

CreateTemplate

amazonaws_quicksight.CreateTemplate({
  "AwsAccountId": "",
  "TemplateId": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • Name string: A display name for the template.
  • Permissions array: A list of resource permissions to be set on the template.
    • items ResourcePermission
  • SourceEntity required object: The source entity of the template.
    • SourceAnalysis
      • Arn required
      • DataSetReferences required
        • items DataSetReference
    • SourceTemplate
      • Arn required
  • Tags array: Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
    • items Tag
  • VersionDescription string: 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.

Output

• output CreateTemplateResponse

UpdateTemplate

amazonaws_quicksight.UpdateTemplate({
  "AwsAccountId": "",
  "TemplateId": "",
  "SourceEntity": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • Name string: The name for the template.
  • SourceEntity required object: The source entity of the template.
    • SourceAnalysis
      • Arn required
      • DataSetReferences required
        • items DataSetReference
    • SourceTemplate
      • Arn required
  • VersionDescription string: A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.

Output

• output UpdateTemplateResponse

ListTemplateAliases

amazonaws_quicksight.ListTemplateAliases({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • next-token string
  • max-result integer
  • MaxResults string
  • NextToken string

Output

• output ListTemplateAliasesResponse

DeleteTemplateAlias

amazonaws_quicksight.DeleteTemplateAlias({
  "AwsAccountId": "",
  "TemplateId": "",
  "AliasName": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • AliasName required string

Output

• output DeleteTemplateAliasResponse

DescribeTemplateAlias

amazonaws_quicksight.DescribeTemplateAlias({
  "AwsAccountId": "",
  "TemplateId": "",
  "AliasName": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • AliasName required string

Output

• output DescribeTemplateAliasResponse

CreateTemplateAlias

amazonaws_quicksight.CreateTemplateAlias({
  "AwsAccountId": "",
  "TemplateId": "",
  "AliasName": "",
  "TemplateVersionNumber": 0
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • AliasName required string
  • TemplateVersionNumber required integer: The version number of the template.

Output

• output CreateTemplateAliasResponse

UpdateTemplateAlias

amazonaws_quicksight.UpdateTemplateAlias({
  "AwsAccountId": "",
  "TemplateId": "",
  "AliasName": "",
  "TemplateVersionNumber": 0
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • AliasName required string
  • TemplateVersionNumber required integer: The version number of the template.

Output

• output UpdateTemplateAliasResponse

DescribeTemplatePermissions

amazonaws_quicksight.DescribeTemplatePermissions({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string

Output

• output DescribeTemplatePermissionsResponse

UpdateTemplatePermissions

amazonaws_quicksight.UpdateTemplatePermissions({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • GrantPermissions array: A list of resource permissions to be granted on the template.
    • items ResourcePermission
  • RevokePermissions array: A list of resource permissions to be revoked from the template.
    • items ResourcePermission

Output

• output UpdateTemplatePermissionsResponse

ListTemplateVersions

amazonaws_quicksight.ListTemplateVersions({
  "AwsAccountId": "",
  "TemplateId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • TemplateId required string
  • next-token string
  • max-results integer
  • MaxResults string
  • NextToken string

Output

• output ListTemplateVersionsResponse

ListThemes

amazonaws_quicksight.ListThemes({
  "AwsAccountId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • next-token string
  • max-results integer
  • type string

Output

• output ListThemesResponse

DeleteTheme

amazonaws_quicksight.DeleteTheme({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • version-number integer

Output

• output DeleteThemeResponse

DescribeTheme

amazonaws_quicksight.DescribeTheme({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • version-number integer
  • alias-name string

Output

• output DescribeThemeResponse

CreateTheme

amazonaws_quicksight.CreateTheme({
  "AwsAccountId": "",
  "ThemeId": "",
  "Name": "",
  "BaseThemeId": "",
  "Configuration": {}
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • BaseThemeId required string: The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.
  • Configuration required object: The theme configuration. This configuration contains all of the display properties for a theme.
    • DataColorPalette
      • Colors
        • items HexColor
      • EmptyFillColor
      • MinMaxGradient
        • items HexColor
    • Sheet
      • Tile
        • Border
          • Show
      • TileLayout
        • Gutter
          • Show
        • Margin
          • Show
    • UIColorPalette
      • Accent
      • AccentForeground
      • Danger
      • DangerForeground
      • Dimension
      • DimensionForeground
      • Measure
      • MeasureForeground
      • PrimaryBackground
      • PrimaryForeground
      • SecondaryBackground
      • SecondaryForeground
      • Success
      • SuccessForeground
      • Warning
      • WarningForeground
  • Name required string: A display name for the theme.
  • Permissions array: A valid grouping of resource permissions to apply to the new theme.
    • items ResourcePermission
  • Tags array: A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
    • items Tag
  • VersionDescription string: 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.

Output

• output CreateThemeResponse

UpdateTheme

amazonaws_quicksight.UpdateTheme({
  "AwsAccountId": "",
  "ThemeId": "",
  "BaseThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • BaseThemeId required string: The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.
  • Configuration object: The theme configuration. This configuration contains all of the display properties for a theme.
    • DataColorPalette
      • Colors
        • items HexColor
      • EmptyFillColor
      • MinMaxGradient
        • items HexColor
    • Sheet
      • Tile
        • Border
          • Show
      • TileLayout
        • Gutter
          • Show
        • Margin
          • Show
    • UIColorPalette
      • Accent
      • AccentForeground
      • Danger
      • DangerForeground
      • Dimension
      • DimensionForeground
      • Measure
      • MeasureForeground
      • PrimaryBackground
      • PrimaryForeground
      • SecondaryBackground
      • SecondaryForeground
      • Success
      • SuccessForeground
      • Warning
      • WarningForeground
  • Name string: The name for the theme.
  • VersionDescription string: A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

Output

• output UpdateThemeResponse

ListThemeAliases

amazonaws_quicksight.ListThemeAliases({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • next-token string
  • max-result integer

Output

• output ListThemeAliasesResponse

DeleteThemeAlias

amazonaws_quicksight.DeleteThemeAlias({
  "AwsAccountId": "",
  "ThemeId": "",
  "AliasName": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • AliasName required string

Output

• output DeleteThemeAliasResponse

DescribeThemeAlias

amazonaws_quicksight.DescribeThemeAlias({
  "AwsAccountId": "",
  "ThemeId": "",
  "AliasName": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • AliasName required string

Output

• output DescribeThemeAliasResponse

CreateThemeAlias

amazonaws_quicksight.CreateThemeAlias({
  "AwsAccountId": "",
  "ThemeId": "",
  "AliasName": "",
  "ThemeVersionNumber": 0
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • AliasName required string
  • ThemeVersionNumber required integer: The version number of the theme.

Output

• output CreateThemeAliasResponse

UpdateThemeAlias

amazonaws_quicksight.UpdateThemeAlias({
  "AwsAccountId": "",
  "ThemeId": "",
  "AliasName": "",
  "ThemeVersionNumber": 0
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • AliasName required string
  • ThemeVersionNumber required integer: The version number of the theme that the alias should reference.

Output

• output UpdateThemeAliasResponse

DescribeThemePermissions

amazonaws_quicksight.DescribeThemePermissions({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string

Output

• output DescribeThemePermissionsResponse

UpdateThemePermissions

amazonaws_quicksight.UpdateThemePermissions({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • GrantPermissions array: A list of resource permissions to be granted for the theme.
    • items ResourcePermission
  • RevokePermissions array: A list of resource permissions to be revoked from the theme.
    • items ResourcePermission

Output

• output UpdateThemePermissionsResponse

ListThemeVersions

amazonaws_quicksight.ListThemeVersions({
  "AwsAccountId": "",
  "ThemeId": ""
}, context)

Input

• input object
  • AwsAccountId required string
  • ThemeId required string
  • next-token string
  • max-results integer

Output

• output ListThemeVersionsResponse

ListTagsForResource

amazonaws_quicksight.ListTagsForResource({
  "ResourceArn": ""
}, context)

Input

• input `object