python-botocore/botocore/data/quicksight/2018-04-01/service-2.json
2022-12-12 08:14:19 -08:00

24281 lines
935 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
"version":"2.0",
"metadata":{
"apiVersion":"2018-04-01",
"endpointPrefix":"quicksight",
"jsonVersion":"1.0",
"protocol":"rest-json",
"serviceFullName":"Amazon QuickSight",
"serviceId":"QuickSight",
"signatureVersion":"v4",
"uid":"quicksight-2018-04-01"
},
"operations":{
"CancelIngestion":{
"name":"CancelIngestion",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}"
},
"input":{"shape":"CancelIngestionRequest"},
"output":{"shape":"CancelIngestionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Cancels an ongoing ingestion of data into SPICE.</p>"
},
"CreateAccountCustomization":{
"name":"CreateAccountCustomization",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/customizations"
},
"input":{"shape":"CreateAccountCustomizationRequest"},
"output":{"shape":"CreateAccountCustomizationResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code> API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html\">Customizing Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i> </p> <p>You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation.</p> <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html\">DescribeThemePermissions</a> </code> API operation. To share the theme, grant permissions by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html\">UpdateThemePermissions</a> </code> API operation. </p>"
},
"CreateAccountSubscription":{
"name":"CreateAccountSubscription",
"http":{
"method":"POST",
"requestUri":"/account/{AwsAccountId}"
},
"input":{"shape":"CreateAccountSubscriptionRequest"},
"output":{"shape":"CreateAccountSubscriptionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"PreconditionNotMetException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.</p> <p>The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. </p> <p>Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html\">Sign up for Amazon Web Services</a> in the <i>Amazon QuickSight User Guide</i>. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html\">IAM Policy Examples for Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>If your IAM policy includes both the <code>Subscribe</code> and <code>CreateAccountSubscription</code> actions, make sure that both actions are set to <code>Allow</code>. If either action is set to <code>Deny</code>, the <code>Deny</code> action prevails and your API call fails.</p> <p>You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role\">Passing IAM roles to Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html\">Setting default resource access to Amazon Web Services services</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CreateAnalysis":{
"name":"CreateAnalysis",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}"
},
"input":{"shape":"CreateAnalysisRequest"},
"output":{"shape":"CreateAnalysisResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates an analysis in Amazon QuickSight.</p>"
},
"CreateDashboard":{
"name":"CreateDashboard",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}"
},
"input":{"shape":"CreateDashboardRequest"},
"output":{"shape":"CreateDashboardResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a dashboard from a template. To first create a template, see the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a> </code> API operation.</p> <p>A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.</p>"
},
"CreateDataSet":{
"name":"CreateDataSet",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/data-sets"
},
"input":{"shape":"CreateDataSetRequest"},
"output":{"shape":"CreateDataSetResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>"
},
"CreateDataSource":{
"name":"CreateDataSource",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/data-sources"
},
"input":{"shape":"CreateDataSourceRequest"},
"output":{"shape":"CreateDataSourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceExistsException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a data source.</p>"
},
"CreateFolder":{
"name":"CreateFolder",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}"
},
"input":{"shape":"CreateFolderRequest"},
"output":{"shape":"CreateFolderResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"AccessDeniedException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates an empty shared folder.</p>"
},
"CreateFolderMembership":{
"name":"CreateFolderMembership",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}"
},
"input":{"shape":"CreateFolderMembershipRequest"},
"output":{"shape":"CreateFolderMembershipResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ResourceExistsException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Adds an asset, such as a dashboard, analysis, or dataset into a folder.</p>"
},
"CreateGroup":{
"name":"CreateGroup",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups"
},
"input":{"shape":"CreateGroupRequest"},
"output":{"shape":"CreateGroupResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Use the <code>CreateGroup</code> operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact AWS Support.</p> <p>The permissions resource is <code>arn:aws:quicksight:&lt;your-region&gt;:<i>&lt;relevant-aws-account-id&gt;</i>:group/default/<i>&lt;group-name&gt;</i> </code>.</p> <p>The response is a group object.</p>"
},
"CreateGroupMembership":{
"name":"CreateGroupMembership",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
},
"input":{"shape":"CreateGroupMembershipRequest"},
"output":{"shape":"CreateGroupMembershipResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Adds an Amazon QuickSight user to an Amazon QuickSight group. </p>"
},
"CreateIAMPolicyAssignment":{
"name":"CreateIAMPolicyAssignment",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/"
},
"input":{"shape":"CreateIAMPolicyAssignmentRequest"},
"output":{"shape":"CreateIAMPolicyAssignmentResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConcurrentUpdatingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.</p>"
},
"CreateIngestion":{
"name":"CreateIngestion",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}"
},
"input":{"shape":"CreateIngestionRequest"},
"output":{"shape":"CreateIngestionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time.</p> <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/\">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>"
},
"CreateNamespace":{
"name":"CreateNamespace",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}"
},
"input":{"shape":"CreateNamespaceRequest"},
"output":{"shape":"CreateNamespaceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"PreconditionNotMetException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p> <p>A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support. </p>"
},
"CreateTemplate":{
"name":"CreateTemplate",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}"
},
"input":{"shape":"CreateTemplateRequest"},
"output":{"shape":"CreateTemplateResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a template from an existing Amazon QuickSight analysis or template. You can use the resulting template to create a dashboard.</p> <p>A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.</p>"
},
"CreateTemplateAlias":{
"name":"CreateTemplateAlias",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}"
},
"input":{"shape":"CreateTemplateAliasRequest"},
"output":{"shape":"CreateTemplateAliasResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ResourceExistsException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a template alias for a template.</p>"
},
"CreateTheme":{
"name":"CreateTheme",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
},
"input":{"shape":"CreateThemeRequest"},
"output":{"shape":"CreateThemeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a theme.</p> <p>A <i>theme</i> is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CreateThemeAlias":{
"name":"CreateThemeAlias",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
},
"input":{"shape":"CreateThemeAliasRequest"},
"output":{"shape":"CreateThemeAliasResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Creates a theme alias for a theme.</p>"
},
"DeleteAccountCustomization":{
"name":"DeleteAccountCustomization",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/customizations"
},
"input":{"shape":"DeleteAccountCustomizationRequest"},
"output":{"shape":"DeleteAccountCustomizationResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.</p>"
},
"DeleteAccountSubscription":{
"name":"DeleteAccountSubscription",
"http":{
"method":"DELETE",
"requestUri":"/account/{AwsAccountId}"
},
"input":{"shape":"DeleteAccountSubscriptionRequest"},
"output":{"shape":"DeleteAccountSubscriptionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Use the <code>DeleteAccountSubscription</code> operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.</p>"
},
"DeleteAnalysis":{
"name":"DeleteAnalysis",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}"
},
"input":{"shape":"DeleteAnalysisRequest"},
"output":{"shape":"DeleteAnalysisResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently.</p> <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code> API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.</p> <p>An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.</p>"
},
"DeleteDashboard":{
"name":"DeleteDashboard",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}"
},
"input":{"shape":"DeleteDashboardRequest"},
"output":{"shape":"DeleteDashboardResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a dashboard.</p>"
},
"DeleteDataSet":{
"name":"DeleteDataSet",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}"
},
"input":{"shape":"DeleteDataSetRequest"},
"output":{"shape":"DeleteDataSetResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a dataset.</p>"
},
"DeleteDataSource":{
"name":"DeleteDataSource",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/data-sources/{DataSourceId}"
},
"input":{"shape":"DeleteDataSourceRequest"},
"output":{"shape":"DeleteDataSourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.</p>"
},
"DeleteFolder":{
"name":"DeleteFolder",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}"
},
"input":{"shape":"DeleteFolderRequest"},
"output":{"shape":"DeleteFolderResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"PreconditionNotMetException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes an empty folder.</p>"
},
"DeleteFolderMembership":{
"name":"DeleteFolderMembership",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}"
},
"input":{"shape":"DeleteFolderMembershipRequest"},
"output":{"shape":"DeleteFolderMembershipResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Removes an asset, such as a dashboard, analysis, or dataset, from a folder.</p>"
},
"DeleteGroup":{
"name":"DeleteGroup",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
},
"input":{"shape":"DeleteGroupRequest"},
"output":{"shape":"DeleteGroupResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Removes a user group from Amazon QuickSight. </p>"
},
"DeleteGroupMembership":{
"name":"DeleteGroupMembership",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
},
"input":{"shape":"DeleteGroupMembershipRequest"},
"output":{"shape":"DeleteGroupMembershipResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Removes a user from a group so that the user is no longer a member of the group.</p>"
},
"DeleteIAMPolicyAssignment":{
"name":"DeleteIAMPolicyAssignment",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}"
},
"input":{"shape":"DeleteIAMPolicyAssignmentRequest"},
"output":{"shape":"DeleteIAMPolicyAssignmentResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConcurrentUpdatingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes an existing IAM policy assignment.</p>"
},
"DeleteNamespace":{
"name":"DeleteNamespace",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}"
},
"input":{"shape":"DeleteNamespaceRequest"},
"output":{"shape":"DeleteNamespaceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset. </p>"
},
"DeleteTemplate":{
"name":"DeleteTemplate",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}"
},
"input":{"shape":"DeleteTemplateRequest"},
"output":{"shape":"DeleteTemplateResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a template.</p>"
},
"DeleteTemplateAlias":{
"name":"DeleteTemplateAlias",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}"
},
"input":{"shape":"DeleteTemplateAliasRequest"},
"output":{"shape":"DeleteTemplateAliasResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.</p>"
},
"DeleteTheme":{
"name":"DeleteTheme",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
},
"input":{"shape":"DeleteThemeRequest"},
"output":{"shape":"DeleteThemeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes a theme.</p>"
},
"DeleteThemeAlias":{
"name":"DeleteThemeAlias",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
},
"input":{"shape":"DeleteThemeAliasRequest"},
"output":{"shape":"DeleteThemeAliasResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.</p>"
},
"DeleteUser":{
"name":"DeleteUser",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
},
"input":{"shape":"DeleteUserRequest"},
"output":{"shape":"DeleteUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Deletes the Amazon QuickSight user that is associated with the identity of the Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. </p>"
},
"DeleteUserByPrincipalId":{
"name":"DeleteUserByPrincipalId",
"http":{
"method":"DELETE",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}"
},
"input":{"shape":"DeleteUserByPrincipalIdRequest"},
"output":{"shape":"DeleteUserByPrincipalIdResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Deletes a user identified by its principal ID. </p>"
},
"DescribeAccountCustomization":{
"name":"DescribeAccountCustomization",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/customizations"
},
"input":{"shape":"DescribeAccountCustomizationRequest"},
"output":{"shape":"DescribeAccountCustomizationResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the <code>Resolved</code> flag included. </p> <p>To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. </p> <ul> <li> <p> <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. </p> </li> <li> <p> <code>Amazon Web Services Region</code> - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. </p> <p>To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options:</p> <ul> <li> <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html\">command line options</a>. </p> </li> <li> <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html\">named profiles</a>. </p> </li> <li> <p>Run <code>aws configure</code> to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">Configuring the CLI</a>.</p> </li> </ul> </li> <li> <p> <code>Namespace</code> - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region.</p> </li> <li> <p> <code>Applied customizations</code> - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the <code>CreateAccountCustomization</code> command in each Amazon Web Services Region where you want to apply the same customizations. </p> </li> </ul>"
},
"DescribeAccountSettings":{
"name":"DescribeAccountSettings",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/settings"
},
"input":{"shape":"DescribeAccountSettingsRequest"},
"output":{"shape":"DescribeAccountSettingsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.</p>"
},
"DescribeAccountSubscription":{
"name":"DescribeAccountSubscription",
"http":{
"method":"GET",
"requestUri":"/account/{AwsAccountId}"
},
"input":{"shape":"DescribeAccountSubscriptionRequest"},
"output":{"shape":"DescribeAccountSubscriptionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.</p>"
},
"DescribeAnalysis":{
"name":"DescribeAnalysis",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}"
},
"input":{"shape":"DescribeAnalysisRequest"},
"output":{"shape":"DescribeAnalysisResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a summary of the metadata for an analysis.</p>"
},
"DescribeAnalysisDefinition":{
"name":"DescribeAnalysisDefinition",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition"
},
"input":{"shape":"DescribeAnalysisDefinitionRequest"},
"output":{"shape":"DescribeAnalysisDefinitionResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a detailed description of the definition of an analysis.</p> <note> <p>If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeAnalysis.html\"> <code>DescribeAnalysis</code> </a> instead. </p> </note>"
},
"DescribeAnalysisPermissions":{
"name":"DescribeAnalysisPermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions"
},
"input":{"shape":"DescribeAnalysisPermissionsRequest"},
"output":{"shape":"DescribeAnalysisPermissionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides the read and write permissions for an analysis.</p>"
},
"DescribeDashboard":{
"name":"DescribeDashboard",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}"
},
"input":{"shape":"DescribeDashboardRequest"},
"output":{"shape":"DescribeDashboardResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"AccessDeniedException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a summary for a dashboard.</p>"
},
"DescribeDashboardDefinition":{
"name":"DescribeDashboardDefinition",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition"
},
"input":{"shape":"DescribeDashboardDefinitionRequest"},
"output":{"shape":"DescribeDashboardDefinitionResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a detailed description of the definition of a dashboard.</p> <note> <p>If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeDashboard.html\"> <code>DescribeDashboard</code> </a> instead. </p> </note>"
},
"DescribeDashboardPermissions":{
"name":"DescribeDashboardPermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions"
},
"input":{"shape":"DescribeDashboardPermissionsRequest"},
"output":{"shape":"DescribeDashboardPermissionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes read and write permissions for a dashboard.</p>"
},
"DescribeDataSet":{
"name":"DescribeDataSet",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}"
},
"input":{"shape":"DescribeDataSetRequest"},
"output":{"shape":"DescribeDataSetResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.</p>"
},
"DescribeDataSetPermissions":{
"name":"DescribeDataSetPermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions"
},
"input":{"shape":"DescribeDataSetPermissionsRequest"},
"output":{"shape":"DescribeDataSetPermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>"
},
"DescribeDataSource":{
"name":"DescribeDataSource",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sources/{DataSourceId}"
},
"input":{"shape":"DescribeDataSourceRequest"},
"output":{"shape":"DescribeDataSourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a data source.</p>"
},
"DescribeDataSourcePermissions":{
"name":"DescribeDataSourcePermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions"
},
"input":{"shape":"DescribeDataSourcePermissionsRequest"},
"output":{"shape":"DescribeDataSourcePermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the resource permissions for a data source.</p>"
},
"DescribeFolder":{
"name":"DescribeFolder",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}"
},
"input":{"shape":"DescribeFolderRequest"},
"output":{"shape":"DescribeFolderResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a folder.</p>"
},
"DescribeFolderPermissions":{
"name":"DescribeFolderPermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/permissions"
},
"input":{"shape":"DescribeFolderPermissionsRequest"},
"output":{"shape":"DescribeFolderPermissionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes permissions for a folder.</p>"
},
"DescribeFolderResolvedPermissions":{
"name":"DescribeFolderResolvedPermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions"
},
"input":{"shape":"DescribeFolderResolvedPermissionsRequest"},
"output":{"shape":"DescribeFolderResolvedPermissionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.</p>"
},
"DescribeGroup":{
"name":"DescribeGroup",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
},
"input":{"shape":"DescribeGroupRequest"},
"output":{"shape":"DescribeGroupResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). </p>"
},
"DescribeGroupMembership":{
"name":"DescribeGroupMembership",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
},
"input":{"shape":"DescribeGroupMembershipRequest"},
"output":{"shape":"DescribeGroupMembershipResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Use the <code>DescribeGroupMembership</code> operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated <code>GroupMember</code> object is returned.</p>"
},
"DescribeIAMPolicyAssignment":{
"name":"DescribeIAMPolicyAssignment",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}"
},
"input":{"shape":"DescribeIAMPolicyAssignmentRequest"},
"output":{"shape":"DescribeIAMPolicyAssignmentResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes an existing IAM policy assignment, as specified by the assignment name.</p>"
},
"DescribeIngestion":{
"name":"DescribeIngestion",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}"
},
"input":{"shape":"DescribeIngestionRequest"},
"output":{"shape":"DescribeIngestionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a SPICE ingestion.</p>"
},
"DescribeIpRestriction":{
"name":"DescribeIpRestriction",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/ip-restriction"
},
"input":{"shape":"DescribeIpRestrictionRequest"},
"output":{"shape":"DescribeIpRestrictionResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a summary and status of IP rules.</p>"
},
"DescribeNamespace":{
"name":"DescribeNamespace",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}"
},
"input":{"shape":"DescribeNamespaceRequest"},
"output":{"shape":"DescribeNamespaceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Describes the current namespace.</p>"
},
"DescribeTemplate":{
"name":"DescribeTemplate",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}"
},
"input":{"shape":"DescribeTemplateRequest"},
"output":{"shape":"DescribeTemplateResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a template's metadata.</p>"
},
"DescribeTemplateAlias":{
"name":"DescribeTemplateAlias",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}"
},
"input":{"shape":"DescribeTemplateAliasRequest"},
"output":{"shape":"DescribeTemplateAliasResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the template alias for a template.</p>"
},
"DescribeTemplateDefinition":{
"name":"DescribeTemplateDefinition",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/definition"
},
"input":{"shape":"DescribeTemplateDefinitionRequest"},
"output":{"shape":"DescribeTemplateDefinitionResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Provides a detailed description of the definition of a template.</p> <note> <p>If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeTemplate.html\"> <code>DescribeTemplate</code> </a> instead. </p> </note>"
},
"DescribeTemplatePermissions":{
"name":"DescribeTemplatePermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/permissions"
},
"input":{"shape":"DescribeTemplatePermissionsRequest"},
"output":{"shape":"DescribeTemplatePermissionsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes read and write permissions on a template.</p>"
},
"DescribeTheme":{
"name":"DescribeTheme",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
},
"input":{"shape":"DescribeThemeRequest"},
"output":{"shape":"DescribeThemeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes a theme.</p>"
},
"DescribeThemeAlias":{
"name":"DescribeThemeAlias",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
},
"input":{"shape":"DescribeThemeAliasRequest"},
"output":{"shape":"DescribeThemeAliasResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the alias for a theme.</p>"
},
"DescribeThemePermissions":{
"name":"DescribeThemePermissions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions"
},
"input":{"shape":"DescribeThemePermissionsRequest"},
"output":{"shape":"DescribeThemePermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Describes the read and write permissions for a theme.</p>"
},
"DescribeUser":{
"name":"DescribeUser",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
},
"input":{"shape":"DescribeUserRequest"},
"output":{"shape":"DescribeUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Returns information about a user, given the user name. </p>"
},
"GenerateEmbedUrlForAnonymousUser":{
"name":"GenerateEmbedUrlForAnonymousUser",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/embed-url/anonymous-user"
},
"input":{"shape":"GenerateEmbedUrlForAnonymousUserRequest"},
"output":{"shape":"GenerateEmbedUrlForAnonymousUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"SessionLifetimeInMinutesInvalidException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"UnsupportedPricingPlanException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions.</p> <p>The following rules apply to the generated URL:</p> <ul> <li> <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p> </li> <li> <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForAnonymousUser.html#QS-GenerateEmbedUrlForAnonymousUser-request-SessionLifetimeInMinutes\">SessionLifetimeInMinutes</a> </code> parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p> </li> <li> <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>"
},
"GenerateEmbedUrlForRegisteredUser":{
"name":"GenerateEmbedUrlForRegisteredUser",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/embed-url/registered-user"
},
"input":{"shape":"GenerateEmbedUrlForRegisteredUserRequest"},
"output":{"shape":"GenerateEmbedUrlForRegisteredUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"QuickSightUserNotFoundException"},
{"shape":"ResourceNotFoundException"},
{"shape":"SessionLifetimeInMinutesInvalidException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"UnsupportedPricingPlanException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.</p> <p>The following rules apply to the generated URL:</p> <ul> <li> <p>It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again.</p> </li> <li> <p>The URL validity period should not be confused with the actual session lifetime that can be customized using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html#QS-GenerateEmbedUrlForRegisteredUser-request-SessionLifetimeInMinutes\">SessionLifetimeInMinutes</a> </code> parameter.</p> <p>The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours.</p> </li> <li> <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>"
},
"GetDashboardEmbedUrl":{
"name":"GetDashboardEmbedUrl",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url"
},
"input":{"shape":"GetDashboardEmbedUrlRequest"},
"output":{"shape":"GetDashboardEmbedUrlResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"DomainNotWhitelistedException"},
{"shape":"QuickSightUserNotFoundException"},
{"shape":"IdentityTypeNotSupportedException"},
{"shape":"SessionLifetimeInMinutesInvalidException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"UnsupportedPricingPlanException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. </p> <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the generated URL:</p> <ul> <li> <p>They must be used together.</p> </li> <li> <p>They can be used one time only.</p> </li> <li> <p>They are valid for 5 minutes after you run this command.</p> </li> <li> <p>You are charged only when the URL is used or there is interaction with Amazon QuickSight.</p> </li> <li> <p>The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional <code>SessionLifetimeInMinutes</code> parameter to customize session duration.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-deprecated.html\">Embedding Analytics Using GetDashboardEmbedUrl</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>"
},
"GetSessionEmbedUrl":{
"name":"GetSessionEmbedUrl",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/session-embed-url"
},
"input":{"shape":"GetSessionEmbedUrlRequest"},
"output":{"shape":"GetSessionEmbedUrlResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"QuickSightUserNotFoundException"},
{"shape":"SessionLifetimeInMinutesInvalidException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html\">UpdateUser</a> </code> API operation. Use <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html\">RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedding Analytics</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> </p> </li> </ul>"
},
"ListAnalyses":{
"name":"ListAnalyses",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/analyses"
},
"input":{"shape":"ListAnalysesRequest"},
"output":{"shape":"ListAnalysesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.</p>"
},
"ListDashboardVersions":{
"name":"ListDashboardVersions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions"
},
"input":{"shape":"ListDashboardVersionsRequest"},
"output":{"shape":"ListDashboardVersionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the versions of the dashboards in the Amazon QuickSight subscription.</p>"
},
"ListDashboards":{
"name":"ListDashboards",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/dashboards"
},
"input":{"shape":"ListDashboardsRequest"},
"output":{"shape":"ListDashboardsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists dashboards in an Amazon Web Services account.</p>"
},
"ListDataSets":{
"name":"ListDataSets",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets"
},
"input":{"shape":"ListDataSetsRequest"},
"output":{"shape":"ListDataSetsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>"
},
"ListDataSources":{
"name":"ListDataSources",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sources"
},
"input":{"shape":"ListDataSourcesRequest"},
"output":{"shape":"ListDataSourcesResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.</p>"
},
"ListFolderMembers":{
"name":"ListFolderMembers",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/members"
},
"input":{"shape":"ListFolderMembersRequest"},
"output":{"shape":"ListFolderMembersResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>List all assets (<code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>) in a folder. </p>"
},
"ListFolders":{
"name":"ListFolders",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/folders"
},
"input":{"shape":"ListFoldersRequest"},
"output":{"shape":"ListFoldersResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all folders in an account.</p>"
},
"ListGroupMemberships":{
"name":"ListGroupMemberships",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members"
},
"input":{"shape":"ListGroupMembershipsRequest"},
"output":{"shape":"ListGroupMembershipsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Lists member users in a group.</p>"
},
"ListGroups":{
"name":"ListGroups",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups"
},
"input":{"shape":"ListGroupsRequest"},
"output":{"shape":"ListGroupsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Lists all user groups in Amazon QuickSight. </p>"
},
"ListIAMPolicyAssignments":{
"name":"ListIAMPolicyAssignments",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments"
},
"input":{"shape":"ListIAMPolicyAssignmentsRequest"},
"output":{"shape":"ListIAMPolicyAssignmentsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists IAM policy assignments in the current Amazon QuickSight account.</p>"
},
"ListIAMPolicyAssignmentsForUser":{
"name":"ListIAMPolicyAssignmentsForUser",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments"
},
"input":{"shape":"ListIAMPolicyAssignmentsForUserRequest"},
"output":{"shape":"ListIAMPolicyAssignmentsForUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConcurrentUpdatingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.</p>"
},
"ListIngestions":{
"name":"ListIngestions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions"
},
"input":{"shape":"ListIngestionsRequest"},
"output":{"shape":"ListIngestionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the history of SPICE ingestions for a dataset.</p>"
},
"ListNamespaces":{
"name":"ListNamespaces",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces"
},
"input":{"shape":"ListNamespacesRequest"},
"output":{"shape":"ListNamespacesResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>"
},
"ListTagsForResource":{
"name":"ListTagsForResource",
"http":{
"method":"GET",
"requestUri":"/resources/{ResourceArn}/tags"
},
"input":{"shape":"ListTagsForResourceRequest"},
"output":{"shape":"ListTagsForResourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists the tags assigned to a resource.</p>"
},
"ListTemplateAliases":{
"name":"ListTemplateAliases",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/aliases"
},
"input":{"shape":"ListTemplateAliasesRequest"},
"output":{"shape":"ListTemplateAliasesResponse"},
"errors":[
{"shape":"InvalidNextTokenException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the aliases of a template.</p>"
},
"ListTemplateVersions":{
"name":"ListTemplateVersions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/versions"
},
"input":{"shape":"ListTemplateVersionsRequest"},
"output":{"shape":"ListTemplateVersionsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the versions of the templates in the current Amazon QuickSight account.</p>"
},
"ListTemplates":{
"name":"ListTemplates",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/templates"
},
"input":{"shape":"ListTemplatesRequest"},
"output":{"shape":"ListTemplatesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the templates in the current Amazon QuickSight account.</p>"
},
"ListThemeAliases":{
"name":"ListThemeAliases",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases"
},
"input":{"shape":"ListThemeAliasesRequest"},
"output":{"shape":"ListThemeAliasesResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the aliases of a theme.</p>"
},
"ListThemeVersions":{
"name":"ListThemeVersions",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/versions"
},
"input":{"shape":"ListThemeVersionsRequest"},
"output":{"shape":"ListThemeVersionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the versions of the themes in the current Amazon Web Services account.</p>"
},
"ListThemes":{
"name":"ListThemes",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/themes"
},
"input":{"shape":"ListThemesRequest"},
"output":{"shape":"ListThemesResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"InvalidNextTokenException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all the themes in the current Amazon Web Services account.</p>"
},
"ListUserGroups":{
"name":"ListUserGroups",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups"
},
"input":{"shape":"ListUserGroupsRequest"},
"output":{"shape":"ListUserGroupsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.</p>"
},
"ListUsers":{
"name":"ListUsers",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users"
},
"input":{"shape":"ListUsersRequest"},
"output":{"shape":"ListUsersResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Returns a list of all of the Amazon QuickSight users belonging to this account. </p>"
},
"RegisterUser":{
"name":"RegisterUser",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users"
},
"input":{"shape":"RegisterUserRequest"},
"output":{"shape":"RegisterUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. </p>"
},
"RestoreAnalysis":{
"name":"RestoreAnalysis",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}"
},
"input":{"shape":"RestoreAnalysisRequest"},
"output":{"shape":"RestoreAnalysisResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Restores an analysis.</p>"
},
"SearchAnalyses":{
"name":"SearchAnalyses",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/search/analyses"
},
"input":{"shape":"SearchAnalysesRequest"},
"output":{"shape":"SearchAnalysesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Searches for analyses that belong to the user specified in the filter.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>"
},
"SearchDashboards":{
"name":"SearchDashboards",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/search/dashboards"
},
"input":{"shape":"SearchDashboardsRequest"},
"output":{"shape":"SearchDashboardsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Searches for dashboards that belong to a user. </p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>"
},
"SearchDataSets":{
"name":"SearchDataSets",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/search/data-sets"
},
"input":{"shape":"SearchDataSetsRequest"},
"output":{"shape":"SearchDataSetsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Use the <code>SearchDataSets</code> operation to search for datasets that belong to an account.</p>"
},
"SearchDataSources":{
"name":"SearchDataSources",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/search/data-sources"
},
"input":{"shape":"SearchDataSourcesRequest"},
"output":{"shape":"SearchDataSourcesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Use the <code>SearchDataSources</code> operation to search for data sources that belong to an account.</p>"
},
"SearchFolders":{
"name":"SearchFolders",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/search/folders"
},
"input":{"shape":"SearchFoldersRequest"},
"output":{"shape":"SearchFoldersResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InvalidRequestException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Searches the subfolders in a folder.</p>"
},
"SearchGroups":{
"name":"SearchGroups",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search"
},
"input":{"shape":"SearchGroupsRequest"},
"output":{"shape":"SearchGroupsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Use the <code>SearchGroups</code> operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.</p>"
},
"TagResource":{
"name":"TagResource",
"http":{
"method":"POST",
"requestUri":"/resources/{ResourceArn}/tags"
},
"input":{"shape":"TagResourceRequest"},
"output":{"shape":"TagResourceResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. </p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the <code>TagResource</code> operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, and template. </p> <p>Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following:</p> <ul> <li> <p>You can't use tags to track costs for Amazon QuickSight. This isn't possible because you can't tag the resources that Amazon QuickSight costs are based on, for example Amazon QuickSight storage capacity (SPICE), number of users, type of users, and usage metrics.</p> </li> <li> <p>Amazon QuickSight doesn't currently support the tag editor for Resource Groups.</p> </li> </ul>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/resources/{ResourceArn}/tags"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Removes a tag or tags from a resource.</p>"
},
"UpdateAccountCustomization":{
"name":"UpdateAccountCustomization",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/customizations"
},
"input":{"shape":"UpdateAccountCustomizationRequest"},
"output":{"shape":"UpdateAccountCustomizationResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.</p> <p>You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation. </p>"
},
"UpdateAccountSettings":{
"name":"UpdateAccountSettings",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/settings"
},
"input":{"shape":"UpdateAccountSettingsRequest"},
"output":{"shape":"UpdateAccountSettingsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Updates the Amazon QuickSight settings in your Amazon Web Services account.</p>"
},
"UpdateAnalysis":{
"name":"UpdateAnalysis",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}"
},
"input":{"shape":"UpdateAnalysisRequest"},
"output":{"shape":"UpdateAnalysisResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceExistsException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates an analysis in Amazon QuickSight</p>"
},
"UpdateAnalysisPermissions":{
"name":"UpdateAnalysisPermissions",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions"
},
"input":{"shape":"UpdateAnalysisPermissionsRequest"},
"output":{"shape":"UpdateAnalysisPermissionsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the read and write permissions for an analysis.</p>"
},
"UpdateDashboard":{
"name":"UpdateDashboard",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}"
},
"input":{"shape":"UpdateDashboardRequest"},
"output":{"shape":"UpdateDashboardResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a dashboard in an Amazon Web Services account.</p> <note> <p>Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateDashboardPublishedVersion.html\">UpdateDashboardPublishedVersion</a> </code> API operation.</p> </note>"
},
"UpdateDashboardPermissions":{
"name":"UpdateDashboardPermissions",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions"
},
"input":{"shape":"UpdateDashboardPermissionsRequest"},
"output":{"shape":"UpdateDashboardPermissionsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates read and write permissions on a dashboard.</p>"
},
"UpdateDashboardPublishedVersion":{
"name":"UpdateDashboardPublishedVersion",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}"
},
"input":{"shape":"UpdateDashboardPublishedVersionRequest"},
"output":{"shape":"UpdateDashboardPublishedVersionResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the published version of a dashboard.</p>"
},
"UpdateDataSet":{
"name":"UpdateDataSet",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}"
},
"input":{"shape":"UpdateDataSetRequest"},
"output":{"shape":"UpdateDataSetResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.</p>"
},
"UpdateDataSetPermissions":{
"name":"UpdateDataSetPermissions",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions"
},
"input":{"shape":"UpdateDataSetPermissionsRequest"},
"output":{"shape":"UpdateDataSetPermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>"
},
"UpdateDataSource":{
"name":"UpdateDataSource",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/data-sources/{DataSourceId}"
},
"input":{"shape":"UpdateDataSourceRequest"},
"output":{"shape":"UpdateDataSourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a data source.</p>"
},
"UpdateDataSourcePermissions":{
"name":"UpdateDataSourcePermissions",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions"
},
"input":{"shape":"UpdateDataSourcePermissionsRequest"},
"output":{"shape":"UpdateDataSourcePermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the permissions to a data source.</p>"
},
"UpdateFolder":{
"name":"UpdateFolder",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}"
},
"input":{"shape":"UpdateFolderRequest"},
"output":{"shape":"UpdateFolderResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the name of a folder.</p>"
},
"UpdateFolderPermissions":{
"name":"UpdateFolderPermissions",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/folders/{FolderId}/permissions"
},
"input":{"shape":"UpdateFolderPermissionsRequest"},
"output":{"shape":"UpdateFolderPermissionsResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"AccessDeniedException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates permissions of a folder.</p>"
},
"UpdateGroup":{
"name":"UpdateGroup",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
},
"input":{"shape":"UpdateGroupRequest"},
"output":{"shape":"UpdateGroupResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Changes a group description. </p>"
},
"UpdateIAMPolicyAssignment":{
"name":"UpdateIAMPolicyAssignment",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}"
},
"input":{"shape":"UpdateIAMPolicyAssignmentRequest"},
"output":{"shape":"UpdateIAMPolicyAssignmentResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConcurrentUpdatingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in <code>Identities</code>. </p>"
},
"UpdateIpRestriction":{
"name":"UpdateIpRestriction",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}/ip-restriction"
},
"input":{"shape":"UpdateIpRestrictionRequest"},
"output":{"shape":"UpdateIpRestrictionResponse"},
"errors":[
{"shape":"LimitExceededException"},
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the content and status of IP rules. To use this operation, you need to provide the entire map of rules. You can use the <code>DescribeIpRestriction</code> operation to get the current rule map.</p>"
},
"UpdatePublicSharingSettings":{
"name":"UpdatePublicSharingSettings",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/public-sharing-settings"
},
"input":{"shape":"UpdatePublicSharingSettingsRequest"},
"output":{"shape":"UpdatePublicSharingSettingsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedPricingPlanException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Use the <code>UpdatePublicSharingSettings</code> operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard.</p> <p>To use this operation, turn on session capacity pricing for your Amazon QuickSight account.</p> <p>Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html\">Using Amazon QuickSight with IAM</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"UpdateTemplate":{
"name":"UpdateTemplate",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}"
},
"input":{"shape":"UpdateTemplateRequest"},
"output":{"shape":"UpdateTemplateResponse"},
"errors":[
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"ConflictException"},
{"shape":"LimitExceededException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a template from an existing Amazon QuickSight analysis or another template.</p>"
},
"UpdateTemplateAlias":{
"name":"UpdateTemplateAlias",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}"
},
"input":{"shape":"UpdateTemplateAliasRequest"},
"output":{"shape":"UpdateTemplateAliasResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ConflictException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the template alias of a template.</p>"
},
"UpdateTemplatePermissions":{
"name":"UpdateTemplatePermissions",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/templates/{TemplateId}/permissions"
},
"input":{"shape":"UpdateTemplatePermissionsRequest"},
"output":{"shape":"UpdateTemplatePermissionsResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the resource permissions for a template.</p>"
},
"UpdateTheme":{
"name":"UpdateTheme",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}"
},
"input":{"shape":"UpdateThemeRequest"},
"output":{"shape":"UpdateThemeResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates a theme.</p>"
},
"UpdateThemeAlias":{
"name":"UpdateThemeAlias",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}"
},
"input":{"shape":"UpdateThemeAliasRequest"},
"output":{"shape":"UpdateThemeAliasResponse"},
"errors":[
{"shape":"ConflictException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceExistsException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates an alias of a theme.</p>"
},
"UpdateThemePermissions":{
"name":"UpdateThemePermissions",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions"
},
"input":{"shape":"UpdateThemePermissionsRequest"},
"output":{"shape":"UpdateThemePermissionsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"LimitExceededException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example <code>\"quicksight:DescribeTheme\"</code>.</p> <p>Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: </p> <ul> <li> <p>User</p> <ul> <li> <p> <code>\"quicksight:DescribeTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeAliases\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeVersions\"</code> </p> </li> </ul> </li> <li> <p>Owner</p> <ul> <li> <p> <code>\"quicksight:DescribeTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeAliases\"</code> </p> </li> <li> <p> <code>\"quicksight:ListThemeVersions\"</code> </p> </li> <li> <p> <code>\"quicksight:DeleteTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateTheme\"</code> </p> </li> <li> <p> <code>\"quicksight:CreateThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:DeleteThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateThemeAlias\"</code> </p> </li> <li> <p> <code>\"quicksight:UpdateThemePermissions\"</code> </p> </li> <li> <p> <code>\"quicksight:DescribeThemePermissions\"</code> </p> </li> </ul> </li> <li> <p>To specify no permissions, omit the permissions list.</p> </li> </ul>"
},
"UpdateUser":{
"name":"UpdateUser",
"http":{
"method":"PUT",
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
},
"input":{"shape":"UpdateUserRequest"},
"output":{"shape":"UpdateUserResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"PreconditionNotMetException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Updates an Amazon QuickSight user.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.</p>",
"error":{"httpStatusCode":401},
"exception":true
},
"AccountCustomization":{
"type":"structure",
"members":{
"DefaultTheme":{
"shape":"Arn",
"documentation":"<p>The default theme for this Amazon QuickSight subscription.</p>"
},
"DefaultEmailCustomizationTemplate":{
"shape":"Arn",
"documentation":"<p>The default email customization template.</p>"
}
},
"documentation":"<p>The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.</p>"
},
"AccountInfo":{
"type":"structure",
"members":{
"AccountName":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of your Amazon QuickSight account.</p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.</p>"
},
"AuthenticationType":{
"shape":"String",
"documentation":"<p>The way that your Amazon QuickSight account is authenticated.</p>"
},
"AccountSubscriptionStatus":{
"shape":"String",
"documentation":"<p>The status of your account subscription.</p>"
}
},
"documentation":"<p>A structure that contains the following account information elements:</p> <ul> <li> <p>Your Amazon QuickSight account name.</p> </li> <li> <p>The edition of Amazon QuickSight that your account is using.</p> </li> <li> <p>The notification email address that is associated with the Amazon QuickSight account. </p> </li> <li> <p>The authentication type of the Amazon QuickSight account.</p> </li> <li> <p>The status of the Amazon QuickSight account's subscription.</p> </li> </ul>"
},
"AccountSettings":{
"type":"structure",
"members":{
"AccountName":{
"shape":"String",
"documentation":"<p>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.</p>"
},
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.</p>"
},
"DefaultNamespace":{
"shape":"Namespace",
"documentation":"<p>The default Amazon QuickSight namespace for your Amazon Web Services account. </p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The main notification email for your Amazon QuickSight subscription.</p>"
},
"PublicSharingEnabled":{
"shape":"Boolean",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdatePublicSharingSettings.html\">UpdatePublicSharingSettings</a>.</p>"
},
"TerminationProtectionEnabled":{
"shape":"Boolean",
"documentation":"<p>A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubsctiption</code> request. A <code>False</code> value will allow the ccount to be deleted. </p>"
}
},
"documentation":"<p>The Amazon QuickSight settings associated with your Amazon Web Services account.</p>"
},
"ActionList":{
"type":"list",
"member":{"shape":"String"},
"max":16,
"min":1
},
"ActiveIAMPolicyAssignment":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>A name for the IAM policy assignment.</p>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
},
"documentation":"<p>The active Identity and Access Management (IAM) policy assignment.</p>"
},
"ActiveIAMPolicyAssignmentList":{
"type":"list",
"member":{"shape":"ActiveIAMPolicyAssignment"}
},
"AdHocFilteringOption":{
"type":"structure",
"members":{
"AvailabilityStatus":{
"shape":"DashboardBehavior",
"documentation":"<p>Availability status.</p>"
}
},
"documentation":"<p>An ad hoc (one-time) filtering option.</p>"
},
"AdditionalDashboardIdList":{
"type":"list",
"member":{"shape":"ShortRestrictiveResourceId"},
"max":20,
"min":1
},
"AggregationFunction":{
"type":"structure",
"members":{
"NumericalAggregationFunction":{
"shape":"NumericalAggregationFunction",
"documentation":"<p>Aggregation for numerical values.</p>"
},
"CategoricalAggregationFunction":{
"shape":"CategoricalAggregationFunction",
"documentation":"<p>Aggregation for categorical values.</p> <ul> <li> <p> <code>COUNT</code>: Aggregate by the total number of values, including duplicates.</p> </li> <li> <p> <code>DISTINCT_COUNT</code>: Aggregate by the total number of distinct values.</p> </li> </ul>"
},
"DateAggregationFunction":{
"shape":"DateAggregationFunction",
"documentation":"<p>Aggregation for date values.</p> <ul> <li> <p> <code>COUNT</code>: Aggregate by the total number of values, including duplicates.</p> </li> <li> <p> <code>DISTINCT_COUNT</code>: Aggregate by the total number of distinct values.</p> </li> <li> <p> <code>MIN</code>: Select the smallest date value.</p> </li> <li> <p> <code>MAX</code>: Select the largest date value.</p> </li> </ul>"
}
},
"documentation":"<p>An aggregation function aggregates values from a dimension or measure.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"AggregationSortConfiguration":{
"type":"structure",
"required":[
"Column",
"SortDirection",
"AggregationFunction"
],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that determines the sort order of aggregated values.</p>"
},
"SortDirection":{
"shape":"SortDirection",
"documentation":"<p>The sort direction of values.</p> <ul> <li> <p> <code>ASC</code>: Sort in ascending order.</p> </li> <li> <p> <code>DESC</code>: Sort in descending order.</p> </li> </ul>"
},
"AggregationFunction":{
"shape":"AggregationFunction",
"documentation":"<p>The function that aggregates the values in <code>Column</code>.</p>"
}
},
"documentation":"<p>The configuration options to sort aggregated values.</p>"
},
"AggregationSortConfigurationList":{
"type":"list",
"member":{"shape":"AggregationSortConfiguration"},
"max":100
},
"AliasName":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)"
},
"AmazonElasticsearchParameters":{
"type":"structure",
"required":["Domain"],
"members":{
"Domain":{
"shape":"Domain",
"documentation":"<p>The OpenSearch domain.</p>"
}
},
"documentation":"<p>The parameters for OpenSearch.</p>"
},
"AmazonOpenSearchParameters":{
"type":"structure",
"required":["Domain"],
"members":{
"Domain":{
"shape":"Domain",
"documentation":"<p>The OpenSearch domain.</p>"
}
},
"documentation":"<p>The parameters for OpenSearch.</p>"
},
"Analysis":{
"type":"structure",
"members":{
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis.</p>"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>The descriptive name of the analysis.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>Status associated with the analysis.</p>"
},
"Errors":{
"shape":"AnalysisErrorList",
"documentation":"<p>Errors associated with the analysis.</p>"
},
"DataSetArns":{
"shape":"DataSetArnsList",
"documentation":"<p>The ARNs of the datasets of the analysis.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme of the analysis.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis was last updated.</p>"
},
"Sheets":{
"shape":"SheetList",
"documentation":"<p>A list of the associated sheets with the unique identifier and name of each sheet.</p>"
}
},
"documentation":"<p>Metadata structure for an analysis in Amazon QuickSight</p>"
},
"AnalysisDefaults":{
"type":"structure",
"required":["DefaultNewSheetConfiguration"],
"members":{
"DefaultNewSheetConfiguration":{
"shape":"DefaultNewSheetConfiguration",
"documentation":"<p>The configuration for default new sheet settings.</p>"
}
},
"documentation":"<p>The configuration for default analysis settings.</p>"
},
"AnalysisDefinition":{
"type":"structure",
"required":["DataSetIdentifierDeclarations"],
"members":{
"DataSetIdentifierDeclarations":{
"shape":"DataSetIdentifierDeclarationList",
"documentation":"<p>An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.</p>"
},
"Sheets":{
"shape":"SheetDefinitionList",
"documentation":"<p>An array of sheet definitions for an analysis. Each <code>SheetDefinition</code> provides detailed information about a sheet within this analysis.</p>"
},
"CalculatedFields":{
"shape":"CalculatedFields",
"documentation":"<p>An array of calculated field definitions for the analysis.</p>"
},
"ParameterDeclarations":{
"shape":"ParameterDeclarationList",
"documentation":"<p>An array of parameter declarations for an analysis.</p> <p>Parameters are named variables that can transfer a value for use by an action or an object.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html\">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FilterGroups":{
"shape":"FilterGroupList",
"documentation":"<p>Filter definitions for an analysis.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html\">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ColumnConfigurations":{
"shape":"ColumnConfigurationList",
"documentation":"<p> An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. </p>"
},
"AnalysisDefaults":{"shape":"AnalysisDefaults"}
},
"documentation":"<p>The definition of an analysis.</p>"
},
"AnalysisError":{
"type":"structure",
"members":{
"Type":{
"shape":"AnalysisErrorType",
"documentation":"<p>The type of the analysis error.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>The message associated with the analysis error.</p>"
},
"ViolatedEntities":{
"shape":"EntityList",
"documentation":"<p/>"
}
},
"documentation":"<p>Analysis error.</p>"
},
"AnalysisErrorList":{
"type":"list",
"member":{"shape":"AnalysisError"},
"min":1
},
"AnalysisErrorType":{
"type":"string",
"enum":[
"ACCESS_DENIED",
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"PARAMETER_VALUE_INCOMPATIBLE",
"PARAMETER_TYPE_INVALID",
"PARAMETER_NOT_FOUND",
"COLUMN_TYPE_MISMATCH",
"COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
"COLUMN_REPLACEMENT_MISSING"
]
},
"AnalysisFilterAttribute":{
"type":"string",
"enum":[
"QUICKSIGHT_USER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"ANALYSIS_NAME"
]
},
"AnalysisName":{
"type":"string",
"max":2048,
"min":1
},
"AnalysisSearchFilter":{
"type":"structure",
"members":{
"Operator":{
"shape":"FilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>. Valid values are <code>\"StringEquals\"</code> and <code>\"StringLike\"</code>.</p> <p>If you set the operator value to <code>\"StringEquals\"</code>, you need to provide an ownership related filter in the <code>\"NAME\"</code> field and the arn of the user or group whose folders you want to search in the <code>\"Value\"</code> field. For example, <code>\"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p> <p>If you set the value to <code>\"StringLike\"</code>, you need to provide the name of the folders you are searching for. For example, <code>\"Name\":\"ANALYSIS_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\"</code>. The <code>\"StringLike\"</code> operator only supports the <code>NAME</code> value <code>ANALYSIS_NAME</code>.</p>"
},
"Name":{
"shape":"AnalysisFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example <code>\"Name\": \"QUICKSIGHT_OWNER\"</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: 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. </p> </li> <li> <p> <code>QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: 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. </p> </li> <li> <p> <code>ANALYSIS_NAME</code>: Any analyses whose names have a substring match to this value will be returned.</p> </li> </ul>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter, for example <code>\"Value\"</code>. An example is <code>\"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p>"
}
},
"documentation":"<p>A filter that you apply when searching for one or more analyses.</p>"
},
"AnalysisSearchFilterList":{
"type":"list",
"member":{"shape":"AnalysisSearchFilter"},
"max":1,
"min":1
},
"AnalysisSourceEntity":{
"type":"structure",
"members":{
"SourceTemplate":{
"shape":"AnalysisSourceTemplate",
"documentation":"<p>The source template for the source entity of the analysis.</p>"
}
},
"documentation":"<p>The source entity of an analysis.</p>"
},
"AnalysisSourceTemplate":{
"type":"structure",
"required":[
"DataSetReferences",
"Arn"
],
"members":{
"DataSetReferences":{
"shape":"DataSetReferenceList",
"documentation":"<p>The dataset references of the source template of an analysis.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the source template of an analysis.</p>"
}
},
"documentation":"<p>The source template of an analysis.</p>"
},
"AnalysisSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the analysis.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis. This ID displays in the URL.</p>"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>The name of the analysis. This name is displayed in the Amazon QuickSight console. </p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The last known status for the analysis.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the analysis was last updated.</p>"
}
},
"documentation":"<p>The summary metadata that describes an analysis.</p>"
},
"AnalysisSummaryList":{
"type":"list",
"member":{"shape":"AnalysisSummary"},
"max":100
},
"AnchorDateConfiguration":{
"type":"structure",
"members":{
"AnchorOption":{
"shape":"AnchorOption",
"documentation":"<p>The options for the date configuration. Choose one of the options below:</p> <ul> <li> <p> <code>NOW</code> </p> </li> </ul>"
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter that is used for the anchor date configuration.</p>"
}
},
"documentation":"<p>The date configuration of the filter.</p>"
},
"AnchorOption":{
"type":"string",
"enum":["NOW"]
},
"AnonymousUserDashboardEmbeddingConfiguration":{
"type":"structure",
"required":["InitialDashboardId"],
"members":{
"InitialDashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>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.</p> <p>The Amazon Resource Name (ARN) of this dashboard must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
}
},
"documentation":"<p>Information about the dashboard that you want to embed.</p>"
},
"AnonymousUserDashboardVisualEmbeddingConfiguration":{
"type":"structure",
"required":["InitialDashboardVisualId"],
"members":{
"InitialDashboardVisualId":{
"shape":"DashboardVisualId",
"documentation":"<p>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.</p> <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
}
},
"documentation":"<p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>"
},
"AnonymousUserEmbeddingExperienceConfiguration":{
"type":"structure",
"members":{
"Dashboard":{
"shape":"AnonymousUserDashboardEmbeddingConfiguration",
"documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight dashboards.</p>"
},
"DashboardVisual":{
"shape":"AnonymousUserDashboardVisualEmbeddingConfiguration",
"documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>"
},
"QSearchBar":{
"shape":"AnonymousUserQSearchBarEmbeddingConfiguration",
"documentation":"<p>The Q search bar that you want to use for anonymous user embedding.</p>"
}
},
"documentation":"<p>The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.</p>"
},
"AnonymousUserQSearchBarEmbeddingConfiguration":{
"type":"structure",
"required":["InitialTopicId"],
"members":{
"InitialTopicId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>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.</p> <p>The Amazon Resource Name (ARN) of this Q topic must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
}
},
"documentation":"<p>The settings that you want to use with the Q search bar.</p>"
},
"ArcAxisConfiguration":{
"type":"structure",
"members":{
"Range":{
"shape":"ArcAxisDisplayRange",
"documentation":"<p>The arc axis range of a <code>GaugeChartVisual</code>.</p>"
},
"ReserveRange":{
"shape":"Integer",
"documentation":"<p>The reserved range of the arc axis.</p>"
}
},
"documentation":"<p>The arc axis configuration of a <code>GaugeChartVisual</code>.</p>"
},
"ArcAxisDisplayRange":{
"type":"structure",
"members":{
"Min":{
"shape":"Double",
"documentation":"<p>The minimum value of the arc axis range.</p>",
"box":true
},
"Max":{
"shape":"Double",
"documentation":"<p>The maximum value of the arc axis range.</p>",
"box":true
}
},
"documentation":"<p>The arc axis range of a <code>GaugeChartVisual</code>.</p>"
},
"ArcConfiguration":{
"type":"structure",
"members":{
"ArcAngle":{
"shape":"Double",
"documentation":"<p>The option that determines the arc angle of a <code>GaugeChartVisual</code>.</p>",
"box":true
},
"ArcThickness":{
"shape":"ArcThicknessOptions",
"documentation":"<p>The options that determine the arc thickness of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>The arc configuration of a <code>GaugeChartVisual</code>.</p>"
},
"ArcOptions":{
"type":"structure",
"members":{
"ArcThickness":{
"shape":"ArcThickness",
"documentation":"<p>The arc thickness of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>The options that determine the arc thickness of a <code>GaugeChartVisual</code>.</p>"
},
"ArcThickness":{
"type":"string",
"enum":[
"SMALL",
"MEDIUM",
"LARGE",
"WHOLE"
]
},
"ArcThicknessOptions":{
"type":"string",
"enum":[
"SMALL",
"MEDIUM",
"LARGE"
]
},
"Arn":{"type":"string"},
"ArnList":{
"type":"list",
"member":{"shape":"Arn"}
},
"AssignmentStatus":{
"type":"string",
"enum":[
"ENABLED",
"DRAFT",
"DISABLED"
]
},
"AthenaParameters":{
"type":"structure",
"members":{
"WorkGroup":{
"shape":"WorkGroup",
"documentation":"<p>The workgroup that Amazon Athena uses.</p>"
},
"RoleArn":{
"shape":"RoleArn",
"documentation":"<p>Use the <code>RoleArn</code> 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 <code>RoleArn</code> 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.</p>"
}
},
"documentation":"<p>Parameters for Amazon Athena.</p>"
},
"AuroraParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>Parameters for Amazon Aurora.</p>"
},
"AuroraPostgreSqlParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>The Amazon Aurora PostgreSQL-Compatible host to connect to.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port that Amazon Aurora PostgreSQL is listening on.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>The Amazon Aurora PostgreSQL database to connect to.</p>"
}
},
"documentation":"<p>Parameters for Amazon Aurora PostgreSQL-Compatible Edition.</p>"
},
"AuthenticationMethodOption":{
"type":"string",
"enum":[
"IAM_AND_QUICKSIGHT",
"IAM_ONLY",
"ACTIVE_DIRECTORY"
]
},
"AwsAccountId":{
"type":"string",
"max":12,
"min":12,
"pattern":"^[0-9]{12}$"
},
"AwsAndAccountId":{
"type":"string",
"pattern":"^(aws|[0-9]{12})$"
},
"AwsIotAnalyticsParameters":{
"type":"structure",
"required":["DataSetName"],
"members":{
"DataSetName":{
"shape":"DataSetName",
"documentation":"<p>Dataset name.</p>"
}
},
"documentation":"<p>The parameters for IoT Analytics.</p>"
},
"AxisBinding":{
"type":"string",
"enum":[
"PRIMARY_YAXIS",
"SECONDARY_YAXIS"
]
},
"AxisDataOptions":{
"type":"structure",
"members":{
"NumericAxisOptions":{
"shape":"NumericAxisOptions",
"documentation":"<p>The options for an axis with a numeric field.</p>"
},
"DateAxisOptions":{
"shape":"DateAxisOptions",
"documentation":"<p>The options for an axis with a date field.</p>"
}
},
"documentation":"<p>The data options for an axis.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"AxisDisplayDataDrivenRange":{
"type":"structure",
"members":{
},
"documentation":"<p>The options that are saved for future extension.</p>"
},
"AxisDisplayMinMaxRange":{
"type":"structure",
"members":{
"Minimum":{
"shape":"Double",
"documentation":"<p>The minimum setup for an axis display range.</p>",
"box":true
},
"Maximum":{
"shape":"Double",
"documentation":"<p>The maximum setup for an axis display range.</p>",
"box":true
}
},
"documentation":"<p>The minimum and maximum setup for an axis display range.</p>"
},
"AxisDisplayOptions":{
"type":"structure",
"members":{
"TickLabelOptions":{
"shape":"AxisTickLabelOptions",
"documentation":"<p>The tick label options of an axis.</p>"
},
"AxisLineVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the axis line is visible.</p>"
},
"GridLineVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the grid line is visible.</p>"
},
"DataOptions":{
"shape":"AxisDataOptions",
"documentation":"<p>The data options for an axis.</p>"
},
"ScrollbarOptions":{
"shape":"ScrollBarOptions",
"documentation":"<p>The scroll bar options for an axis.</p>"
},
"AxisOffset":{
"shape":"PixelLength",
"documentation":"<p>The offset value that determines the starting placement of the axis within a visual's bounds.</p>"
}
},
"documentation":"<p>The display options for the axis label.</p>"
},
"AxisDisplayRange":{
"type":"structure",
"members":{
"MinMax":{
"shape":"AxisDisplayMinMaxRange",
"documentation":"<p>The minimum and maximum setup of an axis display range.</p>"
},
"DataDriven":{
"shape":"AxisDisplayDataDrivenRange",
"documentation":"<p>The data-driven setup of an axis display range.</p>"
}
},
"documentation":"<p>The range setup of a numeric axis display range.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"AxisLabelOptions":{
"type":"structure",
"members":{
"FontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration of the axis label.</p>"
},
"CustomLabel":{
"shape":"String",
"documentation":"<p>The text for the axis label.</p>"
},
"ApplyTo":{
"shape":"AxisLabelReferenceOptions",
"documentation":"<p>The options that indicate which field the label belongs to.</p>"
}
},
"documentation":"<p>The label options for a chart axis. You must specify the field that the label is targeted to.</p>"
},
"AxisLabelOptionsList":{
"type":"list",
"member":{"shape":"AxisLabelOptions"},
"max":100
},
"AxisLabelReferenceOptions":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field that the axis label is targeted to.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the axis label is targeted to.</p>"
}
},
"documentation":"<p>The reference that specifies where the axis label is applied to.</p>"
},
"AxisLinearScale":{
"type":"structure",
"members":{
"StepCount":{
"shape":"Integer",
"documentation":"<p>The step count setup of a linear axis.</p>",
"box":true
},
"StepSize":{
"shape":"Double",
"documentation":"<p>The step size setup of a linear axis.</p>",
"box":true
}
},
"documentation":"<p>The liner axis scale setup.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"AxisLogarithmicScale":{
"type":"structure",
"members":{
"Base":{
"shape":"Double",
"documentation":"<p>The base setup of a logarithmic axis scale.</p>",
"box":true
}
},
"documentation":"<p>The logarithmic axis scale setup.</p>"
},
"AxisScale":{
"type":"structure",
"members":{
"Linear":{
"shape":"AxisLinearScale",
"documentation":"<p>The linear axis scale setup.</p>"
},
"Logarithmic":{
"shape":"AxisLogarithmicScale",
"documentation":"<p>The logarithmic axis scale setup.</p>"
}
},
"documentation":"<p>The scale setup options for a numeric axis display.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"AxisTickLabelOptions":{
"type":"structure",
"members":{
"LabelOptions":{
"shape":"LabelOptions",
"documentation":"<p>Determines whether or not the axis ticks are visible.</p>"
},
"RotationAngle":{
"shape":"Double",
"documentation":"<p>The rotation angle of the axis tick labels.</p>",
"box":true
}
},
"documentation":"<p>The tick label options of an axis.</p>"
},
"BarChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Category":{
"shape":"DimensionFieldList",
"documentation":"<p>The category (y-axis) field well of a bar chart.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a bar chart. Values are aggregated by category.</p>"
},
"Colors":{
"shape":"DimensionFieldList",
"documentation":"<p>The color (group/color) field well of a bar chart.</p>"
},
"SmallMultiples":{
"shape":"SmallMultiplesDimensionFieldList",
"documentation":"<p>The small multiples field well of a bar chart.</p>"
}
},
"documentation":"<p>The aggregated field wells of a bar chart.</p>"
},
"BarChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"BarChartFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"BarChartSortConfiguration",
"documentation":"<p>The sort configuration of a <code>BarChartVisual</code>.</p>"
},
"Orientation":{
"shape":"BarChartOrientation",
"documentation":"<p>The orientation of the bars in a bar chart visual. There are two valid values in this structure:</p> <ul> <li> <p> <code>HORIZONTAL</code>: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts.</p> </li> <li> <p> <code>VERTICAL</code>: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.</p> </li> </ul>"
},
"BarsArrangement":{
"shape":"BarsArrangement",
"documentation":"<p>Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The palette (chart color) display setup of the visual.</p>"
},
"SmallMultiplesOptions":{
"shape":"SmallMultiplesOptions",
"documentation":"<p>The small multiples setup for the visual.</p>"
},
"CategoryAxis":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, axis step) for bar chart category.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility and sort icon visibility) for a bar chart.</p>"
},
"ValueAxis":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, axis step) for a bar chart value.</p>"
},
"ValueLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility and sort icon visibility) for a bar chart value.</p>"
},
"ColorLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
},
"ReferenceLines":{
"shape":"ReferenceLineList",
"documentation":"<p>The reference line setup of the visual.</p>"
},
"ContributionAnalysisDefaults":{
"shape":"ContributionAnalysisDefaultList",
"documentation":"<p>The contribution analysis (anomaly configuration) setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a <code>BarChartVisual</code>.</p>"
},
"BarChartFieldWells":{
"type":"structure",
"members":{
"BarChartAggregatedFieldWells":{
"shape":"BarChartAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a bar chart.</p>"
}
},
"documentation":"<p>The field wells of a <code>BarChartVisual</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"BarChartOrientation":{
"type":"string",
"enum":[
"HORIZONTAL",
"VERTICAL"
]
},
"BarChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of category fields.</p>"
},
"CategoryItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of categories displayed in a bar chart.</p>"
},
"ColorSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of color fields in a bar chart.</p>"
},
"ColorItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of values displayed in a bar chart.</p>"
},
"SmallMultiplesSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the small multiples field.</p>"
},
"SmallMultiplesLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of small multiples panels that are displayed.</p>"
}
},
"documentation":"<p>sort-configuration-description</p>"
},
"BarChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"BarChartConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A bar chart.</p> <p>The <code>BarChartVisual</code> structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:</p> <ul> <li> <p>Horizontal bar chart</p> </li> <li> <p>Vertical bar chart</p> </li> <li> <p>Horizontal stacked bar chart</p> </li> <li> <p>Vertical stacked bar chart</p> </li> <li> <p>Horizontal stacked 100% bar chart</p> </li> <li> <p>Vertical stacked 100% bar chart</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html\">Using bar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"BarsArrangement":{
"type":"string",
"enum":[
"CLUSTERED",
"STACKED",
"STACKED_PERCENT"
]
},
"BaseMapStyleType":{
"type":"string",
"enum":[
"LIGHT_GRAY",
"DARK_GRAY",
"STREET",
"IMAGERY"
]
},
"BinCountLimit":{
"type":"long",
"max":1000,
"min":0
},
"BinCountOptions":{
"type":"structure",
"members":{
"Value":{
"shape":"BinCountValue",
"documentation":"<p>The options that determine the bin count value.</p>"
}
},
"documentation":"<p>The options that determine the bin count of a histogram.</p>"
},
"BinCountValue":{
"type":"integer",
"min":0
},
"BinWidthOptions":{
"type":"structure",
"members":{
"Value":{
"shape":"BinWidthValue",
"documentation":"<p>The options that determine the bin width value.</p>"
},
"BinCountLimit":{
"shape":"BinCountLimit",
"documentation":"<p>The options that determine the bin count limit.</p>"
}
},
"documentation":"<p>The options that determine the bin width of a histogram.</p>"
},
"BinWidthValue":{
"type":"double",
"min":0
},
"BodySectionConfiguration":{
"type":"structure",
"required":[
"SectionId",
"Content"
],
"members":{
"SectionId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a body section.</p>"
},
"Content":{
"shape":"BodySectionContent",
"documentation":"<p>The configuration of content in a body section.</p>"
},
"Style":{
"shape":"SectionStyle",
"documentation":"<p>The style options of a body section.</p>"
},
"PageBreakConfiguration":{
"shape":"SectionPageBreakConfiguration",
"documentation":"<p>The configuration of a page break for a section.</p>"
}
},
"documentation":"<p>The configuration of a body section.</p>"
},
"BodySectionConfigurationList":{
"type":"list",
"member":{"shape":"BodySectionConfiguration"},
"max":28
},
"BodySectionContent":{
"type":"structure",
"members":{
"Layout":{
"shape":"SectionLayoutConfiguration",
"documentation":"<p>The layout configuration of a body section.</p>"
}
},
"documentation":"<p>The configuration of content in a body section.</p>"
},
"Boolean":{"type":"boolean"},
"BooleanObject":{"type":"boolean"},
"BorderStyle":{
"type":"structure",
"members":{
"Show":{
"shape":"Boolean",
"documentation":"<p>The option to enable display of borders for visuals.</p>",
"box":true
}
},
"documentation":"<p>The display options for tile borders for visuals.</p>"
},
"BoxPlotAggregatedFieldWells":{
"type":"structure",
"members":{
"GroupBy":{
"shape":"BoxPlotDimensionFieldList",
"documentation":"<p>The group by field well of a box plot chart. Values are grouped based on group by fields.</p>"
},
"Values":{
"shape":"BoxPlotMeasureFieldList",
"documentation":"<p>The value field well of a box plot chart. Values are aggregated based on group by fields.</p>"
}
},
"documentation":"<p>The aggregated field well for a box plot.</p>"
},
"BoxPlotChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"BoxPlotFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"BoxPlotSortConfiguration",
"documentation":"<p>The sort configuration of a <code>BoxPlotVisual</code>.</p>"
},
"BoxPlotOptions":{
"shape":"BoxPlotOptions",
"documentation":"<p>The box plot chart options for a box plot visual</p>"
},
"CategoryAxis":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, axis step) of a box plot category.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility and sort Icon visibility) of a box plot category.</p>"
},
"PrimaryYAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, axis step) of a box plot category.</p>"
},
"PrimaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility and sort icon visibility) of a box plot value.</p>"
},
"Legend":{"shape":"LegendOptions"},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
},
"ReferenceLines":{
"shape":"ReferenceLineList",
"documentation":"<p>The reference line setup of the visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The palette (chart color) display setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a <code>BoxPlotVisual</code>.</p>"
},
"BoxPlotDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"BoxPlotFieldWells":{
"type":"structure",
"members":{
"BoxPlotAggregatedFieldWells":{
"shape":"BoxPlotAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a box plot.</p>"
}
},
"documentation":"<p>The field wells of a <code>BoxPlotVisual</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"BoxPlotFillStyle":{
"type":"string",
"enum":[
"SOLID",
"TRANSPARENT"
]
},
"BoxPlotMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":5
},
"BoxPlotOptions":{
"type":"structure",
"members":{
"StyleOptions":{
"shape":"BoxPlotStyleOptions",
"documentation":"<p>The style options of the box plot.</p>"
},
"OutlierVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the outlier in a box plot.</p>"
},
"AllDataPointsVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of all data points of the box plot.</p>"
}
},
"documentation":"<p>The options of a box plot visual.</p>"
},
"BoxPlotSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of a group by fields.</p>"
},
"PaginationConfiguration":{
"shape":"PaginationConfiguration",
"documentation":"<p>The pagination configuration of a table visual or box plot.</p>"
}
},
"documentation":"<p>The sort configuration of a <code>BoxPlotVisual</code>.</p>"
},
"BoxPlotStyleOptions":{
"type":"structure",
"members":{
"FillStyle":{
"shape":"BoxPlotFillStyle",
"documentation":"<p>The fill styles (solid, transparent) of the box plot.</p>"
}
},
"documentation":"<p>The style options of the box plot.</p>"
},
"BoxPlotVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"BoxPlotChartConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A box plot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html\">Using box plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CIDR":{
"type":"string",
"pattern":"^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\\/(3[0-2]|[1-2][0-9]|[1-9]))$"
},
"CalculatedColumn":{
"type":"structure",
"required":[
"ColumnName",
"ColumnId",
"Expression"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>Column name.</p>"
},
"ColumnId":{
"shape":"ColumnId",
"documentation":"<p>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.</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"<p>An expression that defines the calculated column.</p>"
}
},
"documentation":"<p>A calculated column for a dataset.</p>"
},
"CalculatedColumnList":{
"type":"list",
"member":{"shape":"CalculatedColumn"},
"max":128,
"min":1
},
"CalculatedField":{
"type":"structure",
"required":[
"DataSetIdentifier",
"Name",
"Expression"
],
"members":{
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The data set that is used in this calculated field.</p>"
},
"Name":{
"shape":"ColumnName",
"documentation":"<p>The name of the calculated field.</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression of the calculated field.</p>"
}
},
"documentation":"<p>The calculated field of an analysis.</p>"
},
"CalculatedFields":{
"type":"list",
"member":{"shape":"CalculatedField"},
"max":100
},
"CalculatedMeasureField":{
"type":"structure",
"required":[
"FieldId",
"Expression"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression in the table calculation.</p>"
}
},
"documentation":"<p>The table calculation measure field for pivot tables.</p>"
},
"CancelIngestionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId",
"IngestionId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"String",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>",
"location":"uri",
"locationName":"IngestionId"
}
}
},
"CancelIngestionResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data ingestion.</p>"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CascadingControlConfiguration":{
"type":"structure",
"members":{
"SourceControls":{
"shape":"CascadingControlSourceList",
"documentation":"<p>A list of source controls that determine the values that are used in the current control.</p>"
}
},
"documentation":"<p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>"
},
"CascadingControlSource":{
"type":"structure",
"members":{
"SourceSheetControlId":{
"shape":"String",
"documentation":"<p>The source sheet control ID of a <code>CascadingControlSource</code>.</p>"
},
"ColumnToMatch":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column identifier that determines which column to look up for the source sheet control.</p>"
}
},
"documentation":"<p>The source controls that are used in a <code>CascadingControlConfiguration</code>.</p>"
},
"CascadingControlSourceList":{
"type":"list",
"member":{"shape":"CascadingControlSource"},
"max":200
},
"CastColumnTypeOperation":{
"type":"structure",
"required":[
"ColumnName",
"NewColumnType"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>Column name.</p>"
},
"NewColumnType":{
"shape":"ColumnDataType",
"documentation":"<p>New column data type.</p>"
},
"Format":{
"shape":"TypeCastFormat",
"documentation":"<p>When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.</p>"
}
},
"documentation":"<p>A transform operation that casts a column to a different type.</p>"
},
"Catalog":{
"type":"string",
"max":128
},
"CategoricalAggregationFunction":{
"type":"string",
"enum":[
"COUNT",
"DISTINCT_COUNT"
]
},
"CategoricalDimensionField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>CategoricalDimensionField</code>.</p>"
},
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The custom hierarchy ID.</p>"
},
"FormatConfiguration":{
"shape":"StringFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The dimension type field with categorical type columns..</p>"
},
"CategoricalMeasureField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>CategoricalMeasureField</code>.</p>"
},
"AggregationFunction":{
"shape":"CategoricalAggregationFunction",
"documentation":"<p>The aggregation function of the measure field.</p>"
},
"FormatConfiguration":{
"shape":"StringFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The measure type field with categorical type columns.</p>"
},
"CategoryDrillDownFilter":{
"type":"structure",
"required":[
"Column",
"CategoryValues"
],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"CategoryValues":{
"shape":"CategoryValueList",
"documentation":"<p>A list of the string inputs that are the values of the category drill down filter.</p>"
}
},
"documentation":"<p>The numeric equality type drill down filter.</p>"
},
"CategoryFilter":{
"type":"structure",
"required":[
"FilterId",
"Column"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"Configuration":{
"shape":"CategoryFilterConfiguration",
"documentation":"<p>The configuration for a <code>CategoryFilter</code>.</p>"
}
},
"documentation":"<p>A <code>CategoryFilter</code> filters text values.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html\">Adding text filters</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CategoryFilterConfiguration":{
"type":"structure",
"members":{
"FilterListConfiguration":{
"shape":"FilterListConfiguration",
"documentation":"<p>A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.</p>"
},
"CustomFilterListConfiguration":{
"shape":"CustomFilterListConfiguration",
"documentation":"<p>A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.</p>"
},
"CustomFilterConfiguration":{
"shape":"CustomFilterConfiguration",
"documentation":"<p>A custom filter that filters based on a single value. This filter can be partially matched.</p>"
}
},
"documentation":"<p>The configuration for a <code>CategoryFilter</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"CategoryFilterMatchOperator":{
"type":"string",
"enum":[
"EQUALS",
"DOES_NOT_EQUAL",
"CONTAINS",
"DOES_NOT_CONTAIN",
"STARTS_WITH",
"ENDS_WITH"
]
},
"CategoryFilterSelectAllOptions":{
"type":"string",
"enum":["FILTER_ALL_VALUES"]
},
"CategoryValue":{
"type":"string",
"max":512
},
"CategoryValueList":{
"type":"list",
"member":{"shape":"CategoryValue"},
"max":100000
},
"ChartAxisLabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of an axis label on a chart. Choose one of the following options:</p> <ul> <li> <p> <code>VISIBLE</code>: Shows the axis.</p> </li> <li> <p> <code>HIDDEN</code>: Hides the axis.</p> </li> </ul>"
},
"SortIconVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration of the sort icon on a chart's axis label.</p>"
},
"AxisLabelOptions":{
"shape":"AxisLabelOptionsList",
"documentation":"<p>The label options for a chart axis.</p>"
}
},
"documentation":"<p>The label options for an axis on a chart.</p>"
},
"ClusterId":{
"type":"string",
"max":64,
"min":1
},
"ClusterMarker":{
"type":"structure",
"members":{
"SimpleClusterMarker":{
"shape":"SimpleClusterMarker",
"documentation":"<p>The simple cluster marker of the cluster marker.</p>"
}
},
"documentation":"<p>The cluster marker that is a part of the cluster marker configuration.</p>"
},
"ClusterMarkerConfiguration":{
"type":"structure",
"members":{
"ClusterMarker":{
"shape":"ClusterMarker",
"documentation":"<p>The cluster marker that is a part of the cluster marker configuration</p>"
}
},
"documentation":"<p>The cluster marker configuration of the geospatial map selected point style.</p>"
},
"ColorFillType":{
"type":"string",
"enum":[
"DISCRETE",
"GRADIENT"
]
},
"ColorList":{
"type":"list",
"member":{"shape":"HexColor"},
"max":100
},
"ColorScale":{
"type":"structure",
"required":[
"Colors",
"ColorFillType"
],
"members":{
"Colors":{
"shape":"ColorScaleColorList",
"documentation":"<p>Determines the list of colors that are applied to the visual.</p>"
},
"ColorFillType":{
"shape":"ColorFillType",
"documentation":"<p>Determines the color fill type.</p>"
},
"NullValueColor":{
"shape":"DataColor",
"documentation":"<p>Determines the color that is applied to null values.</p>"
}
},
"documentation":"<p>Determines the color scale that is applied to the visual.</p>"
},
"ColorScaleColorList":{
"type":"list",
"member":{"shape":"DataColor"},
"max":3,
"min":2
},
"ColumnConfiguration":{
"type":"structure",
"required":["Column"],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column.</p>"
},
"FormatConfiguration":{
"shape":"FormatConfiguration",
"documentation":"<p>The format configuration of a column.</p>"
},
"Role":{
"shape":"ColumnRole",
"documentation":"<p>The role of the column.</p>"
}
},
"documentation":"<p>The general configuration of a column.</p>"
},
"ColumnConfigurationList":{
"type":"list",
"member":{"shape":"ColumnConfiguration"},
"max":200
},
"ColumnDataType":{
"type":"string",
"enum":[
"STRING",
"INTEGER",
"DECIMAL",
"DATETIME"
]
},
"ColumnDescription":{
"type":"structure",
"members":{
"Text":{
"shape":"ColumnDescriptiveText",
"documentation":"<p>The text of a description for a column.</p>"
}
},
"documentation":"<p>Metadata that contains a description for a column.</p>"
},
"ColumnDescriptiveText":{
"type":"string",
"max":500,
"min":0
},
"ColumnGroup":{
"type":"structure",
"members":{
"GeoSpatialColumnGroup":{
"shape":"GeoSpatialColumnGroup",
"documentation":"<p>Geospatial column group that denotes a hierarchy.</p>"
}
},
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"ColumnGroupColumnSchema":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the column group's column schema.</p>"
}
},
"documentation":"<p>A structure describing the name, data type, and geographic role of the columns.</p>"
},
"ColumnGroupColumnSchemaList":{
"type":"list",
"member":{"shape":"ColumnGroupColumnSchema"},
"max":500
},
"ColumnGroupList":{
"type":"list",
"member":{"shape":"ColumnGroup"},
"max":8,
"min":1
},
"ColumnGroupName":{
"type":"string",
"max":64,
"min":1
},
"ColumnGroupSchema":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the column group schema.</p>"
},
"ColumnGroupColumnSchemaList":{
"shape":"ColumnGroupColumnSchemaList",
"documentation":"<p>A structure containing the list of schemas for column group columns.</p>"
}
},
"documentation":"<p>The column group schema.</p>"
},
"ColumnGroupSchemaList":{
"type":"list",
"member":{"shape":"ColumnGroupSchema"},
"max":500
},
"ColumnHierarchy":{
"type":"structure",
"members":{
"ExplicitHierarchy":{
"shape":"ExplicitHierarchy",
"documentation":"<p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>"
},
"DateTimeHierarchy":{
"shape":"DateTimeHierarchy",
"documentation":"<p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>"
},
"PredefinedHierarchy":{
"shape":"PredefinedHierarchy",
"documentation":"<p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>"
}
},
"documentation":"<p>The option that determines the hierarchy of the fields for a visual element.</p>"
},
"ColumnHierarchyList":{
"type":"list",
"member":{"shape":"ColumnHierarchy"},
"max":2
},
"ColumnId":{
"type":"string",
"max":64,
"min":1
},
"ColumnIdentifier":{
"type":"structure",
"required":[
"DataSetIdentifier",
"ColumnName"
],
"members":{
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The data set that the column belongs to.</p>"
},
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>The name of the column.</p>"
}
},
"documentation":"<p>A column of a data set.</p>"
},
"ColumnLevelPermissionRule":{
"type":"structure",
"members":{
"Principals":{
"shape":"PrincipalList",
"documentation":"<p>An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.</p>"
},
"ColumnNames":{
"shape":"ColumnNameList",
"documentation":"<p>An array of column names.</p>"
}
},
"documentation":"<p>A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.</p>"
},
"ColumnLevelPermissionRuleList":{
"type":"list",
"member":{"shape":"ColumnLevelPermissionRule"},
"min":1
},
"ColumnList":{
"type":"list",
"member":{"shape":"ColumnName"},
"max":16,
"min":1
},
"ColumnName":{
"type":"string",
"max":128,
"min":1
},
"ColumnNameList":{
"type":"list",
"member":{"shape":"String"},
"min":1
},
"ColumnRole":{
"type":"string",
"enum":[
"DIMENSION",
"MEASURE"
]
},
"ColumnSchema":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the column schema.</p>"
},
"DataType":{
"shape":"String",
"documentation":"<p>The data type of the column schema.</p>"
},
"GeographicRole":{
"shape":"String",
"documentation":"<p>The geographic role of the column schema.</p>"
}
},
"documentation":"<p>The column schema.</p>"
},
"ColumnSchemaList":{
"type":"list",
"member":{"shape":"ColumnSchema"},
"max":500
},
"ColumnSort":{
"type":"structure",
"required":[
"SortBy",
"Direction"
],
"members":{
"SortBy":{"shape":"ColumnIdentifier"},
"Direction":{
"shape":"SortDirection",
"documentation":"<p>The sort direction.</p>"
},
"AggregationFunction":{
"shape":"AggregationFunction",
"documentation":"<p>The aggregation function that is defined in the column sort.</p>"
}
},
"documentation":"<p>The sort configuration for a column that is not used in a field well.</p>"
},
"ColumnTag":{
"type":"structure",
"members":{
"ColumnGeographicRole":{
"shape":"GeoSpatialDataRole",
"documentation":"<p>A geospatial role for a column.</p>"
},
"ColumnDescription":{
"shape":"ColumnDescription",
"documentation":"<p>A description for a column.</p>"
}
},
"documentation":"<p>A tag for a column in a <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html\">TagColumnOperation</a> </code> structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"ColumnTagList":{
"type":"list",
"member":{"shape":"ColumnTag"},
"max":16,
"min":1
},
"ColumnTagName":{
"type":"string",
"enum":[
"COLUMN_GEOGRAPHIC_ROLE",
"COLUMN_DESCRIPTION"
]
},
"ColumnTagNames":{
"type":"list",
"member":{"shape":"ColumnTagName"}
},
"ColumnTooltipItem":{
"type":"structure",
"required":["Column"],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The target column of the tooltip item.</p>"
},
"Label":{
"shape":"String",
"documentation":"<p>The label of the tooltip item.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the tooltip item.</p>"
},
"Aggregation":{
"shape":"AggregationFunction",
"documentation":"<p>The aggregation function of the column tooltip item.</p>"
}
},
"documentation":"<p>The tooltip item for the columns that are not part of a field well.</p>"
},
"ComboChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Category":{
"shape":"DimensionFieldList",
"documentation":"<p>The aggregated category field wells of a combo chart.</p>"
},
"BarValues":{
"shape":"MeasureFieldList",
"documentation":"<p>The aggregated <code>BarValues</code> field well of a combo chart.</p>"
},
"Colors":{
"shape":"DimensionFieldList",
"documentation":"<p>The aggregated colors field well of a combo chart.</p>"
},
"LineValues":{
"shape":"MeasureFieldList",
"documentation":"<p>The aggregated <code>LineValues</code> field well of a combo chart.</p>"
}
},
"documentation":"<p>The aggregated field wells of a combo chart.</p>"
},
"ComboChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"ComboChartFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"ComboChartSortConfiguration",
"documentation":"<p>The sort configuration of a <code>ComboChartVisual</code>.</p>"
},
"BarsArrangement":{
"shape":"BarsArrangement",
"documentation":"<p>Determines the bar arrangement in a combo chart. The following are valid values in this structure:</p> <ul> <li> <p> <code>CLUSTERED</code>: For clustered bar combo charts.</p> </li> <li> <p> <code>STACKED</code>: For stacked bar combo charts.</p> </li> <li> <p> <code>STACKED_PERCENT</code>: Do not use. If you use this value, the operation returns a validation error.</p> </li> </ul>"
},
"CategoryAxis":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The category axis of a combo chart.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.</p>"
},
"PrimaryYAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.</p>"
},
"PrimaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.</p>"
},
"SecondaryYAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.</p>"
},
"SecondaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.</p>"
},
"ColorLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"BarDataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p> <p>The data label options for a bar in a combo chart.</p>"
},
"LineDataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p> <p>The data label options for a line in a combo chart.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"ReferenceLines":{
"shape":"ReferenceLineList",
"documentation":"<p>The reference line setup of the visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The palette (chart color) display setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a <code>ComboChartVisual</code>.</p>"
},
"ComboChartFieldWells":{
"type":"structure",
"members":{
"ComboChartAggregatedFieldWells":{
"shape":"ComboChartAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.</p>"
}
},
"documentation":"<p>The field wells of the visual.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ComboChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the category field well in a combo chart.</p>"
},
"CategoryItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The item limit configuration for the category field well of a combo chart.</p>"
},
"ColorSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the color field well in a combo chart.</p>"
},
"ColorItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The item limit configuration of the color field well in a combo chart.</p>"
}
},
"documentation":"<p>The sort configuration of a <code>ComboChartVisual</code>.</p>"
},
"ComboChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"ComboChartConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A combo chart.</p> <p>The <code>ComboChartVisual</code> includes stacked bar combo charts and clustered bar combo charts</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html\">Using combo charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ComparisonConfiguration":{
"type":"structure",
"members":{
"ComparisonMethod":{
"shape":"ComparisonMethod",
"documentation":"<p>The method of the comparison. Choose from the following options:</p> <ul> <li> <p> <code>DIFFERENCE</code> </p> </li> <li> <p> <code>PERCENT_DIFFERENCE</code> </p> </li> <li> <p> <code>PERCENT</code> </p> </li> </ul>"
},
"ComparisonFormat":{
"shape":"ComparisonFormatConfiguration",
"documentation":"<p>The format of the comparison.</p>"
}
},
"documentation":"<p>The comparison display configuration of a KPI or gauge chart.</p>"
},
"ComparisonFormatConfiguration":{
"type":"structure",
"members":{
"NumberDisplayFormatConfiguration":{
"shape":"NumberDisplayFormatConfiguration",
"documentation":"<p>The number display format.</p>"
},
"PercentageDisplayFormatConfiguration":{
"shape":"PercentageDisplayFormatConfiguration",
"documentation":"<p>The percentage display format.</p>"
}
},
"documentation":"<p>The format of the comparison.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ComparisonMethod":{
"type":"string",
"enum":[
"DIFFERENCE",
"PERCENT_DIFFERENCE",
"PERCENT"
]
},
"Computation":{
"type":"structure",
"members":{
"TopBottomRanked":{
"shape":"TopBottomRankedComputation",
"documentation":"<p>The top ranked and bottom ranked computation configuration.</p>"
},
"TopBottomMovers":{
"shape":"TopBottomMoversComputation",
"documentation":"<p>The top movers and bottom movers computation configuration.</p>"
},
"TotalAggregation":{
"shape":"TotalAggregationComputation",
"documentation":"<p>The total aggregation computation configuration.</p>"
},
"MaximumMinimum":{
"shape":"MaximumMinimumComputation",
"documentation":"<p>The maximum and minimum computation configuration.</p>"
},
"MetricComparison":{
"shape":"MetricComparisonComputation",
"documentation":"<p>The metric comparison computation configuration.</p>"
},
"PeriodOverPeriod":{
"shape":"PeriodOverPeriodComputation",
"documentation":"<p>The period over period computation configuration.</p>"
},
"PeriodToDate":{
"shape":"PeriodToDateComputation",
"documentation":"<p>The period to <code>DataSetIdentifier</code> computation configuration.</p>"
},
"GrowthRate":{
"shape":"GrowthRateComputation",
"documentation":"<p>The growth rate computation configuration.</p>"
},
"UniqueValues":{
"shape":"UniqueValuesComputation",
"documentation":"<p>The unique values computation configuration.</p>"
},
"Forecast":{
"shape":"ForecastComputation",
"documentation":"<p>The forecast computation configuration.</p>"
}
},
"documentation":"<p>The computation union that is used in an insight visual.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ComputationList":{
"type":"list",
"member":{"shape":"Computation"},
"max":100
},
"ConcurrentUpdatingException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{"shape":"String"}
},
"documentation":"<p>A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.</p>",
"error":{"httpStatusCode":500},
"exception":true
},
"ConditionalFormattingColor":{
"type":"structure",
"members":{
"Solid":{
"shape":"ConditionalFormattingSolidColor",
"documentation":"<p>Formatting configuration for solid color.</p>"
},
"Gradient":{
"shape":"ConditionalFormattingGradientColor",
"documentation":"<p>Formatting configuration for gradient color.</p>"
}
},
"documentation":"<p>The formatting configuration for the color.</p>"
},
"ConditionalFormattingCustomIconCondition":{
"type":"structure",
"required":[
"Expression",
"IconOptions"
],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression that determines the condition of the icon set.</p>"
},
"IconOptions":{
"shape":"ConditionalFormattingCustomIconOptions",
"documentation":"<p>Custom icon options for an icon set.</p>"
},
"Color":{
"shape":"HexColor",
"documentation":"<p>Determines the color of the icon.</p>"
},
"DisplayConfiguration":{
"shape":"ConditionalFormattingIconDisplayConfiguration",
"documentation":"<p>Determines the icon display configuration.</p>"
}
},
"documentation":"<p>Determines the custom condition for an icon set.</p>"
},
"ConditionalFormattingCustomIconOptions":{
"type":"structure",
"members":{
"Icon":{
"shape":"Icon",
"documentation":"<p>Determines the type of icon.</p>"
},
"UnicodeIcon":{
"shape":"UnicodeIcon",
"documentation":"<p>Determines the Unicode icon type.</p>"
}
},
"documentation":"<p>Custom icon options for an icon set.</p>"
},
"ConditionalFormattingGradientColor":{
"type":"structure",
"required":[
"Expression",
"Color"
],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression that determines the formatting configuration for gradient color.</p>"
},
"Color":{
"shape":"GradientColor",
"documentation":"<p>Determines the color.</p>"
}
},
"documentation":"<p>Formatting configuration for gradient color.</p>"
},
"ConditionalFormattingIcon":{
"type":"structure",
"members":{
"IconSet":{
"shape":"ConditionalFormattingIconSet",
"documentation":"<p>Formatting configuration for icon set.</p>"
},
"CustomCondition":{
"shape":"ConditionalFormattingCustomIconCondition",
"documentation":"<p>Determines the custom condition for an icon set.</p>"
}
},
"documentation":"<p>The formatting configuration for the icon.</p>"
},
"ConditionalFormattingIconDisplayConfiguration":{
"type":"structure",
"members":{
"IconDisplayOption":{
"shape":"ConditionalFormattingIconDisplayOption",
"documentation":"<p>Determines the icon display configuration.</p>"
}
},
"documentation":"<p>Determines the icon display configuration.</p>"
},
"ConditionalFormattingIconDisplayOption":{
"type":"string",
"enum":["ICON_ONLY"]
},
"ConditionalFormattingIconSet":{
"type":"structure",
"required":["Expression"],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression that determines the formatting configuration for the icon set.</p>"
},
"IconSetType":{
"shape":"ConditionalFormattingIconSetType",
"documentation":"<p>Determines the icon set type.</p>"
}
},
"documentation":"<p>Formatting configuration for icon set.</p>"
},
"ConditionalFormattingIconSetType":{
"type":"string",
"enum":[
"PLUS_MINUS",
"CHECK_X",
"THREE_COLOR_ARROW",
"THREE_GRAY_ARROW",
"CARET_UP_MINUS_DOWN",
"THREE_SHAPE",
"THREE_CIRCLE",
"FLAGS",
"BARS",
"FOUR_COLOR_ARROW",
"FOUR_GRAY_ARROW"
]
},
"ConditionalFormattingSolidColor":{
"type":"structure",
"required":["Expression"],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression that determines the formatting configuration for solid color.</p>"
},
"Color":{
"shape":"HexColor",
"documentation":"<p>Determines the color.</p>"
}
},
"documentation":"<p>Formatting configuration for solid color.</p>"
},
"ConflictException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>Updating or deleting a resource can cause an inconsistent state.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ContributionAnalysisDefault":{
"type":"structure",
"required":[
"MeasureFieldId",
"ContributorDimensions"
],
"members":{
"MeasureFieldId":{
"shape":"FieldId",
"documentation":"<p>The measure field that is used in the contribution analysis.</p>"
},
"ContributorDimensions":{
"shape":"ContributorDimensionList",
"documentation":"<p>The dimensions columns that are used in the contribution analysis, usually a list of <code>ColumnIdentifiers</code>.</p>"
}
},
"documentation":"<p>The contribution analysis visual display for a line, pie, or bar chart.</p>"
},
"ContributionAnalysisDefaultList":{
"type":"list",
"member":{"shape":"ContributionAnalysisDefault"},
"max":200,
"min":1
},
"ContributorDimensionList":{
"type":"list",
"member":{"shape":"ColumnIdentifier"},
"max":4,
"min":1
},
"CopySourceArn":{
"type":"string",
"pattern":"^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+"
},
"CreateAccountCustomizationRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AccountCustomization"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that you want to add customizations to.</p>",
"location":"querystring",
"locationName":"namespace"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>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. </p> <p>For example, you can add a default theme by setting <code>AccountCustomization</code> to the midnight theme: <code>\"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }</code>. Or, you can add a custom theme by specifying <code>\"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }</code>. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tags that you want to attach to this resource.</p>"
}
}
},
"CreateAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the customization you're creating. </p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateAccountSubscriptionRequest":{
"type":"structure",
"required":[
"Edition",
"AuthenticationMethod",
"AwsAccountId",
"AccountName",
"NotificationEmail"
],
"members":{
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from <code>ENTERPRISE</code> or <code>ENTERPRISE_AND_Q</code>.</p> <p>If you choose <code>ENTERPRISE_AND_Q</code>, the following parameters are required:</p> <ul> <li> <p> <code>FirstName</code> </p> </li> <li> <p> <code>LastName</code> </p> </li> <li> <p> <code>EmailAddress</code> </p> </li> <li> <p> <code>ContactNumber</code> </p> </li> </ul>"
},
"AuthenticationMethod":{
"shape":"AuthenticationMethodOption",
"documentation":"<p>The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are <code>IAM_AND_QUICKSIGHT</code>, <code>IAM_ONLY</code>, and <code>ACTIVE_DIRECTORY</code>.</p> <p>If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code> and an <code>AdminGroup</code> associated with your Active Directory.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AccountName":{
"shape":"String",
"documentation":"<p>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 <code>AccountName</code> value after the Amazon QuickSight account is created.</p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.</p>"
},
"ActiveDirectoryName":{
"shape":"String",
"documentation":"<p>The name of your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>"
},
"Realm":{
"shape":"String",
"documentation":"<p>The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.</p>"
},
"DirectoryId":{
"shape":"String",
"documentation":"<p>The ID of the Active Directory that is associated with your Amazon QuickSight account.</p>"
},
"AdminGroup":{
"shape":"GroupsList",
"documentation":"<p>The admin group associated with your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>"
},
"AuthorGroup":{
"shape":"GroupsList",
"documentation":"<p>The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.</p>"
},
"ReaderGroup":{
"shape":"GroupsList",
"documentation":"<p>The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FirstName":{
"shape":"String",
"documentation":"<p>The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p>"
},
"LastName":{
"shape":"String",
"documentation":"<p>The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p>"
},
"EmailAddress":{
"shape":"String",
"documentation":"<p>The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p>"
},
"ContactNumber":{
"shape":"String",
"documentation":"<p>A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.</p>"
}
}
},
"CreateAccountSubscriptionResponse":{
"type":"structure",
"members":{
"SignupResponse":{
"shape":"SignupResponse",
"documentation":"<p>A <code>SignupResponse</code> object that returns information about a newly created Amazon QuickSight account.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account where you are creating an analysis.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. </p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>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. </p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis. You can use the <code>Permissions</code> 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). </p> <p>To specify no permissions, omit <code>Permissions</code>.</p>"
},
"SourceEntity":{
"shape":"AnalysisSourceEntity",
"documentation":"<p>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.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>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.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>"
},
"Definition":{
"shape":"AnalysisDefinition",
"documentation":"<p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"CreateAnalysisResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the analysis.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the creation of the analysis. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateColumnsOperation":{
"type":"structure",
"required":["Columns"],
"members":{
"Columns":{
"shape":"CalculatedColumnList",
"documentation":"<p>Calculated columns to create.</p>"
}
},
"documentation":"<p>A transform operation that creates calculated columns. Columns created in one such operation form a lexical closure.</p>"
},
"CreateDashboardRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account where you want to create the dashboard.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard, also added to the IAM policy.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"Name":{
"shape":"DashboardName",
"documentation":"<p>The display name of the dashboard.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>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. </p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>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. </p> <p>To specify no permissions, omit the permissions list.</p>"
},
"SourceEntity":{
"shape":"DashboardSourceEntity",
"documentation":"<p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description for the first version of the dashboard being created.</p>"
},
"DashboardPublishOptions":{
"shape":"DashboardPublishOptions",
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>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.</p>"
},
"Definition":{
"shape":"DashboardVersionDefinition",
"documentation":"<p>The definition of a dashboard.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"CreateDashboardResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dashboard.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dashboard, including the version number of the first version that is created.</p>"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the dashboard creation request.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId",
"Name",
"PhysicalTableMap",
"ImportMode"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>The display name for the dataset.</p>"
},
"PhysicalTableMap":{
"shape":"PhysicalTableMap",
"documentation":"<p>Declares the physical tables that are available in the underlying data sources.</p>"
},
"LogicalTableMap":{
"shape":"LogicalTableMap",
"documentation":"<p>Configures the combination and transformation of the data from the physical tables.</p>"
},
"ImportMode":{
"shape":"DataSetImportMode",
"documentation":"<p>Indicates whether you want to import the data into SPICE.</p>"
},
"ColumnGroups":{
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the dataset.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the data that you want to create.</p>"
},
"RowLevelPermissionTagConfiguration":{
"shape":"RowLevelPermissionTagConfiguration",
"documentation":"<p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>"
},
"ColumnLevelPermissionRules":{
"shape":"ColumnLevelPermissionRuleList",
"documentation":"<p>A set of one or more definitions of a <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html\">ColumnLevelPermissionRule</a> </code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>"
},
"DataSetUsageConfiguration":{"shape":"DataSetUsageConfiguration"}
}
},
"CreateDataSetResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"IngestionArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>"
},
"IngestionId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId",
"Name",
"Type"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the data source.</p>"
},
"Type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source. To return a list of all data sources, use <code>ListDataSources</code>.</p> <p>Use <code>AMAZON_ELASTICSEARCH</code> for Amazon OpenSearch Service.</p>"
},
"DataSourceParameters":{
"shape":"DataSourceParameters",
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>"
},
"Credentials":{
"shape":"DataSourceCredentials",
"documentation":"<p>The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the data source.</p>"
},
"VpcConnectionProperties":{
"shape":"VpcConnectionProperties",
"documentation":"<p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>"
}
}
},
"CreateDataSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The status of creating the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateFolderMembershipRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId",
"MemberId",
"MemberType"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
},
"MemberId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the asset (the dashboard, analysis, or dataset).</p>",
"location":"uri",
"locationName":"MemberId"
},
"MemberType":{
"shape":"MemberType",
"documentation":"<p>The type of the member, including <code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code>.</p>",
"location":"uri",
"locationName":"MemberType"
}
}
},
"CreateFolderMembershipResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>"
},
"FolderMember":{
"shape":"FolderMember",
"documentation":"<p>Information about the member in the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateFolderRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account where you want to create the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
},
"Name":{
"shape":"FolderName",
"documentation":"<p>The name of the folder.</p>"
},
"FolderType":{
"shape":"FolderType",
"documentation":"<p>The type of folder. By default, <code>folderType</code> is <code>SHARED</code>.</p>"
},
"ParentFolderArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the parent folder.</p> <p> <code>ParentFolderArn</code> can be null. An empty <code>parentFolderArn</code> creates a root-level folder.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions of a folder.</p> <p>To specify no permissions, omit <code>Permissions</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Tags for the folder.</p>"
}
}
},
"CreateFolderResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the newly created folder.</p>"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The folder ID for the newly created folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The request ID for the newly created folder.</p>"
}
}
},
"CreateGroupMembershipRequest":{
"type":"structure",
"required":[
"MemberName",
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The name of the user that you want to add to the group membership.</p>",
"location":"uri",
"locationName":"MemberName"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to add the user to.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want the user to be a part of.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"CreateGroupMembershipResponse":{
"type":"structure",
"members":{
"GroupMember":{
"shape":"GroupMember",
"documentation":"<p>The group member.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>A name for the group that you want to create.</p>"
},
"Description":{
"shape":"GroupDescription",
"documentation":"<p>A description for the group that you want to create.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want the group to be a part of.</p>",
"location":"uri",
"locationName":"Namespace"
}
},
"documentation":"<p>The request object for this operation. </p>"
},
"CreateGroupResponse":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The name of the group.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
},
"documentation":"<p>The response object for this operation.</p>"
},
"CreateIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"AssignmentStatus",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment, also called a rule. It must be unique within an Amazon Web Services account.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that contains the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"CreateIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. This name must be unique within the Amazon Web Services account.</p>"
},
"AssignmentId":{
"shape":"String",
"documentation":"<p>The ID for the assignment.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateIngestionRequest":{
"type":"structure",
"required":[
"DataSetId",
"IngestionId",
"AwsAccountId"
],
"members":{
"DataSetId":{
"shape":"String",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>",
"location":"uri",
"locationName":"IngestionId"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"IngestionType":{
"shape":"IngestionType",
"documentation":"<p>The type of ingestion that you want to create.</p>"
}
}
},
"CreateIngestionResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data ingestion.</p>"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>"
},
"IngestionStatus":{
"shape":"IngestionStatus",
"documentation":"<p>The ingestion status.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateNamespaceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace",
"IdentityStore"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The name that you want to use to describe the new namespace.</p>"
},
"IdentityStore":{
"shape":"IdentityStore",
"documentation":"<p>Specifies the type of your user identity directory. Currently, this supports users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that you want to associate with the namespace that you're creating.</p>"
}
}
},
"CreateNamespaceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the Amazon QuickSight namespace you created. </p>"
},
"Name":{
"shape":"Namespace",
"documentation":"<p>The name of the new namespace that you created.</p>"
},
"CapacityRegion":{
"shape":"String",
"documentation":"<p>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. </p>"
},
"CreationStatus":{
"shape":"NamespaceStatus",
"documentation":"<p>The status of the creation of the namespace. This is an asynchronous process. A status of <code>CREATED</code> means that your namespace is ready to use. If an error occurs, it indicates if the process is <code>retryable</code> or <code>non-retryable</code>. In the case of a non-retryable error, refer to the error message for follow-up tasks.</p>"
},
"IdentityStore":{
"shape":"IdentityStore",
"documentation":"<p>Specifies the type of your user identity directory. Currently, this supports users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateTemplateAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId",
"AliasName",
"TemplateVersionNumber"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template that you creating an alias for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name that you want to give to the template alias that you're creating. Don't start the alias name with the <code>$</code> character. Alias names that start with <code>$</code> are reserved by Amazon QuickSight. </p>",
"location":"uri",
"locationName":"AliasName"
},
"TemplateVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template.</p>"
}
}
},
"CreateTemplateAliasResponse":{
"type":"structure",
"members":{
"TemplateAlias":{
"shape":"TemplateAlias",
"documentation":"<p>Information about the template alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>A display name for the template.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions to be set on the template. </p>"
},
"SourceEntity":{
"shape":"TemplateSourceEntity",
"documentation":"<p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>"
},
"Definition":{
"shape":"TemplateVersionDefinition",
"documentation":"<p>The definition of a template.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"CreateTemplateResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the template.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the template, including the version information of the first version.</p>"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the template.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The template creation status.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateThemeAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"AliasName",
"ThemeVersionNumber"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme for the new theme alias.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the theme alias.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name that you want to give to the theme alias that you are creating. The alias name can't begin with a <code>$</code>. Alias names that start with <code>$</code> are reserved by Amazon QuickSight. </p>",
"location":"uri",
"locationName":"AliasName"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme.</p>"
}
}
},
"CreateThemeAliasResponse":{
"type":"structure",
"members":{
"ThemeAlias":{
"shape":"ThemeAlias",
"documentation":"<p>Information about the theme alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CreateThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"Name",
"BaseThemeId",
"Configuration"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account where you want to store the new theme. </p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>A display name for the theme.</p>"
},
"BaseThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>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 <code>ListThemes</code> or choose <b>Themes</b> from within an analysis. </p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the first version of the theme that you're creating. Every time <code>UpdateTheme</code> is called, a new version is created. Each version of the theme has a description of the version in the <code>VersionDescription</code> field.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A valid grouping of resource permissions to apply to the new theme. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A map of the key-value pairs for the resource tag or tags that you want to add to the resource.</p>"
}
}
},
"CreateThemeResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the new theme.</p>"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the theme.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The theme creation status.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"CredentialPair":{
"type":"structure",
"required":[
"Username",
"Password"
],
"members":{
"Username":{
"shape":"Username",
"documentation":"<p>User name.</p>"
},
"Password":{
"shape":"Password",
"documentation":"<p>Password.</p>"
},
"AlternateDataSourceParameters":{
"shape":"DataSourceParametersList",
"documentation":"<p>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 <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> 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 <code>AlternateDataSourceParameters</code> list is null, the <code>DataSourceParameters</code> originally used with these <code>Credentials</code> is automatically allowed.</p>"
}
},
"documentation":"<p>The combination of user name and password that are used as credentials.</p>"
},
"CrossDatasetTypes":{
"type":"string",
"enum":[
"ALL_DATASETS",
"SINGLE_DATASET"
]
},
"CurrencyCode":{
"type":"string",
"pattern":"[A-Z]{3}"
},
"CurrencyDisplayFormatConfiguration":{
"type":"structure",
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"<p>Determines the prefix value of the currency format.</p>"
},
"Suffix":{
"shape":"Suffix",
"documentation":"<p>Determines the suffix value of the currency format.</p>"
},
"SeparatorConfiguration":{
"shape":"NumericSeparatorConfiguration",
"documentation":"<p>The options that determine the numeric separator configuration.</p>"
},
"Symbol":{
"shape":"CurrencyCode",
"documentation":"<p>Determines the symbol for the currency format.</p>"
},
"DecimalPlacesConfiguration":{
"shape":"DecimalPlacesConfiguration",
"documentation":"<p>The option that determines the decimal places configuration.</p>"
},
"NumberScale":{
"shape":"NumberScale",
"documentation":"<p>Determines the number scale value for the currency format.</p>"
},
"NegativeValueConfiguration":{
"shape":"NegativeValueConfiguration",
"documentation":"<p>The options that determine the negative value configuration.</p>"
},
"NullValueFormatConfiguration":{
"shape":"NullValueFormatConfiguration",
"documentation":"<p>The options that determine the null value format configuration.</p>"
}
},
"documentation":"<p>The options that determine the currency display format configuration.</p>"
},
"CustomActionFilterOperation":{
"type":"structure",
"required":[
"SelectedFieldsConfiguration",
"TargetVisualsConfiguration"
],
"members":{
"SelectedFieldsConfiguration":{
"shape":"FilterOperationSelectedFieldsConfiguration",
"documentation":"<p>The configuration that chooses the fields to be filtered.</p>"
},
"TargetVisualsConfiguration":{
"shape":"FilterOperationTargetVisualsConfiguration",
"documentation":"<p>The configuration that chooses the target visuals to be filtered.</p>"
}
},
"documentation":"<p>The filter operation that filters data included in a visual or in an entire sheet.</p>"
},
"CustomActionNavigationOperation":{
"type":"structure",
"members":{
"LocalNavigationConfiguration":{
"shape":"LocalNavigationConfiguration",
"documentation":"<p>The configuration that chooses the navigation target.</p>"
}
},
"documentation":"<p>The navigation operation that navigates between different sheets in the same analysis.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"CustomActionSetParametersOperation":{
"type":"structure",
"required":["ParameterValueConfigurations"],
"members":{
"ParameterValueConfigurations":{
"shape":"SetParameterValueConfigurationList",
"documentation":"<p>The parameter that determines the value configuration.</p>"
}
},
"documentation":"<p>The set parameter operation that sets parameters in custom action.</p>"
},
"CustomActionURLOperation":{
"type":"structure",
"required":[
"URLTemplate",
"URLTarget"
],
"members":{
"URLTemplate":{
"shape":"URLOperationTemplate",
"documentation":"<p>THe URL link of the <code>CustomActionURLOperation</code>.</p>"
},
"URLTarget":{
"shape":"URLTargetConfiguration",
"documentation":"<p>The target of the <code>CustomActionURLOperation</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>NEW_TAB</code>: Opens the target URL in a new browser tab.</p> </li> <li> <p> <code>NEW_WINDOW</code>: Opens the target URL in a new browser window.</p> </li> <li> <p> <code>SAME_TAB</code>: Opens the target URL in the same browser tab.</p> </li> </ul>"
}
},
"documentation":"<p>The URL operation that opens a link to another webpage.</p>"
},
"CustomContentConfiguration":{
"type":"structure",
"members":{
"ContentUrl":{
"shape":"URLOperationTemplate",
"documentation":"<p>The input URL that links to the custom content that you want in the custom visual.</p>"
},
"ContentType":{
"shape":"CustomContentType",
"documentation":"<p>The content type of the custom content visual. You can use this to have the visual render as an image.</p>"
},
"ImageScaling":{
"shape":"CustomContentImageScalingConfiguration",
"documentation":"<p>The sizing options for the size of the custom content visual. This structure is required when the <code>ContentType</code> of the visual is <code>'IMAGE'</code>.</p>"
}
},
"documentation":"<p>The configuration of a <code>CustomContentVisual</code>.</p>"
},
"CustomContentImageScalingConfiguration":{
"type":"string",
"enum":[
"FIT_TO_HEIGHT",
"FIT_TO_WIDTH",
"DO_NOT_SCALE",
"SCALE_TO_VISUAL"
]
},
"CustomContentType":{
"type":"string",
"enum":[
"IMAGE",
"OTHER_EMBEDDED_CONTENT"
]
},
"CustomContentVisual":{
"type":"structure",
"required":[
"VisualId",
"DataSetIdentifier"
],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"CustomContentConfiguration",
"documentation":"<p>The configuration of a <code>CustomContentVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The dataset that is used to create the custom content visual. You can't create a visual without a dataset.</p>"
}
},
"documentation":"<p>A visual that contains custom content.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html\">Using custom visual content</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CustomFilterConfiguration":{
"type":"structure",
"required":[
"MatchOperator",
"NullOption"
],
"members":{
"MatchOperator":{
"shape":"CategoryFilterMatchOperator",
"documentation":"<p>The match operator that is used to determine if a filter should be applied.</p>"
},
"CategoryValue":{
"shape":"CategoryValue",
"documentation":"<p>The category value for the filter.</p> <p>This field is mutually exclusive to <code>ParameterName</code>.</p>"
},
"SelectAllOptions":{
"shape":"CategoryFilterSelectAllOptions",
"documentation":"<p>Select all of the values. Null is not the assigned value of select all.</p> <ul> <li> <p> <code>FILTER_ALL_VALUES</code> </p> </li> </ul>"
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The parameter whose value should be used for the filter value.</p> <p>This field is mutually exclusive to <code>CategoryValue</code>.</p>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
}
},
"documentation":"<p>A custom filter that filters based on a single value. This filter can be partially matched.</p>"
},
"CustomFilterListConfiguration":{
"type":"structure",
"required":[
"MatchOperator",
"NullOption"
],
"members":{
"MatchOperator":{
"shape":"CategoryFilterMatchOperator",
"documentation":"<p>The match operator that is used to determine if a filter should be applied.</p>"
},
"CategoryValues":{
"shape":"CategoryValueList",
"documentation":"<p>The list of category values for the filter.</p>"
},
"SelectAllOptions":{
"shape":"CategoryFilterSelectAllOptions",
"documentation":"<p>Select all of the values. Null is not the assigned value of select all.</p> <ul> <li> <p> <code>FILTER_ALL_VALUES</code> </p> </li> </ul>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
}
},
"documentation":"<p>A list of custom filter values.</p>"
},
"CustomLabel":{
"type":"string",
"max":2048,
"min":1
},
"CustomNarrativeOptions":{
"type":"structure",
"required":["Narrative"],
"members":{
"Narrative":{
"shape":"NarrativeString",
"documentation":"<p>The string input of custom narrative.</p>"
}
},
"documentation":"<p>The custom narrative options.</p>"
},
"CustomParameterValues":{
"type":"structure",
"members":{
"StringValues":{
"shape":"StringDefaultValueList",
"documentation":"<p>A list of string-type parameter values.</p>"
},
"IntegerValues":{
"shape":"IntegerDefaultValueList",
"documentation":"<p>A list of integer-type parameter values.</p>"
},
"DecimalValues":{
"shape":"DecimalDefaultValueList",
"documentation":"<p>A list of decimal-type parameter values.</p>"
},
"DateTimeValues":{
"shape":"DateTimeDefaultValueList",
"documentation":"<p>A list of datetime-type parameter values.</p>"
}
},
"documentation":"<p>The customized parameter values.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"CustomSql":{
"type":"structure",
"required":[
"DataSourceArn",
"Name",
"SqlQuery"
],
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"Name":{
"shape":"CustomSqlName",
"documentation":"<p>A display name for the SQL query result.</p>"
},
"SqlQuery":{
"shape":"SqlQuery",
"documentation":"<p>The SQL query.</p>"
},
"Columns":{
"shape":"InputColumnList",
"documentation":"<p>The column schema from the SQL query result set.</p>"
}
},
"documentation":"<p>A physical table type built from the results of the custom SQL query.</p>"
},
"CustomSqlName":{
"type":"string",
"max":64,
"min":1
},
"CustomValuesConfiguration":{
"type":"structure",
"required":["CustomValues"],
"members":{
"IncludeNullValue":{
"shape":"BooleanObject",
"documentation":"<p>Includes the null value in custom action parameter values.</p>"
},
"CustomValues":{"shape":"CustomParameterValues"}
},
"documentation":"<p>The configuration of custom values for the destination parameter in <code>DestinationParameterValueConfiguration</code>.</p>"
},
"Dashboard":{
"type":"structure",
"members":{
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>Dashboard ID.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Name":{
"shape":"DashboardName",
"documentation":"<p>A display name for the dashboard.</p>"
},
"Version":{
"shape":"DashboardVersion",
"documentation":"<p>Version.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dashboard was created.</p>"
},
"LastPublishedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dashboard was published.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dashboard was updated.</p>"
}
},
"documentation":"<p>Dashboard.</p>"
},
"DashboardBehavior":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"DashboardError":{
"type":"structure",
"members":{
"Type":{
"shape":"DashboardErrorType",
"documentation":"<p>Type.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>Message.</p>"
},
"ViolatedEntities":{
"shape":"EntityList",
"documentation":"<p/>"
}
},
"documentation":"<p>Dashboard error.</p>"
},
"DashboardErrorList":{
"type":"list",
"member":{"shape":"DashboardError"},
"min":1
},
"DashboardErrorType":{
"type":"string",
"enum":[
"ACCESS_DENIED",
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"PARAMETER_VALUE_INCOMPATIBLE",
"PARAMETER_TYPE_INVALID",
"PARAMETER_NOT_FOUND",
"COLUMN_TYPE_MISMATCH",
"COLUMN_GEOGRAPHIC_ROLE_MISMATCH",
"COLUMN_REPLACEMENT_MISSING"
]
},
"DashboardFilterAttribute":{
"type":"string",
"enum":[
"QUICKSIGHT_USER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DASHBOARD_NAME"
]
},
"DashboardName":{
"type":"string",
"max":2048,
"min":1
},
"DashboardPublishOptions":{
"type":"structure",
"members":{
"AdHocFilteringOption":{
"shape":"AdHocFilteringOption",
"documentation":"<p>Ad hoc (one-time) filtering option.</p>"
},
"ExportToCSVOption":{
"shape":"ExportToCSVOption",
"documentation":"<p>Export to .csv option.</p>"
},
"SheetControlsOption":{
"shape":"SheetControlsOption",
"documentation":"<p>Sheet controls option.</p>"
},
"VisualPublishOptions":{
"shape":"DashboardVisualPublishOptions",
"documentation":"<p/>"
}
},
"documentation":"<p>Dashboard publish options.</p>"
},
"DashboardSearchFilter":{
"type":"structure",
"required":["Operator"],
"members":{
"Operator":{
"shape":"FilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>. Valid values are <code>\"StringEquals\"</code> and <code>\"StringLike\"</code>.</p> <p>If you set the operator value to <code>\"StringEquals\"</code>, you need to provide an ownership related filter in the <code>\"NAME\"</code> field and the arn of the user or group whose folders you want to search in the <code>\"Value\"</code> field. For example, <code>\"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p> <p>If you set the value to <code>\"StringLike\"</code>, you need to provide the name of the folders you are searching for. For example, <code>\"Name\":\"DASHBOARD_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\"</code>. The <code>\"StringLike\"</code> operator only supports the <code>NAME</code> value <code>DASHBOARD_NAME</code>.</p>"
},
"Name":{
"shape":"DashboardFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example, <code>\"Name\": \"QUICKSIGHT_OWNER\"</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>DASHBOARD_NAME</code>: Any dashboards whose names have a substring match to this value will be returned.</p> </li> </ul>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter, for example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
}
},
"documentation":"<p>A filter that you apply when searching for dashboards. </p>"
},
"DashboardSearchFilterList":{
"type":"list",
"member":{"shape":"DashboardSearchFilter"},
"max":1,
"min":1
},
"DashboardSourceEntity":{
"type":"structure",
"members":{
"SourceTemplate":{
"shape":"DashboardSourceTemplate",
"documentation":"<p>Source template.</p>"
}
},
"documentation":"<p>Dashboard source entity.</p>"
},
"DashboardSourceTemplate":{
"type":"structure",
"required":[
"DataSetReferences",
"Arn"
],
"members":{
"DataSetReferences":{
"shape":"DataSetReferenceList",
"documentation":"<p>Dataset references.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
},
"documentation":"<p>Dashboard source template.</p>"
},
"DashboardSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>Dashboard ID.</p>"
},
"Name":{
"shape":"DashboardName",
"documentation":"<p>A display name for the dashboard.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dashboard was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dashboard was updated.</p>"
},
"PublishedVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>Published version number.</p>"
},
"LastPublishedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dashboard was published.</p>"
}
},
"documentation":"<p>Dashboard summary.</p>"
},
"DashboardSummaryList":{
"type":"list",
"member":{"shape":"DashboardSummary"},
"max":100
},
"DashboardUIState":{
"type":"string",
"enum":[
"EXPANDED",
"COLLAPSED"
]
},
"DashboardVersion":{
"type":"structure",
"members":{
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dashboard version was created.</p>"
},
"Errors":{
"shape":"DashboardErrorList",
"documentation":"<p>Errors associated with this dashboard version.</p>"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>Version number for this version of the dashboard.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The HTTP status of the request.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"SourceEntityArn":{
"shape":"Arn",
"documentation":"<p>Source entity ARN.</p>"
},
"DataSetArns":{
"shape":"DataSetArnsList",
"documentation":"<p>The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>Description.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme associated with a version of the dashboard.</p>"
},
"Sheets":{
"shape":"SheetList",
"documentation":"<p>A list of the associated sheets with the unique identifier and name of each sheet.</p>"
}
},
"documentation":"<p>Dashboard version.</p>"
},
"DashboardVersionDefinition":{
"type":"structure",
"required":["DataSetIdentifierDeclarations"],
"members":{
"DataSetIdentifierDeclarations":{
"shape":"DataSetIdentifierDeclarationList",
"documentation":"<p>An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.</p>"
},
"Sheets":{
"shape":"SheetDefinitionList",
"documentation":"<p>An array of sheet definitions for a dashboard.</p>"
},
"CalculatedFields":{
"shape":"CalculatedFields",
"documentation":"<p>An array of calculated field definitions for the dashboard.</p>"
},
"ParameterDeclarations":{
"shape":"ParameterDeclarationList",
"documentation":"<p>The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html\">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FilterGroups":{
"shape":"FilterGroupList",
"documentation":"<p>The filter definitions for a dashboard.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html\">Filtering Data in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ColumnConfigurations":{
"shape":"ColumnConfigurationList",
"documentation":"<p>An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard. </p>"
},
"AnalysisDefaults":{"shape":"AnalysisDefaults"}
},
"documentation":"<p>The contents of a dashboard.</p>"
},
"DashboardVersionSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dashboard version was created.</p>"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>Version number.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The HTTP status of the request.</p>"
},
"SourceEntityArn":{
"shape":"Arn",
"documentation":"<p>Source entity ARN.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>Description.</p>"
}
},
"documentation":"<p>Dashboard version summary.</p>"
},
"DashboardVersionSummaryList":{
"type":"list",
"member":{"shape":"DashboardVersionSummary"},
"max":100
},
"DashboardVisualId":{
"type":"structure",
"required":[
"DashboardId",
"SheetId",
"VisualId"
],
"members":{
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the dashboard that has the visual that you want to embed. The <code>DashboardId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>"
},
"SheetId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the sheet that the has visual that you want to embed. The <code>SheetId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>"
},
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the visual that you want to embed. The <code>VisualID</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console.</p>"
}
},
"documentation":"<p>A structure that contains the following elements:</p> <ul> <li> <p>The <code>DashboardId</code> of the dashboard that has the visual that you want to embed.</p> </li> <li> <p>The <code>SheetId</code> of the sheet that has the visual that you want to embed.</p> </li> <li> <p>The <code>VisualId</code> of the visual that you want to embed.</p> </li> </ul> <p>The <code>DashboardId</code>, <code>SheetId</code>, and <code>VisualId</code> can be found in the <code>IDs for developers</code> section of the <code>Embed visual</code> pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the <code>DashboardId</code> with a <code>ListDashboards</code> API operation.</p>"
},
"DashboardVisualPublishOptions":{
"type":"structure",
"members":{
"ExportHiddenFieldsOption":{
"shape":"ExportHiddenFieldsOption",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"DataColor":{
"type":"structure",
"members":{
"Color":{
"shape":"HexColor",
"documentation":"<p>The color that is applied to the data value.</p>"
},
"DataValue":{
"shape":"Double",
"documentation":"<p>The data value that the color is applied to.</p>",
"box":true
}
},
"documentation":"<p>Determines the color that is applied to a particular data value.</p>"
},
"DataColorPalette":{
"type":"structure",
"members":{
"Colors":{
"shape":"ColorList",
"documentation":"<p>The hexadecimal codes for the colors.</p>"
},
"MinMaxGradient":{
"shape":"ColorList",
"documentation":"<p>The minimum and maximum hexadecimal codes that describe a color gradient. </p>"
},
"EmptyFillColor":{
"shape":"HexColor",
"documentation":"<p>The hexadecimal code of a color that applies to charts where a lack of data is highlighted.</p>"
}
},
"documentation":"<p>The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. </p>"
},
"DataFieldSeriesItem":{
"type":"structure",
"required":[
"FieldId",
"AxisBinding"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the field that you are setting the axis binding to.</p>"
},
"FieldValue":{
"shape":"SensitiveString",
"documentation":"<p>The field value of the field that you are setting the axis binding to.</p>"
},
"AxisBinding":{
"shape":"AxisBinding",
"documentation":"<p>The axis that you are binding the field to.</p>"
},
"Settings":{
"shape":"LineChartSeriesSettings",
"documentation":"<p>The options that determine the presentation of line series associated to the field.</p>"
}
},
"documentation":"<p>The data field series item configuration of a line chart.</p>"
},
"DataLabelContent":{
"type":"string",
"enum":[
"VALUE",
"PERCENT",
"VALUE_AND_PERCENT"
]
},
"DataLabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the data labels.</p>"
},
"CategoryLabelVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the category field labels.</p>"
},
"MeasureLabelVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the measure field labels.</p>"
},
"DataLabelTypes":{
"shape":"DataLabelTypes",
"documentation":"<p>The option that determines the data label type.</p>"
},
"Position":{
"shape":"DataLabelPosition",
"documentation":"<p>Determines the position of the data labels.</p>"
},
"LabelContent":{
"shape":"DataLabelContent",
"documentation":"<p>Determines the content of the data labels.</p>"
},
"LabelFontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>Determines the font configuration of the data labels.</p>"
},
"LabelColor":{
"shape":"HexColor",
"documentation":"<p>Determines the color of the data labels.</p>"
},
"Overlap":{
"shape":"DataLabelOverlap",
"documentation":"<p>Determines whether overlap is enabled or disabled for the data labels.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the data labels.</p>"
},
"DataLabelOverlap":{
"type":"string",
"enum":[
"DISABLE_OVERLAP",
"ENABLE_OVERLAP"
]
},
"DataLabelPosition":{
"type":"string",
"enum":[
"INSIDE",
"OUTSIDE",
"LEFT",
"TOP",
"BOTTOM",
"RIGHT"
]
},
"DataLabelType":{
"type":"structure",
"members":{
"FieldLabelType":{
"shape":"FieldLabelType",
"documentation":"<p>Determines the label configuration for the entire field.</p>"
},
"DataPathLabelType":{
"shape":"DataPathLabelType",
"documentation":"<p>The option that specifies individual data values for labels.</p>"
},
"RangeEndsLabelType":{
"shape":"RangeEndsLabelType",
"documentation":"<p>Determines the label configuration for range end value in a visual.</p>"
},
"MinimumLabelType":{
"shape":"MinimumLabelType",
"documentation":"<p>Determines the label configuration for the minimum value in a visual.</p>"
},
"MaximumLabelType":{
"shape":"MaximumLabelType",
"documentation":"<p>Determines the label configuration for the maximum value in a visual.</p>"
}
},
"documentation":"<p>The option that determines the data label type.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"DataLabelTypes":{
"type":"list",
"member":{"shape":"DataLabelType"},
"max":100
},
"DataPathColor":{
"type":"structure",
"required":[
"Element",
"Color"
],
"members":{
"Element":{
"shape":"DataPathValue",
"documentation":"<p>The element that the color needs to be applied to.</p>"
},
"Color":{
"shape":"HexColor",
"documentation":"<p>The color that needs to be applied to the element.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The time granularity of the field that the color needs to be applied to.</p>"
}
},
"documentation":"<p>The color map that determines the color options for a particular element.</p>"
},
"DataPathColorList":{
"type":"list",
"member":{"shape":"DataPathColor"},
"max":5000
},
"DataPathLabelType":{
"type":"structure",
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the field that the data label needs to be applied to.</p>"
},
"FieldValue":{
"shape":"FieldValue",
"documentation":"<p>The actual value of the field that is labeled.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the data label.</p>"
}
},
"documentation":"<p>The option that specifies individual data values for labels.</p>"
},
"DataPathSort":{
"type":"structure",
"required":[
"Direction",
"SortPaths"
],
"members":{
"Direction":{
"shape":"SortDirection",
"documentation":"<p>Determines the sort direction.</p>"
},
"SortPaths":{
"shape":"DataPathValueList",
"documentation":"<p>The list of data paths that need to be sorted.</p>"
}
},
"documentation":"<p>Allows data paths to be sorted by a specific data value.</p>"
},
"DataPathValue":{
"type":"structure",
"required":[
"FieldId",
"FieldValue"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the field that needs to be sorted.</p>"
},
"FieldValue":{
"shape":"FieldValue",
"documentation":"<p>The actual value of the field that needs to be sorted.</p>"
}
},
"documentation":"<p>The data path that needs to be sorted.</p>"
},
"DataPathValueList":{
"type":"list",
"member":{"shape":"DataPathValue"},
"max":20
},
"DataSet":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the dataset.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the dataset.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dataset was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dataset was updated.</p>"
},
"PhysicalTableMap":{
"shape":"PhysicalTableMap",
"documentation":"<p>Declares the physical tables that are available in the underlying data sources.</p>"
},
"LogicalTableMap":{
"shape":"LogicalTableMap",
"documentation":"<p>Configures the combination and transformation of the data from the physical tables.</p>"
},
"OutputColumns":{
"shape":"OutputColumnList",
"documentation":"<p>The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.</p>"
},
"ImportMode":{
"shape":"DataSetImportMode",
"documentation":"<p>A value that indicates whether you want to import the data into SPICE.</p>"
},
"ConsumedSpiceCapacityInBytes":{
"shape":"Long",
"documentation":"<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.</p>"
},
"ColumnGroups":{
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the dataset.</p>"
},
"RowLevelPermissionTagConfiguration":{
"shape":"RowLevelPermissionTagConfiguration",
"documentation":"<p>The element you can use to define tags for row-level security.</p>"
},
"ColumnLevelPermissionRules":{
"shape":"ColumnLevelPermissionRuleList",
"documentation":"<p>A set of one or more definitions of a <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html\">ColumnLevelPermissionRule</a> </code>.</p>"
},
"DataSetUsageConfiguration":{
"shape":"DataSetUsageConfiguration",
"documentation":"<p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>"
}
},
"documentation":"<p>Dataset.</p>"
},
"DataSetArnsList":{
"type":"list",
"member":{"shape":"Arn"},
"max":100
},
"DataSetConfiguration":{
"type":"structure",
"members":{
"Placeholder":{
"shape":"String",
"documentation":"<p>Placeholder.</p>"
},
"DataSetSchema":{
"shape":"DataSetSchema",
"documentation":"<p>Dataset schema.</p>"
},
"ColumnGroupSchemaList":{
"shape":"ColumnGroupSchemaList",
"documentation":"<p>A structure containing the list of column group schemas.</p>"
}
},
"documentation":"<p>Dataset configuration.</p>"
},
"DataSetConfigurationList":{
"type":"list",
"member":{"shape":"DataSetConfiguration"},
"max":30
},
"DataSetFilterAttribute":{
"type":"string",
"enum":[
"QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DATASET_NAME"
]
},
"DataSetIdentifier":{
"type":"string",
"max":2048,
"min":1
},
"DataSetIdentifierDeclaration":{
"type":"structure",
"required":[
"Identifier",
"DataSetArn"
],
"members":{
"Identifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The identifier of the data set, typically the data set's name.</p>"
},
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data set.</p>"
}
},
"documentation":"<p>A data set.</p>"
},
"DataSetIdentifierDeclarationList":{
"type":"list",
"member":{"shape":"DataSetIdentifierDeclaration"},
"max":50,
"min":1
},
"DataSetImportMode":{
"type":"string",
"enum":[
"SPICE",
"DIRECT_QUERY"
]
},
"DataSetName":{
"type":"string",
"max":128,
"min":1
},
"DataSetReference":{
"type":"structure",
"required":[
"DataSetPlaceholder",
"DataSetArn"
],
"members":{
"DataSetPlaceholder":{
"shape":"NonEmptyString",
"documentation":"<p>Dataset placeholder.</p>"
},
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>Dataset Amazon Resource Name (ARN).</p>"
}
},
"documentation":"<p>Dataset reference.</p>"
},
"DataSetReferenceList":{
"type":"list",
"member":{"shape":"DataSetReference"},
"min":1
},
"DataSetSchema":{
"type":"structure",
"members":{
"ColumnSchemaList":{
"shape":"ColumnSchemaList",
"documentation":"<p>A structure containing the list of column schemas.</p>"
}
},
"documentation":"<p>Dataset schema.</p>"
},
"DataSetSearchFilter":{
"type":"structure",
"required":[
"Operator",
"Name",
"Value"
],
"members":{
"Operator":{
"shape":"FilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>. Valid values are <code>\"StringEquals\"</code> and <code>\"StringLike\"</code>.</p> <p>If you set the operator value to <code>\"StringEquals\"</code>, you need to provide an ownership related filter in the <code>\"NAME\"</code> field and the arn of the user or group whose datasets you want to search in the <code>\"Value\"</code> field. For example, <code>\"Name\":\"QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east- 1:1:user/default/UserName1\"</code>.</p> <p>If you set the value to <code>\"StringLike\"</code>, you need to provide the name of the datasets you are searching for. For example, <code>\"Name\":\"DATASET_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\"</code>. The <code>\"StringLike\"</code> operator only supports the <code>NAME</code> value <code>DATASET_NAME</code>.</p>"
},
"Name":{
"shape":"DataSetFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example, <code>\"Name\": \"QUICKSIGHT_OWNER\"</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>DATASET_NAME</code>: Any datasets whose names have a substring match to this value will be returned.</p> </li> </ul>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_OWNER</code>, that you want to use as a filter, for example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p>"
}
},
"documentation":"<p>A filter that you apply when searching for datasets.</p>"
},
"DataSetSearchFilterList":{
"type":"list",
"member":{"shape":"DataSetSearchFilter"},
"max":1,
"min":1
},
"DataSetSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the dataset.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the dataset.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this dataset was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this dataset was updated.</p>"
},
"ImportMode":{
"shape":"DataSetImportMode",
"documentation":"<p>A value that indicates whether you want to import the data into SPICE.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the dataset.</p>"
},
"RowLevelPermissionTagConfigurationApplied":{
"shape":"Boolean",
"documentation":"<p>Whether or not the row level permission tags are applied.</p>"
},
"ColumnLevelPermissionRulesApplied":{
"shape":"Boolean",
"documentation":"<p>A value that indicates if the dataset has column level permission configured.</p>"
}
},
"documentation":"<p>Dataset summary.</p>"
},
"DataSetSummaryList":{
"type":"list",
"member":{"shape":"DataSetSummary"}
},
"DataSetUsageConfiguration":{
"type":"structure",
"members":{
"DisableUseAsDirectQuerySource":{
"shape":"Boolean",
"documentation":"<p>An option that controls whether a child dataset of a direct query can use this dataset as a source.</p>"
},
"DisableUseAsImportedSource":{
"shape":"Boolean",
"documentation":"<p>An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.</p>"
}
},
"documentation":"<p>The usage configuration to apply to child datasets that reference this dataset as a source.</p>"
},
"DataSource":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the data source.</p>"
},
"Type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source. This type indicates which database engine the data source connects to.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The HTTP status of the request.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this data source was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this data source was updated.</p>"
},
"DataSourceParameters":{
"shape":"DataSourceParameters",
"documentation":"<p>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.</p>"
},
"AlternateDataSourceParameters":{
"shape":"DataSourceParametersList",
"documentation":"<p>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 <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the <code>AlternateDataSourceParameters</code> list is null, the <code>Credentials</code> originally used with this <code>DataSourceParameters</code> are automatically allowed.</p>"
},
"VpcConnectionProperties":{
"shape":"VpcConnectionProperties",
"documentation":"<p>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.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.</p>"
},
"ErrorInfo":{
"shape":"DataSourceErrorInfo",
"documentation":"<p>Error information from the last update or the creation of the data source.</p>"
},
"SecretArn":{
"shape":"SecretArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>"
}
},
"documentation":"<p>The structure of a data source.</p>"
},
"DataSourceCredentials":{
"type":"structure",
"members":{
"CredentialPair":{
"shape":"CredentialPair",
"documentation":"<p>Credential pair. For more information, see <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CredentialPair.html\">CredentialPair</a> </code>.</p>"
},
"CopySourceArn":{
"shape":"CopySourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When <code>CopySourceArn</code> is not null, the credential pair from the data source in the ARN is used as the credentials for the <code>DataSourceCredentials</code> structure.</p>"
},
"SecretArn":{
"shape":"SecretArn",
"documentation":"<p>The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.</p>"
}
},
"documentation":"<p>Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>",
"sensitive":true
},
"DataSourceErrorInfo":{
"type":"structure",
"members":{
"Type":{
"shape":"DataSourceErrorInfoType",
"documentation":"<p>Error type.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>Error message.</p>"
}
},
"documentation":"<p>Error information for the data source creation or update.</p>"
},
"DataSourceErrorInfoType":{
"type":"string",
"enum":[
"ACCESS_DENIED",
"COPY_SOURCE_NOT_FOUND",
"TIMEOUT",
"ENGINE_VERSION_NOT_SUPPORTED",
"UNKNOWN_HOST",
"GENERIC_SQL_FAILURE",
"CONFLICT",
"UNKNOWN"
]
},
"DataSourceFilterAttribute":{
"type":"string",
"enum":[
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DATASOURCE_NAME"
]
},
"DataSourceList":{
"type":"list",
"member":{"shape":"DataSource"}
},
"DataSourceParameters":{
"type":"structure",
"members":{
"AmazonElasticsearchParameters":{
"shape":"AmazonElasticsearchParameters",
"documentation":"<p>The parameters for OpenSearch.</p>"
},
"AthenaParameters":{
"shape":"AthenaParameters",
"documentation":"<p>The parameters for Amazon Athena.</p>"
},
"AuroraParameters":{
"shape":"AuroraParameters",
"documentation":"<p>The parameters for Amazon Aurora MySQL.</p>"
},
"AuroraPostgreSqlParameters":{
"shape":"AuroraPostgreSqlParameters",
"documentation":"<p>The parameters for Amazon Aurora.</p>"
},
"AwsIotAnalyticsParameters":{
"shape":"AwsIotAnalyticsParameters",
"documentation":"<p>The parameters for IoT Analytics.</p>"
},
"JiraParameters":{
"shape":"JiraParameters",
"documentation":"<p>The parameters for Jira.</p>"
},
"MariaDbParameters":{
"shape":"MariaDbParameters",
"documentation":"<p>The parameters for MariaDB.</p>"
},
"MySqlParameters":{
"shape":"MySqlParameters",
"documentation":"<p>The parameters for MySQL.</p>"
},
"OracleParameters":{
"shape":"OracleParameters",
"documentation":"<p>The parameters for Oracle.</p>"
},
"PostgreSqlParameters":{
"shape":"PostgreSqlParameters",
"documentation":"<p>The parameters for PostgreSQL.</p>"
},
"PrestoParameters":{
"shape":"PrestoParameters",
"documentation":"<p>The parameters for Presto.</p>"
},
"RdsParameters":{
"shape":"RdsParameters",
"documentation":"<p>The parameters for Amazon RDS.</p>"
},
"RedshiftParameters":{
"shape":"RedshiftParameters",
"documentation":"<p>The parameters for Amazon Redshift.</p>"
},
"S3Parameters":{
"shape":"S3Parameters",
"documentation":"<p>The parameters for S3.</p>"
},
"ServiceNowParameters":{
"shape":"ServiceNowParameters",
"documentation":"<p>The parameters for ServiceNow.</p>"
},
"SnowflakeParameters":{
"shape":"SnowflakeParameters",
"documentation":"<p>The parameters for Snowflake.</p>"
},
"SparkParameters":{
"shape":"SparkParameters",
"documentation":"<p>The parameters for Spark.</p>"
},
"SqlServerParameters":{
"shape":"SqlServerParameters",
"documentation":"<p>The parameters for SQL Server.</p>"
},
"TeradataParameters":{
"shape":"TeradataParameters",
"documentation":"<p>The parameters for Teradata.</p>"
},
"TwitterParameters":{
"shape":"TwitterParameters",
"documentation":"<p>The parameters for Twitter.</p>"
},
"AmazonOpenSearchParameters":{
"shape":"AmazonOpenSearchParameters",
"documentation":"<p>The parameters for OpenSearch.</p>"
},
"ExasolParameters":{
"shape":"ExasolParameters",
"documentation":"<p>The parameters for Exasol.</p>"
},
"DatabricksParameters":{
"shape":"DatabricksParameters",
"documentation":"<p>The required parameters that are needed to connect to a Databricks data source.</p>"
}
},
"documentation":"<p>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.</p>"
},
"DataSourceParametersList":{
"type":"list",
"member":{"shape":"DataSourceParameters"},
"max":50,
"min":1
},
"DataSourceSearchFilter":{
"type":"structure",
"required":[
"Operator",
"Name",
"Value"
],
"members":{
"Operator":{
"shape":"FilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>. Valid values are <code>\"StringEquals\"</code> and <code>\"StringLike\"</code>.</p> <p>If you set the operator value to <code>\"StringEquals\"</code>, you need to provide an ownership related filter in the <code>\"NAME\"</code> field and the arn of the user or group whose data sources you want to search in the <code>\"Value\"</code> field. For example, <code>\"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p> <p>If you set the value to <code>\"StringLike\"</code>, you need to provide the name of the data sources you are searching for. For example, <code>\"Name\":\"DATASOURCE_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\"</code>. The <code>\"StringLike\"</code> operator only supports the <code>NAME</code> value <code>DATASOURCE_NAME</code>.</p>"
},
"Name":{
"shape":"DataSourceFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example, <code>\"Name\": \"DIRECT_QUICKSIGHT_OWNER\"</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: 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.</p> </li> <li> <p> <code>DATASOURCE_NAME</code>: Any data sources whose names have a substring match to the provided value are returned.</p> </li> </ul>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, for example <code>DIRECT_QUICKSIGHT_OWNER</code>, that you want to use as a filter, for example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p>"
}
},
"documentation":"<p>A filter that you apply when searching for data sources.</p>"
},
"DataSourceSearchFilterList":{
"type":"list",
"member":{"shape":"DataSourceSearchFilter"},
"max":1,
"min":1
},
"DataSourceSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The arn of the datasource.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The unique ID of the data source.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>The name of the data source.</p>"
},
"Type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.</p>"
}
},
"documentation":"<p>A <code>DataSourceSummary</code> object that returns a summary of a data source.</p>"
},
"DataSourceSummaryList":{
"type":"list",
"member":{"shape":"DataSourceSummary"}
},
"DataSourceType":{
"type":"string",
"enum":[
"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",
"AMAZON_OPENSEARCH",
"EXASOL",
"DATABRICKS"
]
},
"Database":{
"type":"string",
"max":128,
"min":1
},
"DatabricksParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"SqlEndpointPath"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>The host name of the Databricks data source.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port for the Databricks data source.</p>"
},
"SqlEndpointPath":{
"shape":"SqlEndpointPath",
"documentation":"<p>The HTTP path of the Databricks data source.</p>"
}
},
"documentation":"<p>The required parameters that are needed to connect to a Databricks data source.</p>"
},
"DateAggregationFunction":{
"type":"string",
"enum":[
"COUNT",
"DISTINCT_COUNT",
"MIN",
"MAX"
]
},
"DateAxisOptions":{
"type":"structure",
"members":{
"MissingDateVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not missing dates are displayed.</p>"
}
},
"documentation":"<p>The options that determine how a date axis is displayed.</p>"
},
"DateDimensionField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>DateDimensionField</code>.</p>"
},
"DateGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The date granularity of the <code>DateDimensionField</code>. Choose one of the following options:</p> <ul> <li> <p> <code>YEAR</code> </p> </li> <li> <p> <code>QUARTER</code> </p> </li> <li> <p> <code>MONTH</code> </p> </li> <li> <p> <code>WEEK</code> </p> </li> <li> <p> <code>DAY</code> </p> </li> <li> <p> <code>HOUR</code> </p> </li> <li> <p> <code>MINUTE</code> </p> </li> <li> <p> <code>SECOND</code> </p> </li> <li> <p> <code>MILLISECOND</code> </p> </li> </ul>"
},
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The custom hierarchy ID.</p>"
},
"FormatConfiguration":{
"shape":"DateTimeFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The dimension type field with date type columns.</p>"
},
"DateMeasureField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>DateMeasureField</code>.</p>"
},
"AggregationFunction":{
"shape":"DateAggregationFunction",
"documentation":"<p>The aggregation function of the measure field.</p>"
},
"FormatConfiguration":{
"shape":"DateTimeFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The measure type field with date type columns.</p>"
},
"DateTimeDefaultValueList":{
"type":"list",
"member":{"shape":"SensitiveTimestamp"},
"max":50000
},
"DateTimeDefaultValues":{
"type":"structure",
"members":{
"DynamicValue":{
"shape":"DynamicDefaultValue",
"documentation":"<p>The dynamic value of the <code>DataTimeDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>"
},
"StaticValues":{
"shape":"DateTimeDefaultValueList",
"documentation":"<p>The static values of the <code>DataTimeDefaultValues</code>.</p>"
},
"RollingDate":{
"shape":"RollingDateConfiguration",
"documentation":"<p>The rolling date of the <code>DataTimeDefaultValues</code>. The date is determined from the dataset based on input expression.</p>"
}
},
"documentation":"<p>The default values of the <code>DateTimeParameterDeclaration</code>.</p>"
},
"DateTimeFormat":{
"type":"string",
"max":128,
"min":1
},
"DateTimeFormatConfiguration":{
"type":"structure",
"members":{
"DateTimeFormat":{
"shape":"DateTimeFormat",
"documentation":"<p>Determines the <code>DateTime</code> format.</p>"
},
"NullValueFormatConfiguration":{
"shape":"NullValueFormatConfiguration",
"documentation":"<p>The options that determine the null value format configuration.</p>"
},
"NumericFormatConfiguration":{
"shape":"NumericFormatConfiguration",
"documentation":"<p>The formatting configuration for numeric <code>DateTime</code> fields.</p>"
}
},
"documentation":"<p>Formatting configuration for <code>DateTime</code> fields.</p>"
},
"DateTimeHierarchy":{
"type":"structure",
"required":["HierarchyId"],
"members":{
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The hierarchy ID of the <code>DateTime</code> hierarchy.</p>"
},
"DrillDownFilters":{
"shape":"DrillDownFilterList",
"documentation":"<p>The option that determines the drill down filters for the <code>DateTime</code> hierarchy.</p>"
}
},
"documentation":"<p>The option that determines the hierarchy of any <code>DateTime</code> fields.</p>"
},
"DateTimeParameter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A display name for the date-time parameter.</p>"
},
"Values":{
"shape":"SensitiveTimestampList",
"documentation":"<p>The values for the date-time parameter.</p>"
}
},
"documentation":"<p>A date-time parameter.</p>"
},
"DateTimeParameterDeclaration":{
"type":"structure",
"required":["Name"],
"members":{
"Name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter that is being declared.</p>"
},
"DefaultValues":{
"shape":"DateTimeDefaultValues",
"documentation":"<p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
},
"ValueWhenUnset":{
"shape":"DateTimeValueWhenUnsetConfiguration",
"documentation":"<p>The configuration that defines the default value of a <code>DateTime</code> parameter when a value has not been set.</p>"
}
},
"documentation":"<p>A parameter declaration for the <code>DateTime</code> data type.</p>"
},
"DateTimeParameterList":{
"type":"list",
"member":{"shape":"DateTimeParameter"},
"max":100
},
"DateTimePickerControlDisplayOptions":{
"type":"structure",
"members":{
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
},
"DateTimeFormat":{
"shape":"DateTimeFormat",
"documentation":"<p>Customize how dates are formatted in controls.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"DateTimeValueWhenUnsetConfiguration":{
"type":"structure",
"members":{
"ValueWhenUnsetOption":{
"shape":"ValueWhenUnsetOption",
"documentation":"<p>The built-in options for default values. The value can be one of the following:</p> <ul> <li> <p> <code>RECOMMENDED</code>: The recommended value.</p> </li> <li> <p> <code>NULL</code>: The <code>NULL</code> value.</p> </li> </ul>"
},
"CustomValue":{
"shape":"SensitiveTimestamp",
"documentation":"<p>A custom value that's used when the value of a parameter isn't set.</p>"
}
},
"documentation":"<p>The configuration that defines the default value of a <code>DateTime</code> parameter when a value has not been set.</p>"
},
"DecimalDefaultValueList":{
"type":"list",
"member":{"shape":"SensitiveDoubleObject"},
"max":50000
},
"DecimalDefaultValues":{
"type":"structure",
"members":{
"DynamicValue":{
"shape":"DynamicDefaultValue",
"documentation":"<p>The dynamic value of the <code>DecimalDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>"
},
"StaticValues":{
"shape":"DecimalDefaultValueList",
"documentation":"<p>The static values of the <code>DecimalDefaultValues</code>.</p>"
}
},
"documentation":"<p>The default values of the <code>DecimalParameterDeclaration</code>.</p>"
},
"DecimalParameter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A display name for the decimal parameter.</p>"
},
"Values":{
"shape":"SensitiveDoubleList",
"documentation":"<p>The values for the decimal parameter.</p>"
}
},
"documentation":"<p>A decimal parameter.</p>"
},
"DecimalParameterDeclaration":{
"type":"structure",
"required":[
"ParameterValueType",
"Name"
],
"members":{
"ParameterValueType":{
"shape":"ParameterValueType",
"documentation":"<p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>"
},
"Name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter that is being declared.</p>"
},
"DefaultValues":{
"shape":"DecimalDefaultValues",
"documentation":"<p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>"
},
"ValueWhenUnset":{
"shape":"DecimalValueWhenUnsetConfiguration",
"documentation":"<p>The configuration that defines the default value of a <code>Decimal</code> parameter when a value has not been set.</p>"
}
},
"documentation":"<p>A parameter declaration for the <code>Decimal</code> data type.</p>"
},
"DecimalParameterList":{
"type":"list",
"member":{"shape":"DecimalParameter"},
"max":100
},
"DecimalPlaces":{
"type":"long",
"max":20,
"min":0
},
"DecimalPlacesConfiguration":{
"type":"structure",
"required":["DecimalPlaces"],
"members":{
"DecimalPlaces":{
"shape":"DecimalPlaces",
"documentation":"<p>The values of the decimal places.</p>"
}
},
"documentation":"<p>The option that determines the decimal places configuration.</p>"
},
"DecimalValueWhenUnsetConfiguration":{
"type":"structure",
"members":{
"ValueWhenUnsetOption":{
"shape":"ValueWhenUnsetOption",
"documentation":"<p>The built-in options for default values. The value can be one of the following:</p> <ul> <li> <p> <code>RECOMMENDED</code>: The recommended value.</p> </li> <li> <p> <code>NULL</code>: The <code>NULL</code> value.</p> </li> </ul>"
},
"CustomValue":{
"shape":"SensitiveDouble",
"documentation":"<p>A custom value that's used when the value of a parameter isn't set.</p>",
"box":true
}
},
"documentation":"<p>The configuration that defines the default value of a <code>Decimal</code> parameter when a value has not been set.</p>"
},
"DefaultFreeFormLayoutConfiguration":{
"type":"structure",
"required":["CanvasSizeOptions"],
"members":{
"CanvasSizeOptions":{
"shape":"FreeFormLayoutCanvasSizeOptions",
"documentation":"<p>Determines the screen canvas size options for a free-form layout.</p>"
}
},
"documentation":"<p>The options that determine the default settings of a free-form layout configuration.</p>"
},
"DefaultGridLayoutConfiguration":{
"type":"structure",
"required":["CanvasSizeOptions"],
"members":{
"CanvasSizeOptions":{
"shape":"GridLayoutCanvasSizeOptions",
"documentation":"<p>Determines the screen canvas size options for a grid layout.</p>"
}
},
"documentation":"<p>The options that determine the default settings for a grid layout configuration.</p>"
},
"DefaultInteractiveLayoutConfiguration":{
"type":"structure",
"members":{
"Grid":{
"shape":"DefaultGridLayoutConfiguration",
"documentation":"<p>The options that determine the default settings for a grid layout configuration.</p>"
},
"FreeForm":{
"shape":"DefaultFreeFormLayoutConfiguration",
"documentation":"<p>The options that determine the default settings of a free-form layout configuration.</p>"
}
},
"documentation":"<p>The options that determine the default settings for interactive layout configuration.</p>"
},
"DefaultNewSheetConfiguration":{
"type":"structure",
"members":{
"InteractiveLayoutConfiguration":{
"shape":"DefaultInteractiveLayoutConfiguration",
"documentation":"<p>The options that determine the default settings for interactive layout configuration.</p>"
},
"PaginatedLayoutConfiguration":{
"shape":"DefaultPaginatedLayoutConfiguration",
"documentation":"<p>The options that determine the default settings for a paginated layout configuration.</p>"
},
"SheetContentType":{
"shape":"SheetContentType",
"documentation":"<p>The option that determines the sheet content type.</p>"
}
},
"documentation":"<p>The configuration for default new sheet settings.</p>"
},
"DefaultPaginatedLayoutConfiguration":{
"type":"structure",
"members":{
"SectionBased":{
"shape":"DefaultSectionBasedLayoutConfiguration",
"documentation":"<p>The options that determine the default settings for a section-based layout configuration.</p>"
}
},
"documentation":"<p>The options that determine the default settings for a paginated layout configuration.</p>"
},
"DefaultSectionBasedLayoutConfiguration":{
"type":"structure",
"required":["CanvasSizeOptions"],
"members":{
"CanvasSizeOptions":{
"shape":"SectionBasedLayoutCanvasSizeOptions",
"documentation":"<p>Determines the screen canvas size options for a section-based layout.</p>"
}
},
"documentation":"<p>The options that determine the default settings for a section-based layout configuration.</p>"
},
"DeleteAccountCustomizationRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that you're deleting the customizations from.</p>",
"location":"querystring",
"locationName":"namespace"
}
}
},
"DeleteAccountCustomizationResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteAccountSubscriptionRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID of the account that you want to delete.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"DeleteAccountSubscriptionResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account where you want to delete an analysis.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're deleting.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"RecoveryWindowInDays":{
"shape":"RecoveryWindowInDays",
"documentation":"<p>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 <code>ForceDeleteWithoutRecovery</code> option in the same API call. The default value is 30.</p>",
"location":"querystring",
"locationName":"recovery-window-in-days"
},
"ForceDeleteWithoutRecovery":{
"shape":"Boolean",
"documentation":"<p>This option defaults to the value <code>NoForceDeleteWithoutRecovery</code>. To immediately delete the analysis, add the <code>ForceDeleteWithoutRecovery</code> option. You can't restore an analysis after it's deleted. </p>",
"location":"querystring",
"locationName":"force-delete-without-recovery"
}
}
},
"DeleteAnalysisResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the deleted analysis.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the deleted analysis.</p>"
},
"DeletionTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the analysis is scheduled to be deleted.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DeleteDashboardRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.</p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteDashboardResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Secure Socket Layer (SSL) properties that apply for the resource.</p>"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the dashboard.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DeleteDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DeleteDataSetResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DeleteDataSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source that you deleted.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteFolderMembershipRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId",
"MemberId",
"MemberType"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The Folder ID.</p>",
"location":"uri",
"locationName":"FolderId"
},
"MemberId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the asset (the dashboard, analysis, or dataset) that you want to delete.</p>",
"location":"uri",
"locationName":"MemberId"
},
"MemberType":{
"shape":"MemberType",
"documentation":"<p>The type of the member, including <code>DASHBOARD</code>, <code>ANALYSIS</code>, and <code>DATASET</code> </p>",
"location":"uri",
"locationName":"MemberType"
}
}
},
"DeleteFolderMembershipResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DeleteFolderRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
}
}
},
"DeleteFolderResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name of the deleted folder.</p>"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DeleteGroupMembershipRequest":{
"type":"structure",
"required":[
"MemberName",
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The name of the user that you want to delete from the group membership.</p>",
"location":"uri",
"locationName":"MemberName"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to delete the user from.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the group that you want to remove a user from.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteGroupMembershipResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to delete.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the group that you want to delete.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteGroupResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID where you want to delete the IAM policy assignment.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. </p>",
"location":"uri",
"locationName":"AssignmentName"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that contains the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteNamespaceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to delete.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteNamespaceResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteTemplateAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId",
"AliasName"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the item to delete.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template that the specified alias is for.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. </p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DeleteTemplateAliasResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the template associated with the deletion.</p>"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name for the template alias.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template you want to delete.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DeleteTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the template you want to delete.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>Specifies the version of the template that you want to delete. If you don't provide a version number, <code>DeleteTemplate</code> deletes all versions of the template. </p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteTemplateResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the template.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteThemeAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"AliasName"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme alias to delete.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme that the specified alias is for.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The unique name for the theme alias to delete.</p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DeleteThemeAliasResponse":{
"type":"structure",
"members":{
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name for the theme alias.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme resource using the deleted alias.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the theme associated with the deletion.</p>"
}
}
},
"DeleteThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the theme that you want to delete.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version of the theme that you want to delete. </p> <p> <b>Note:</b> If you don't provide a version number, you're using this call to <code>DeleteTheme</code> to delete all versions of the theme.</p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteThemeResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An ID for the theme.</p>"
}
}
},
"DeleteUserByPrincipalIdRequest":{
"type":"structure",
"required":[
"PrincipalId",
"AwsAccountId",
"Namespace"
],
"members":{
"PrincipalId":{
"shape":"String",
"documentation":"<p>The principal ID of the user.</p>",
"location":"uri",
"locationName":"PrincipalId"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
},
"documentation":"<p/>"
},
"DeleteUserByPrincipalIdResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteUserRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user that you want to delete.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteUserResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"Delimiter":{
"type":"string",
"max":1,
"min":1
},
"DescribeAccountCustomizationRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.</p>",
"location":"querystring",
"locationName":"namespace"
},
"Resolved":{
"shape":"boolean",
"documentation":"<p>The <code>Resolved</code> 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 <code>no-resolved</code>, to reveal customizations that are configured at different levels. </p>",
"location":"querystring",
"locationName":"resolved"
}
}
},
"DescribeAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you're describing.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that you're describing. </p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The Amazon QuickSight customizations that exist in the current Amazon Web Services Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeAccountSettingsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the settings that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"DescribeAccountSettingsResponse":{
"type":"structure",
"members":{
"AccountSettings":{
"shape":"AccountSettings",
"documentation":"<p>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. </p> <p>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.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeAccountSubscriptionRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID associated with your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"DescribeAccountSubscriptionResponse":{
"type":"structure",
"members":{
"AccountInfo":{
"shape":"AccountInfo",
"documentation":"<p>A structure that contains the following elements:</p> <ul> <li> <p>Your Amazon QuickSight account name.</p> </li> <li> <p>The edition of Amazon QuickSight that your account is using.</p> </li> <li> <p>The notification email address that is associated with the Amazon QuickSight account. </p> </li> <li> <p>The authentication type of the Amazon QuickSight account.</p> </li> <li> <p>The status of the Amazon QuickSight account's subscription.</p> </li> </ul>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeAnalysisDefinitionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"DescribeAnalysisDefinitionResponse":{
"type":"structure",
"members":{
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis described.</p>"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>The descriptive name of the analysis.</p>"
},
"Errors":{
"shape":"AnalysisErrorList",
"documentation":"<p>Errors associated with the analysis.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Status associated with the analysis.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme of the analysis.</p>"
},
"Definition":{
"shape":"AnalysisDefinition",
"documentation":"<p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeAnalysisPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"DescribeAnalysisPermissionsResponse":{
"type":"structure",
"members":{
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're describing.</p>"
},
"AnalysisArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"DescribeAnalysisResponse":{
"type":"structure",
"members":{
"Analysis":{
"shape":"Analysis",
"documentation":"<p>A metadata structure that contains summary information for the analysis that you're describing.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeDashboardDefinitionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. </p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The alias name.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeDashboardDefinitionResponse":{
"type":"structure",
"members":{
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the dashboard described.</p>"
},
"Errors":{
"shape":"DashboardErrorList",
"documentation":"<p>Errors associated with this dashboard version.</p>"
},
"Name":{
"shape":"DashboardName",
"documentation":"<p>The display name of the dashboard.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Status associated with the dashboard version.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme of the dashboard.</p>"
},
"Definition":{
"shape":"DashboardVersionDefinition",
"documentation":"<p>The definition of a dashboard.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeDashboardPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard, also added to the IAM policy.</p>",
"location":"uri",
"locationName":"DashboardId"
}
}
},
"DescribeDashboardPermissionsResponse":{
"type":"structure",
"members":{
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"DashboardArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that contains the permissions for the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"LinkSharingConfiguration":{
"shape":"LinkSharingConfiguration",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/sharing-a-dashboard.html\">Sharing Dashboards</a>.</p>"
}
}
},
"DescribeDashboardRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. </p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The alias name.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeDashboardResponse":{
"type":"structure",
"members":{
"Dashboard":{
"shape":"Dashboard",
"documentation":"<p>Information about the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of this request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeDataSetPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DescribeDataSetPermissionsResponse":{
"type":"structure",
"members":{
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the dataset.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DescribeDataSetResponse":{
"type":"structure",
"members":{
"DataSet":{
"shape":"DataSet",
"documentation":"<p>Information on the dataset.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSourcePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DescribeDataSourcePermissionsResponse":{
"type":"structure",
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DescribeDataSourceResponse":{
"type":"structure",
"members":{
"DataSource":{
"shape":"DataSource",
"documentation":"<p>The information on the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeFolderPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
}
}
},
"DescribeFolderPermissionsResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the folder.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>Information about the permissions on the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeFolderRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
}
}
},
"DescribeFolderResolvedPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
}
}
},
"DescribeFolderResolvedPermissionsResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the folder.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>Information about the permissions for the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeFolderResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Folder":{
"shape":"Folder",
"documentation":"<p>Information about the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeGroupMembershipRequest":{
"type":"structure",
"required":[
"MemberName",
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The user name of the user that you want to search for.</p>",
"location":"uri",
"locationName":"MemberName"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to search.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that includes the group you are searching within.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeGroupMembershipResponse":{
"type":"structure",
"members":{
"GroupMember":{"shape":"GroupMember"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to describe.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the group that you want described.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeGroupResponse":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The name of the group.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the assignment that you want to describe.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment, also called a rule.</p>",
"location":"uri",
"locationName":"AssignmentName"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that contains the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"IAMPolicyAssignment":{
"shape":"IAMPolicyAssignment",
"documentation":"<p>Information describing the IAM policy assignment.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeIngestionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId",
"IngestionId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"String",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>",
"location":"uri",
"locationName":"IngestionId"
}
}
},
"DescribeIngestionResponse":{
"type":"structure",
"members":{
"Ingestion":{
"shape":"Ingestion",
"documentation":"<p>Information about the ingestion.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeIpRestrictionRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the IP rules.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"DescribeIpRestrictionResponse":{
"type":"structure",
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the IP rules.</p>"
},
"IpRestrictionRuleMap":{
"shape":"IpRestrictionRuleMap",
"documentation":"<p>A map that describes the IP rules with CIDR range and description.</p>"
},
"Enabled":{
"shape":"NullableBoolean",
"documentation":"<p>A value that specifies whether IP rules are turned on.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request. </p>",
"location":"statusCode"
}
}
},
"DescribeNamespaceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to describe.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeNamespaceResponse":{
"type":"structure",
"members":{
"Namespace":{
"shape":"NamespaceInfoV2",
"documentation":"<p>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. <code>DescribeNamespace</code> 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.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeTemplateAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId",
"AliasName"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template alias that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DescribeTemplateAliasResponse":{
"type":"structure",
"members":{
"TemplateAlias":{
"shape":"TemplateAlias",
"documentation":"<p>Information about the template alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeTemplateDefinitionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the template that you're describing.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template.</p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeTemplateDefinitionResponse":{
"type":"structure",
"members":{
"Name":{
"shape":"TemplateName",
"documentation":"<p>The descriptive name of the template.</p>"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the template described.</p>"
},
"Errors":{
"shape":"TemplateErrorList",
"documentation":"<p>Errors associated with the template version.</p>"
},
"ResourceStatus":{
"shape":"ResourceStatus",
"documentation":"<p>Status associated with the template.</p> <ul> <li> <p> <code>CREATION_IN_PROGRESS</code> </p> </li> <li> <p> <code>CREATION_SUCCESSFUL</code> </p> </li> <li> <p> <code>CREATION_FAILED</code> </p> </li> <li> <p> <code>UPDATE_IN_PROGRESS</code> </p> </li> <li> <p> <code>UPDATE_SUCCESSFUL</code> </p> </li> <li> <p> <code>UPDATE_FAILED</code> </p> </li> <li> <p> <code>DELETED</code> </p> </li> </ul>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme of the template.</p>"
},
"Definition":{
"shape":"TemplateVersionDefinition",
"documentation":"<p>The definition of the template.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeTemplatePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
}
}
},
"DescribeTemplatePermissionsResponse":{
"type":"structure",
"members":{
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>"
},
"TemplateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions to be set on the template. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the template is described.</p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeTemplateResponse":{
"type":"structure",
"members":{
"Template":{
"shape":"Template",
"documentation":"<p>The template structure for the object you want to describe.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeThemeAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"AliasName"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme alias that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name of the theme alias that you want to describe.</p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DescribeThemeAliasResponse":{
"type":"structure",
"members":{
"ThemeAlias":{
"shape":"ThemeAlias",
"documentation":"<p>Information about the theme alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeThemePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme that you want to describe permissions for.</p>",
"location":"uri",
"locationName":"ThemeId"
}
}
},
"DescribeThemePermissionsResponse":{
"type":"structure",
"members":{
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions set on the theme. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAndAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the theme is described.</p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeThemeResponse":{
"type":"structure",
"members":{
"Theme":{
"shape":"Theme",
"documentation":"<p>The information about the theme that you are describing.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"DescribeUserRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user that you want to describe.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeUserResponse":{
"type":"structure",
"members":{
"User":{
"shape":"User",
"documentation":"<p>The user name.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DestinationParameterValueConfiguration":{
"type":"structure",
"members":{
"CustomValuesConfiguration":{
"shape":"CustomValuesConfiguration",
"documentation":"<p>The configuration of custom values for destination parameter in <code>DestinationParameterValueConfiguration</code>.</p>"
},
"SelectAllValueOptions":{
"shape":"SelectAllValueOptions",
"documentation":"<p>The configuration that selects all options.</p>"
},
"SourceParameterName":{
"shape":"String",
"documentation":"<p>The source parameter name of the destination parameter.</p>"
},
"SourceField":{
"shape":"FieldId",
"documentation":"<p>The source field ID of the destination parameter.</p>"
}
},
"documentation":"<p>The configuration of destination parameter values.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"DimensionField":{
"type":"structure",
"members":{
"NumericalDimensionField":{
"shape":"NumericalDimensionField",
"documentation":"<p>The dimension type field with numerical type columns.</p>"
},
"CategoricalDimensionField":{
"shape":"CategoricalDimensionField",
"documentation":"<p>The dimension type field with categorical type columns.</p>"
},
"DateDimensionField":{
"shape":"DateDimensionField",
"documentation":"<p>The dimension type field with date type columns.</p>"
}
},
"documentation":"<p>The dimension type field.</p>"
},
"DimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":200
},
"Domain":{
"type":"string",
"max":64,
"min":1
},
"DomainNotWhitelistedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"DonutCenterOptions":{
"type":"structure",
"members":{
"LabelVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called <code>'Show total'</code>.</p>"
}
},
"documentation":"<p>The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.</p>"
},
"DonutOptions":{
"type":"structure",
"members":{
"ArcOptions":{
"shape":"ArcOptions",
"documentation":"<p>The option for define the arc of the chart shape. Valid values are as follows:</p> <ul> <li> <p> <code>WHOLE</code> - A pie chart</p> </li> <li> <p> <code>SMALL</code>- A small-sized donut chart</p> </li> <li> <p> <code>MEDIUM</code>- A medium-sized donut chart</p> </li> <li> <p> <code>LARGE</code>- A large-sized donut chart</p> </li> </ul>"
},
"DonutCenterOptions":{
"shape":"DonutCenterOptions",
"documentation":"<p>The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.</p>"
}
},
"documentation":"<p>The options for configuring a donut chart or pie chart.</p>"
},
"Double":{"type":"double"},
"DrillDownFilter":{
"type":"structure",
"members":{
"NumericEqualityFilter":{
"shape":"NumericEqualityDrillDownFilter",
"documentation":"<p>The numeric equality type drill down filter. This filter is used for number type columns.</p>"
},
"CategoryFilter":{
"shape":"CategoryDrillDownFilter",
"documentation":"<p>The category type drill down filter. This filter is used for string type columns.</p>"
},
"TimeRangeFilter":{
"shape":"TimeRangeDrillDownFilter",
"documentation":"<p>The time range drill down filter. This filter is used for date time columns.</p>"
}
},
"documentation":"<p>The drill down filter for the column hierarchies.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"DrillDownFilterList":{
"type":"list",
"member":{"shape":"DrillDownFilter"},
"max":10
},
"DropDownControlDisplayOptions":{
"type":"structure",
"members":{
"SelectAllOptions":{
"shape":"ListControlSelectAllOptions",
"documentation":"<p>The configuration of the <code>Select all</code> options in a dropdown control.</p>"
},
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"DynamicDefaultValue":{
"type":"structure",
"required":["DefaultValueColumn"],
"members":{
"UserNameColumn":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that contains the username.</p>"
},
"GroupNameColumn":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that contains the group name.</p>"
},
"DefaultValueColumn":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that contains the default value of each user or group.</p>"
}
},
"documentation":"<p>Defines different defaults to the users or groups based on mapping.</p>"
},
"Edition":{
"type":"string",
"enum":[
"STANDARD",
"ENTERPRISE",
"ENTERPRISE_AND_Q"
]
},
"EmbeddingIdentityType":{
"type":"string",
"enum":[
"IAM",
"QUICKSIGHT",
"ANONYMOUS"
]
},
"EmbeddingUrl":{
"type":"string",
"sensitive":true
},
"EmptyVisual":{
"type":"structure",
"required":[
"VisualId",
"DataSetIdentifier"
],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The data set that is used in the empty visual. Every visual requires a dataset to render.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>An empty visual.</p> <p>Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Amazon QuickSight console is considered an <code>EmptyVisual</code> until a visual type is selected.</p>"
},
"Entity":{
"type":"structure",
"members":{
"Path":{
"shape":"NonEmptyString",
"documentation":"<p>The hierarchical path of the entity within the analysis, template, or dashboard definition tree.</p>"
}
},
"documentation":"<p>An object, structure, or sub-structure of an analysis, template, or dashboard.</p>"
},
"EntityList":{
"type":"list",
"member":{"shape":"Entity"},
"max":200
},
"EntryPath":{
"type":"string",
"max":1000,
"min":1
},
"EntryPoint":{
"type":"string",
"max":1000,
"min":1
},
"ErrorInfo":{
"type":"structure",
"members":{
"Type":{
"shape":"IngestionErrorType",
"documentation":"<p>Error type.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>Error message.</p>"
}
},
"documentation":"<p>Error information for the SPICE ingestion of a dataset.</p>"
},
"ExasolParameters":{
"type":"structure",
"required":[
"Host",
"Port"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>The hostname or IP address of the Exasol data source.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>The port for the Exasol data source.</p>"
}
},
"documentation":"<p>The required parameters for connecting to an Exasol data source.</p>"
},
"ExceptionResourceType":{
"type":"string",
"enum":[
"USER",
"GROUP",
"NAMESPACE",
"ACCOUNT_SETTINGS",
"IAMPOLICY_ASSIGNMENT",
"DATA_SOURCE",
"DATA_SET",
"VPC_CONNECTION",
"INGESTION"
]
},
"ExcludePeriodConfiguration":{
"type":"structure",
"required":[
"Amount",
"Granularity"
],
"members":{
"Amount":{
"shape":"Integer",
"documentation":"<p>The amount or number of the exclude period.</p>",
"box":true
},
"Granularity":{
"shape":"TimeGranularity",
"documentation":"<p>The granularity or unit (day, month, year) of the exclude period.</p>"
},
"Status":{
"shape":"WidgetStatus",
"documentation":"<p>The status of the exclude period. Choose from the following options:</p> <ul> <li> <p> <code>ENABLED</code> </p> </li> <li> <p> <code>DISABLED</code> </p> </li> </ul>"
}
},
"documentation":"<p>The exclude period of <code>TimeRangeFilter</code> or <code>RelativeDatesFilter</code>.</p>"
},
"ExplicitHierarchy":{
"type":"structure",
"required":[
"HierarchyId",
"Columns"
],
"members":{
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The hierarchy ID of the explicit hierarchy.</p>"
},
"Columns":{
"shape":"ExplicitHierarchyColumnList",
"documentation":"<p>The list of columns that define the explicit hierarchy.</p>"
},
"DrillDownFilters":{
"shape":"DrillDownFilterList",
"documentation":"<p>The option that determines the drill down filters for the explicit hierarchy.</p>"
}
},
"documentation":"<p>The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.</p>"
},
"ExplicitHierarchyColumnList":{
"type":"list",
"member":{"shape":"ColumnIdentifier"},
"max":10,
"min":2
},
"ExportHiddenFieldsOption":{
"type":"structure",
"members":{
"AvailabilityStatus":{
"shape":"DashboardBehavior",
"documentation":"<p/>"
}
},
"documentation":"<p/>"
},
"ExportToCSVOption":{
"type":"structure",
"members":{
"AvailabilityStatus":{
"shape":"DashboardBehavior",
"documentation":"<p>Availability status.</p>"
}
},
"documentation":"<p>Export to .csv option.</p>"
},
"Expression":{
"type":"string",
"max":4096,
"min":1,
"sensitive":true
},
"FieldBasedTooltip":{
"type":"structure",
"members":{
"AggregationVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of <code>Show aggregations</code>.</p>"
},
"TooltipTitleType":{
"shape":"TooltipTitleType",
"documentation":"<p>The type for the &gt;tooltip title. Choose one of the following options:</p> <ul> <li> <p> <code>NONE</code>: Doesn't use the primary value as the title.</p> </li> <li> <p> <code>PRIMARY_VALUE</code>: Uses primary value as the title.</p> </li> </ul>"
},
"TooltipFields":{
"shape":"TooltipItemList",
"documentation":"<p>The fields configuration in the tooltip.</p>"
}
},
"documentation":"<p>The setup for the detailed tooltip.</p>"
},
"FieldFolder":{
"type":"structure",
"members":{
"description":{
"shape":"FieldFolderDescription",
"documentation":"<p>The description for a field folder.</p>"
},
"columns":{
"shape":"FolderColumnList",
"documentation":"<p>A folder has a list of columns. A column can only be in one folder.</p>"
}
},
"documentation":"<p>A FieldFolder element is a folder that contains fields and nested subfolders.</p>"
},
"FieldFolderDescription":{
"type":"string",
"max":500
},
"FieldFolderMap":{
"type":"map",
"key":{"shape":"FieldFolderPath"},
"value":{"shape":"FieldFolder"}
},
"FieldFolderPath":{
"type":"string",
"max":1000,
"min":1
},
"FieldId":{
"type":"string",
"max":512,
"min":1
},
"FieldLabelType":{
"type":"structure",
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>Indicates the field that is targeted by the field label.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the field label.</p>"
}
},
"documentation":"<p>The field label type.</p>"
},
"FieldOrderList":{
"type":"list",
"member":{"shape":"FieldId"},
"max":100
},
"FieldSeriesItem":{
"type":"structure",
"required":[
"FieldId",
"AxisBinding"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the field for which you are setting the axis binding.</p>"
},
"AxisBinding":{
"shape":"AxisBinding",
"documentation":"<p>The axis that you are binding the field to.</p>"
},
"Settings":{
"shape":"LineChartSeriesSettings",
"documentation":"<p>The options that determine the presentation of line series associated to the field.</p>"
}
},
"documentation":"<p>The field series item configuration of a line chart.</p>"
},
"FieldSort":{
"type":"structure",
"required":[
"FieldId",
"Direction"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The sort configuration target field.</p>"
},
"Direction":{
"shape":"SortDirection",
"documentation":"<p>The sort direction. Choose one of the following options:</p> <ul> <li> <p> <code>ASC</code>: Ascending</p> </li> <li> <p> <code>DESC</code>: Descending</p> </li> </ul>"
}
},
"documentation":"<p>The sort configuration for a field in a field well.</p>"
},
"FieldSortOptions":{
"type":"structure",
"members":{
"FieldSort":{
"shape":"FieldSort",
"documentation":"<p>The sort configuration for a field in a field well.</p>"
},
"ColumnSort":{
"shape":"ColumnSort",
"documentation":"<p>The sort configuration for a column that is not used in a field well.</p>"
}
},
"documentation":"<p>The field sort options in a chart configuration.</p>"
},
"FieldSortOptionsList":{
"type":"list",
"member":{"shape":"FieldSortOptions"},
"max":100
},
"FieldTooltipItem":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The unique ID of the field that is targeted by the tooltip.</p>"
},
"Label":{
"shape":"String",
"documentation":"<p>The label of the tooltip item.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the tooltip item.</p>"
}
},
"documentation":"<p>The tooltip item for the fields.</p>"
},
"FieldValue":{
"type":"string",
"max":2048,
"sensitive":true
},
"FileFormat":{
"type":"string",
"enum":[
"CSV",
"TSV",
"CLF",
"ELF",
"XLSX",
"JSON"
]
},
"FilledMapAggregatedFieldWells":{
"type":"structure",
"members":{
"Geospatial":{
"shape":"FilledMapDimensionFieldList",
"documentation":"<p>The aggregated location field well of the filled map. Values are grouped by location fields.</p>"
},
"Values":{
"shape":"FilledMapMeasureFieldList",
"documentation":"<p>The aggregated color field well of a filled map. Values are aggregated based on location fields.</p>"
}
},
"documentation":"<p>The aggregated field well of the filled map.</p>"
},
"FilledMapConditionalFormatting":{
"type":"structure",
"required":["ConditionalFormattingOptions"],
"members":{
"ConditionalFormattingOptions":{
"shape":"FilledMapConditionalFormattingOptionList",
"documentation":"<p>Conditional formatting options of a <code>FilledMapVisual</code>.</p>"
}
},
"documentation":"<p>The conditional formatting of a <code>FilledMapVisual</code>.</p>"
},
"FilledMapConditionalFormattingOption":{
"type":"structure",
"required":["Shape"],
"members":{
"Shape":{
"shape":"FilledMapShapeConditionalFormatting",
"documentation":"<p>The conditional formatting that determines the shape of the filled map.</p>"
}
},
"documentation":"<p>Conditional formatting options of a <code>FilledMapVisual</code>.</p>"
},
"FilledMapConditionalFormattingOptionList":{
"type":"list",
"member":{"shape":"FilledMapConditionalFormattingOption"},
"max":200
},
"FilledMapConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"FilledMapFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"FilledMapSortConfiguration",
"documentation":"<p>The sort configuration of a <code>FilledMapVisual</code>.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
},
"WindowOptions":{
"shape":"GeospatialWindowOptions",
"documentation":"<p>The window options of the filled map visual.</p>"
},
"MapStyleOptions":{
"shape":"GeospatialMapStyleOptions",
"documentation":"<p>The map style options of the filled map visual.</p>"
}
},
"documentation":"<p>The configuration for a <code>FilledMapVisual</code>.</p>"
},
"FilledMapDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"FilledMapFieldWells":{
"type":"structure",
"members":{
"FilledMapAggregatedFieldWells":{
"shape":"FilledMapAggregatedFieldWells",
"documentation":"<p>The aggregated field well of the filled map.</p>"
}
},
"documentation":"<p>The field wells of a <code>FilledMapVisual</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilledMapMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"FilledMapShapeConditionalFormatting":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the filled map shape.</p>"
},
"Format":{
"shape":"ShapeConditionalFormat",
"documentation":"<p>The conditional formatting that determines the background color of a filled map's shape.</p>"
}
},
"documentation":"<p>The conditional formatting that determines the shape of the filled map.</p>"
},
"FilledMapSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the location fields.</p>"
}
},
"documentation":"<p>The sort configuration of a <code>FilledMapVisual</code>.</p>"
},
"FilledMapVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"FilledMapConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"ConditionalFormatting":{
"shape":"FilledMapConditionalFormatting",
"documentation":"<p>The conditional formatting of a <code>FilledMapVisual</code>.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A filled map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html\">Creating filled maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"Filter":{
"type":"structure",
"members":{
"CategoryFilter":{
"shape":"CategoryFilter",
"documentation":"<p>A <code>CategoryFilter</code> filters text values.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/add-a-text-filter-data-prep.html\">Adding text filters</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"NumericRangeFilter":{
"shape":"NumericRangeFilter",
"documentation":"<p>A <code>NumericRangeFilter</code> filters numeric values that are either inside or outside a given numeric range.</p>"
},
"NumericEqualityFilter":{
"shape":"NumericEqualityFilter",
"documentation":"<p>A <code>NumericEqualityFilter</code> filters numeric values that equal or do not equal a given numeric value.</p>"
},
"TimeEqualityFilter":{
"shape":"TimeEqualityFilter",
"documentation":"<p>A <code>TimeEqualityFilter</code> filters date-time values that equal or do not equal a given date/time value.</p>"
},
"TimeRangeFilter":{
"shape":"TimeRangeFilter",
"documentation":"<p>A <code>TimeRangeFilter</code> filters date-time values that are either inside or outside a given date/time range.</p>"
},
"RelativeDatesFilter":{
"shape":"RelativeDatesFilter",
"documentation":"<p>A <code>RelativeDatesFilter</code> filters date values that are relative to a given date.</p>"
},
"TopBottomFilter":{
"shape":"TopBottomFilter",
"documentation":"<p>A <code>TopBottomFilter</code> filters data to the top or bottom values for a given column.</p>"
}
},
"documentation":"<p>With a <code>Filter</code>, you can remove portions of data from a particular visual or view.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilterControl":{
"type":"structure",
"members":{
"DateTimePicker":{
"shape":"FilterDateTimePickerControl",
"documentation":"<p>A control from a date filter that is used to specify date and time.</p>"
},
"List":{
"shape":"FilterListControl",
"documentation":"<p>A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.</p>"
},
"Dropdown":{
"shape":"FilterDropDownControl",
"documentation":"<p>A control to display a dropdown list with buttons that are used to select a single value.</p>"
},
"TextField":{
"shape":"FilterTextFieldControl",
"documentation":"<p>A control to display a text box that is used to enter a single entry.</p>"
},
"TextArea":{
"shape":"FilterTextAreaControl",
"documentation":"<p>A control to display a text box that is used to enter multiple entries.</p>"
},
"Slider":{
"shape":"FilterSliderControl",
"documentation":"<p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>"
},
"RelativeDateTime":{
"shape":"FilterRelativeDateTimeControl",
"documentation":"<p>A control from a date filter that is used to specify the relative date.</p>"
}
},
"documentation":"<p>The control of a filter that is used to interact with a dashboard or an analysis.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilterControlList":{
"type":"list",
"member":{"shape":"FilterControl"},
"max":200
},
"FilterDateTimePickerControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterDateTimePickerControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterDateTimePickerControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterDateTimePickerControl</code>.</p>"
},
"DisplayOptions":{
"shape":"DateTimePickerControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"Type":{
"shape":"SheetControlDateTimePickerType",
"documentation":"<p>The date time picker type of a <code>FilterDateTimePickerControl</code>. Choose one of the following options:</p> <ul> <li> <p> <code>SINGLE_VALUED</code>: The filter condition is a fixed date.</p> </li> <li> <p> <code>DATE_RANGE</code>: The filter condition is a date time range.</p> </li> </ul>"
}
},
"documentation":"<p>A control from a date filter that is used to specify date and time.</p>"
},
"FilterDropDownControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterDropDownControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterDropDownControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterDropDownControl</code>.</p>"
},
"DisplayOptions":{
"shape":"DropDownControlDisplayOptions",
"documentation":"<p>The display options of the <code>FilterDropDownControl</code>.</p>"
},
"Type":{
"shape":"SheetControlListType",
"documentation":"<p>The type of the <code>FilterDropDownControl</code>. Choose one of the following options:</p> <ul> <li> <p> <code>MULTI_SELECT</code>: The user can select multiple entries from a dropdown menu.</p> </li> <li> <p> <code>SINGLE_SELECT</code>: The user can select a single entry from a dropdown menu.</p> </li> </ul>"
},
"SelectableValues":{
"shape":"FilterSelectableValues",
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"CascadingControlConfiguration":{
"shape":"CascadingControlConfiguration",
"documentation":"<p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>"
}
},
"documentation":"<p>A control to display a dropdown list with buttons that are used to select a single value.</p>"
},
"FilterGroup":{
"type":"structure",
"required":[
"FilterGroupId",
"Filters",
"ScopeConfiguration",
"CrossDataset"
],
"members":{
"FilterGroupId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The value that uniquely identifies a <code>FilterGroup</code> within a dashboard, template, or analysis.</p>"
},
"Filters":{
"shape":"FilterList",
"documentation":"<p>The list of filters that are present in a <code>FilterGroup</code>.</p>"
},
"ScopeConfiguration":{
"shape":"FilterScopeConfiguration",
"documentation":"<p>The configuration that specifies what scope to apply to a <code>FilterGroup</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"Status":{
"shape":"WidgetStatus",
"documentation":"<p>The status of the <code>FilterGroup</code>.</p>"
},
"CrossDataset":{
"shape":"CrossDatasetTypes",
"documentation":"<p>The filter new feature which can apply filter group to all data sets. Choose one of the following options:</p> <ul> <li> <p> <code>ALL_DATASETS</code> </p> </li> <li> <p> <code>SINGLE_DATASET</code> </p> </li> </ul>"
}
},
"documentation":"<p>A grouping of individual filters. Filter groups are applied to the same group of visuals.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/add-a-compound-filter.html\">Adding filter conditions (group filters) with AND and OR operators</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FilterGroupList":{
"type":"list",
"member":{"shape":"FilterGroup"},
"max":2000
},
"FilterList":{
"type":"list",
"member":{"shape":"Filter"},
"max":20
},
"FilterListConfiguration":{
"type":"structure",
"required":["MatchOperator"],
"members":{
"MatchOperator":{
"shape":"CategoryFilterMatchOperator",
"documentation":"<p>The match operator that is used to determine if a filter should be applied.</p>"
},
"CategoryValues":{
"shape":"CategoryValueList",
"documentation":"<p>The list of category values for the filter.</p>"
},
"SelectAllOptions":{
"shape":"CategoryFilterSelectAllOptions",
"documentation":"<p>Select all of the values. Null is not the assigned value of select all.</p> <ul> <li> <p> <code>FILTER_ALL_VALUES</code> </p> </li> </ul>"
}
},
"documentation":"<p>A list of filter configurations.</p>"
},
"FilterListControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterListControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterListControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterListControl</code>.</p>"
},
"DisplayOptions":{
"shape":"ListControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"Type":{
"shape":"SheetControlListType",
"documentation":"<p>The type of <code>FilterListControl</code>. Choose one of the following options:</p> <ul> <li> <p> <code>MULTI_SELECT</code>: The user can select multiple entries from the list.</p> </li> <li> <p> <code>SINGLE_SELECT</code>: The user can select a single entry from the list.</p> </li> </ul>"
},
"SelectableValues":{
"shape":"FilterSelectableValues",
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"CascadingControlConfiguration":{
"shape":"CascadingControlConfiguration",
"documentation":"<p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>"
}
},
"documentation":"<p>A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.</p>"
},
"FilterNullOption":{
"type":"string",
"enum":[
"ALL_VALUES",
"NULLS_ONLY",
"NON_NULLS_ONLY"
]
},
"FilterOperation":{
"type":"structure",
"required":["ConditionExpression"],
"members":{
"ConditionExpression":{
"shape":"Expression",
"documentation":"<p>An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.</p>"
}
},
"documentation":"<p>A transform operation that filters rows based on a condition.</p>"
},
"FilterOperationSelectedFieldsConfiguration":{
"type":"structure",
"members":{
"SelectedFields":{
"shape":"SelectedFieldList",
"documentation":"<p>Chooses the fields that are filtered in <code>CustomActionFilterOperation</code>.</p>"
},
"SelectedFieldOptions":{
"shape":"SelectedFieldOptions",
"documentation":"<p>A structure that contains the options that choose which fields are filtered in the <code>CustomActionFilterOperation</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>ALL_FIELDS</code>: Applies the filter operation to all fields.</p> </li> </ul>"
}
},
"documentation":"<p>The configuration of selected fields in the<code>CustomActionFilterOperation</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilterOperationTargetVisualsConfiguration":{
"type":"structure",
"members":{
"SameSheetTargetVisualConfiguration":{
"shape":"SameSheetTargetVisualConfiguration",
"documentation":"<p>The configuration of the same-sheet target visuals that you want to be filtered.</p>"
}
},
"documentation":"<p>The configuration of target visuals that you want to be filtered.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilterOperator":{
"type":"string",
"enum":[
"StringEquals",
"StringLike"
]
},
"FilterRelativeDateTimeControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterTextAreaControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterTextAreaControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterTextAreaControl</code>.</p>"
},
"DisplayOptions":{
"shape":"RelativeDateTimeControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control from a date filter that is used to specify the relative date.</p>"
},
"FilterScopeConfiguration":{
"type":"structure",
"members":{
"SelectedSheets":{
"shape":"SelectedSheetsFilterScopeConfiguration",
"documentation":"<p>The configuration for applying a filter to specific sheets.</p>"
}
},
"documentation":"<p>The scope configuration for a <code>FilterGroup</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FilterSelectableValues":{
"type":"structure",
"members":{
"Values":{
"shape":"ParameterSelectableValueList",
"documentation":"<p>The values that are used in the <code>FilterSelectableValues</code>.</p>"
}
},
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"FilterSliderControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId",
"MaximumValue",
"MinimumValue",
"StepSize"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterSliderControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterSliderControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterSliderControl</code>.</p>"
},
"DisplayOptions":{
"shape":"SliderControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"Type":{
"shape":"SheetControlSliderType",
"documentation":"<p>The type of <code>FilterSliderControl</code>. Choose one of the following options:</p> <ul> <li> <p> <code>SINGLE_POINT</code>: Filter against(equals) a single data point.</p> </li> <li> <p> <code>RANGE</code>: Filter data that is in a specified range.</p> </li> </ul>"
},
"MaximumValue":{
"shape":"Double",
"documentation":"<p>The smaller value that is displayed at the left of the slider.</p>"
},
"MinimumValue":{
"shape":"Double",
"documentation":"<p>The larger value that is displayed at the right of the slider.</p>"
},
"StepSize":{
"shape":"Double",
"documentation":"<p>The number of increments that the slider bar is divided into.</p>"
}
},
"documentation":"<p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>"
},
"FilterTextAreaControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterTextAreaControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterTextAreaControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterTextAreaControl</code>.</p>"
},
"Delimiter":{
"shape":"TextAreaControlDelimiter",
"documentation":"<p>The delimiter that is used to separate the lines in text.</p>"
},
"DisplayOptions":{
"shape":"TextAreaControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control to display a text box that is used to enter multiple entries.</p>"
},
"FilterTextFieldControl":{
"type":"structure",
"required":[
"FilterControlId",
"Title",
"SourceFilterId"
],
"members":{
"FilterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>FilterTextFieldControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>FilterTextFieldControl</code>.</p>"
},
"SourceFilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The source filter ID of the <code>FilterTextFieldControl</code>.</p>"
},
"DisplayOptions":{
"shape":"TextFieldControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control to display a text box that is used to enter a single entry.</p>"
},
"FilterVisualScope":{
"type":"string",
"enum":[
"ALL_VISUALS",
"SELECTED_VISUALS"
]
},
"FilteredVisualsList":{
"type":"list",
"member":{"shape":"ShortRestrictiveResourceId"},
"max":50
},
"Folder":{
"type":"structure",
"members":{
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the folder.</p>"
},
"Name":{
"shape":"FolderName",
"documentation":"<p>A display name for the folder.</p>"
},
"FolderType":{
"shape":"FolderType",
"documentation":"<p>The type of folder it is.</p>"
},
"FolderPath":{
"shape":"Path",
"documentation":"<p>An array of ancestor ARN strings for the folder.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the folder was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the folder was last updated.</p>"
}
},
"documentation":"<p>A folder in Amazon QuickSight.</p>"
},
"FolderColumnList":{
"type":"list",
"member":{"shape":"String"},
"max":5000
},
"FolderFilterAttribute":{
"type":"string",
"enum":[
"PARENT_FOLDER_ARN",
"DIRECT_QUICKSIGHT_OWNER",
"DIRECT_QUICKSIGHT_SOLE_OWNER",
"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER",
"QUICKSIGHT_OWNER",
"QUICKSIGHT_VIEWER_OR_OWNER",
"FOLDER_NAME"
]
},
"FolderMember":{
"type":"structure",
"members":{
"MemberId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of an asset in the folder.</p>"
},
"MemberType":{
"shape":"MemberType",
"documentation":"<p>The type of asset that it is.</p>"
}
},
"documentation":"<p>An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.</p>"
},
"FolderMemberList":{
"type":"list",
"member":{"shape":"MemberIdArnPair"},
"max":100
},
"FolderName":{
"type":"string",
"max":200,
"min":1
},
"FolderSearchFilter":{
"type":"structure",
"members":{
"Operator":{
"shape":"FilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>. Valid values are <code>\"StringEquals\"</code> and <code>\"StringLike\"</code>.</p> <p>If you set the operator value to <code>\"StringEquals\"</code>, you need to provide an ownership related filter in the <code>\"NAME\"</code> field and the arn of the user or group whose folders you want to search in the <code>\"Value\"</code> field. For example, <code>\"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p> <p>If you set the value to <code>\"StringLike\"</code>, you need to provide the name of the folders you are searching for. For example, <code>\"Name\":\"FOLDER_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\"</code>. The <code>\"StringLike\"</code> operator only supports the <code>NAME</code> value <code>FOLDER_NAME</code>.</p>"
},
"Name":{
"shape":"FolderFilterAttribute",
"documentation":"<p>The name of a value that you want to use in the filter. For example, <code>\"Name\": \"QUICKSIGHT_OWNER\"</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>QUICKSIGHT_VIEWER_OR_OWNER</code>: 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.</p> </li> <li> <p> <code>QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_SOLE_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_OWNER</code>: 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.</p> </li> <li> <p> <code>DIRECT_QUICKSIGHT_VIEWER_OR_OWNER</code>: 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. </p> </li> <li> <p> <code>FOLDER_NAME</code>: Any folders whose names have a substring match to this value will be returned.</p> </li> <li> <p> <code>PARENT_FOLDER_ARN</code>: 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. </p> </li> </ul>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item (in this example, <code>PARENT_FOLDER_ARN</code>), that you want to use as a filter. For example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\"</code>.</p>"
}
},
"documentation":"<p>A filter to use to search an Amazon QuickSight folder.</p>"
},
"FolderSearchFilterList":{
"type":"list",
"member":{"shape":"FolderSearchFilter"},
"max":100
},
"FolderSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the folder.</p>"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"Name":{
"shape":"FolderName",
"documentation":"<p>The display name of the folder.</p>"
},
"FolderType":{
"shape":"FolderType",
"documentation":"<p>The type of folder.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the folder was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that the folder was last updated.</p>"
}
},
"documentation":"<p>A summary of information about an existing Amazon QuickSight folder. </p>"
},
"FolderSummaryList":{
"type":"list",
"member":{"shape":"FolderSummary"},
"max":100
},
"FolderType":{
"type":"string",
"enum":["SHARED"]
},
"Font":{
"type":"structure",
"members":{
"FontFamily":{
"shape":"String",
"documentation":"<p>Determines the font family settings.</p>"
}
},
"documentation":"<p>Determines the font settings.</p>"
},
"FontConfiguration":{
"type":"structure",
"members":{
"FontSize":{
"shape":"FontSize",
"documentation":"<p>The option that determines the text display size.</p>"
},
"FontDecoration":{
"shape":"FontDecoration",
"documentation":"<p>Determines the appearance of decorative lines on the text.</p>"
},
"FontColor":{
"shape":"HexColor",
"documentation":"<p>Determines the color of the text.</p>"
},
"FontWeight":{
"shape":"FontWeight",
"documentation":"<p>The option that determines the text display weight, or boldness.</p>"
},
"FontStyle":{
"shape":"FontStyle",
"documentation":"<p>Determines the text display face that is inherited by the given font family.</p>"
}
},
"documentation":"<p>Configures the display properties of the given text.</p>"
},
"FontDecoration":{
"type":"string",
"enum":[
"UNDERLINE",
"NONE"
]
},
"FontList":{
"type":"list",
"member":{"shape":"Font"},
"max":5
},
"FontSize":{
"type":"structure",
"members":{
"Relative":{
"shape":"RelativeFontSize",
"documentation":"<p>The lexical name for the text size, proportional to its surrounding context.</p>"
}
},
"documentation":"<p>The option that determines the text display size.</p>"
},
"FontStyle":{
"type":"string",
"enum":[
"NORMAL",
"ITALIC"
]
},
"FontWeight":{
"type":"structure",
"members":{
"Name":{
"shape":"FontWeightName",
"documentation":"<p>The lexical name for the level of boldness of the text display.</p>"
}
},
"documentation":"<p>The option that determines the text display weight, or boldness.</p>"
},
"FontWeightName":{
"type":"string",
"enum":[
"NORMAL",
"BOLD"
]
},
"ForecastComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"PeriodsForward":{
"shape":"PeriodsForward",
"documentation":"<p>The periods forward setup of a forecast computation.</p>"
},
"PeriodsBackward":{
"shape":"PeriodsBackward",
"documentation":"<p>The periods backward setup of a forecast computation.</p>"
},
"UpperBoundary":{
"shape":"Double",
"documentation":"<p>The upper boundary setup of a forecast computation.</p>",
"box":true
},
"LowerBoundary":{
"shape":"Double",
"documentation":"<p>The lower boundary setup of a forecast computation.</p>",
"box":true
},
"PredictionInterval":{
"shape":"PredictionInterval",
"documentation":"<p>The prediction interval setup of a forecast computation.</p>"
},
"Seasonality":{
"shape":"ForecastComputationSeasonality",
"documentation":"<p>The seasonality setup of a forecast computation. Choose one of the following options:</p> <ul> <li> <p> <code>AUTOMATIC</code> </p> </li> <li> <p> <code>CUSTOM</code>: Checks the custom seasonality value.</p> </li> </ul>"
},
"CustomSeasonalityValue":{
"shape":"ForecastComputationCustomSeasonalityValue",
"documentation":"<p>The custom seasonality value setup of a forecast computation.</p>",
"box":true
}
},
"documentation":"<p>The forecast computation configuration.</p>"
},
"ForecastComputationCustomSeasonalityValue":{
"type":"integer",
"max":180,
"min":1
},
"ForecastComputationSeasonality":{
"type":"string",
"enum":[
"AUTOMATIC",
"CUSTOM"
]
},
"ForecastConfiguration":{
"type":"structure",
"members":{
"ForecastProperties":{
"shape":"TimeBasedForecastProperties",
"documentation":"<p>The forecast properties setup of a forecast in the line chart.</p>"
},
"Scenario":{
"shape":"ForecastScenario",
"documentation":"<p>The forecast scenario of a forecast in the line chart.</p>"
}
},
"documentation":"<p>The forecast configuration that is used in a line chart's display properties.</p>"
},
"ForecastConfigurationList":{
"type":"list",
"member":{"shape":"ForecastConfiguration"},
"max":10
},
"ForecastScenario":{
"type":"structure",
"members":{
"WhatIfPointScenario":{
"shape":"WhatIfPointScenario",
"documentation":"<p>The what-if analysis forecast setup with the target date.</p>"
},
"WhatIfRangeScenario":{
"shape":"WhatIfRangeScenario",
"documentation":"<p>The what-if analysis forecast setup with the date range.</p>"
}
},
"documentation":"<p>The forecast scenario of a forecast in the line chart.</p>"
},
"FormatConfiguration":{
"type":"structure",
"members":{
"StringFormatConfiguration":{
"shape":"StringFormatConfiguration",
"documentation":"<p>Formatting configuration for string fields.</p>"
},
"NumberFormatConfiguration":{
"shape":"NumberFormatConfiguration",
"documentation":"<p>Formatting configuration for number fields.</p>"
},
"DateTimeFormatConfiguration":{
"shape":"DateTimeFormatConfiguration",
"documentation":"<p>Formatting configuration for <code>DateTime</code> fields.</p>"
}
},
"documentation":"<p>The formatting configuration for all types of field.</p>"
},
"FreeFormLayoutCanvasSizeOptions":{
"type":"structure",
"members":{
"ScreenCanvasSizeOptions":{
"shape":"FreeFormLayoutScreenCanvasSizeOptions",
"documentation":"<p>The options that determine the sizing of the canvas used in a free-form layout.</p>"
}
},
"documentation":"<p>Configuration options for the canvas of a free-form layout.</p>"
},
"FreeFormLayoutConfiguration":{
"type":"structure",
"required":["Elements"],
"members":{
"Elements":{
"shape":"FreeFromLayoutElementList",
"documentation":"<p>The elements that are included in a free-form layout.</p>"
},
"CanvasSizeOptions":{"shape":"FreeFormLayoutCanvasSizeOptions"}
},
"documentation":"<p>The configuration of a free-form layout.</p>"
},
"FreeFormLayoutElement":{
"type":"structure",
"required":[
"ElementId",
"ElementType",
"XAxisLocation",
"YAxisLocation",
"Width",
"Height"
],
"members":{
"ElementId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>A unique identifier for an element within a free-form layout.</p>"
},
"ElementType":{
"shape":"LayoutElementType",
"documentation":"<p>The type of element.</p>"
},
"XAxisLocation":{
"shape":"PixelLength",
"documentation":"<p>The x-axis coordinate of the element.</p>"
},
"YAxisLocation":{
"shape":"UnlimitedPixelLength",
"documentation":"<p>The y-axis coordinate of the element.</p>"
},
"Width":{
"shape":"PixelLength",
"documentation":"<p>The width of an element within a free-form layout.</p>"
},
"Height":{
"shape":"PixelLength",
"documentation":"<p>The height of an element within a free-form layout.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of an element within a free-form layout.</p>"
},
"RenderingRules":{
"shape":"SheetElementRenderingRuleList",
"documentation":"<p>The rendering rules that determine when an element should be displayed within a free-form layout.</p>"
},
"BorderStyle":{
"shape":"FreeFormLayoutElementBorderStyle",
"documentation":"<p>The border style configuration of a free-form layout element.</p>"
},
"SelectedBorderStyle":{
"shape":"FreeFormLayoutElementBorderStyle",
"documentation":"<p>The border style configuration of a free-form layout element. This border style is used when the element is selected.</p>"
},
"BackgroundStyle":{
"shape":"FreeFormLayoutElementBackgroundStyle",
"documentation":"<p>The background style configuration of a free-form layout element.</p>"
},
"LoadingAnimation":{
"shape":"LoadingAnimation",
"documentation":"<p>The loading animation configuration of a free-form layout element.</p>"
}
},
"documentation":"<p>An element within a free-form layout.</p>"
},
"FreeFormLayoutElementBackgroundStyle":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The background visibility of a free-form layout element.</p>"
},
"Color":{
"shape":"HexColorWithTransparency",
"documentation":"<p>The background color of a free-form layout element.</p>"
}
},
"documentation":"<p>The background style configuration of a free-form layout element.</p>"
},
"FreeFormLayoutElementBorderStyle":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The border visibility of a free-form layout element.</p>"
},
"Color":{
"shape":"HexColorWithTransparency",
"documentation":"<p>The border color of a free-form layout element.</p>"
}
},
"documentation":"<p>The background style configuration of a free-form layout element.</p>"
},
"FreeFormLayoutScreenCanvasSizeOptions":{
"type":"structure",
"required":["OptimizedViewPortWidth"],
"members":{
"OptimizedViewPortWidth":{
"shape":"PixelLength",
"documentation":"<p>The width that the view port will be optimized for when the layout renders.</p>",
"box":true
}
},
"documentation":"<p>The options that determine the sizing of the canvas used in a free-form layout.</p>"
},
"FreeFormSectionLayoutConfiguration":{
"type":"structure",
"required":["Elements"],
"members":{
"Elements":{
"shape":"FreeFromLayoutElementList",
"documentation":"<p>The elements that are included in the free-form layout.</p>"
}
},
"documentation":"<p>The free-form layout configuration of a section.</p>"
},
"FreeFromLayoutElementList":{
"type":"list",
"member":{"shape":"FreeFormLayoutElement"},
"max":430
},
"FunnelChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Category":{
"shape":"FunnelChartDimensionFieldList",
"documentation":"<p>The category field wells of a funnel chart. Values are grouped by category fields.</p>"
},
"Values":{
"shape":"FunnelChartMeasureFieldList",
"documentation":"<p>The value field wells of a funnel chart. Values are aggregated based on categories.</p>"
}
},
"documentation":"<p>The field well configuration of a <code>FunnelChartVisual</code>.</p>"
},
"FunnelChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"FunnelChartFieldWells",
"documentation":"<p>The field well configuration of a <code>FunnelChartVisual</code>.</p>"
},
"SortConfiguration":{
"shape":"FunnelChartSortConfiguration",
"documentation":"<p>The sort configuration of a <code>FunnelChartVisual</code>.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options of the categories that are displayed in a <code>FunnelChartVisual</code>.</p>"
},
"ValueLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options for the values that are displayed in a <code>FunnelChartVisual</code>.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip configuration of a <code>FunnelChartVisual</code>.</p>"
},
"DataLabelOptions":{
"shape":"FunnelChartDataLabelOptions",
"documentation":"<p>The options that determine the presentation of the data labels.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The visual palette configuration of a <code>FunnelChartVisual</code>.</p>"
}
},
"documentation":"<p>The configuration of a <code>FunnelChartVisual</code>.</p>"
},
"FunnelChartDataLabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility option that determines if data labels are displayed.</p>"
},
"CategoryLabelVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the category labels within the data labels.</p>"
},
"MeasureLabelVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the measure labels within the data labels.</p>"
},
"Position":{
"shape":"DataLabelPosition",
"documentation":"<p>Determines the positioning of the data label relative to a section of the funnel.</p>"
},
"LabelFontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration for the data labels.</p> <p>Only the <code>FontSize</code> attribute of the font configuration is used for data labels.</p>"
},
"LabelColor":{
"shape":"HexColor",
"documentation":"<p>The color of the data label text.</p>"
},
"MeasureDataLabelStyle":{
"shape":"FunnelChartMeasureDataLabelStyle",
"documentation":"<p>Determines the style of the metric labels.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the data labels.</p>"
},
"FunnelChartDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"FunnelChartFieldWells":{
"type":"structure",
"members":{
"FunnelChartAggregatedFieldWells":{
"shape":"FunnelChartAggregatedFieldWells",
"documentation":"<p>The field well configuration of a <code>FunnelChartVisual</code>.</p>"
}
},
"documentation":"<p>The field well configuration of a <code>FunnelChartVisual</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"FunnelChartMeasureDataLabelStyle":{
"type":"string",
"enum":[
"VALUE_ONLY",
"PERCENTAGE_BY_FIRST_STAGE",
"PERCENTAGE_BY_PREVIOUS_STAGE",
"VALUE_AND_PERCENTAGE_BY_FIRST_STAGE",
"VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"
]
},
"FunnelChartMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"FunnelChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the category fields.</p>"
},
"CategoryItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of categories displayed.</p>"
}
},
"documentation":"<p>The sort configuration of a <code>FunnelChartVisual</code>.</p>"
},
"FunnelChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"FunnelChartConfiguration",
"documentation":"<p>The configuration of a <code>FunnelChartVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A funnel chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html\">Using funnel charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"GaugeChartArcConditionalFormatting":{
"type":"structure",
"members":{
"ForegroundColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting of the arc foreground color.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the arc of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartConditionalFormatting":{
"type":"structure",
"members":{
"ConditionalFormattingOptions":{
"shape":"GaugeChartConditionalFormattingOptionList",
"documentation":"<p>Conditional formatting options of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>The conditional formatting of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartConditionalFormattingOption":{
"type":"structure",
"members":{
"PrimaryValue":{
"shape":"GaugeChartPrimaryValueConditionalFormatting",
"documentation":"<p>The conditional formatting for the primary value of a <code>GaugeChartVisual</code>.</p>"
},
"Arc":{
"shape":"GaugeChartArcConditionalFormatting",
"documentation":"<p>The options that determine the presentation of the arc of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>Conditional formatting options of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartConditionalFormattingOptionList":{
"type":"list",
"member":{"shape":"GaugeChartConditionalFormattingOption"},
"max":100
},
"GaugeChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"GaugeChartFieldWells",
"documentation":"<p>The field well configuration of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartOptions":{
"shape":"GaugeChartOptions",
"documentation":"<p>The options that determine the presentation of the <code>GaugeChartVisual</code>.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The data label configuration of a <code>GaugeChartVisual</code>.</p>"
},
"TooltipOptions":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip configuration of a <code>GaugeChartVisual</code>.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The visual palette configuration of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>The configuration of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartFieldWells":{
"type":"structure",
"members":{
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a <code>GaugeChartVisual</code>.</p>"
},
"TargetValues":{
"shape":"MeasureFieldList",
"documentation":"<p>The target value field wells of a <code>GaugeChartVisual</code>.</p>"
}
},
"documentation":"<p>The field well configuration of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartOptions":{
"type":"structure",
"members":{
"PrimaryValueDisplayType":{
"shape":"PrimaryValueDisplayType",
"documentation":"<p>The options that determine the primary value display type.</p>"
},
"Comparison":{
"shape":"ComparisonConfiguration",
"documentation":"<p>The comparison configuration of a <code>GaugeChartVisual</code>.</p>"
},
"ArcAxis":{
"shape":"ArcAxisConfiguration",
"documentation":"<p>The arc axis configuration of a <code>GaugeChartVisual</code>.</p>"
},
"Arc":{
"shape":"ArcConfiguration",
"documentation":"<p>The arc configuration of a <code>GaugeChartVisual</code>.</p>"
},
"PrimaryValueFontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The options that determine the primary value font configuration.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartPrimaryValueConditionalFormatting":{
"type":"structure",
"members":{
"TextColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting of the primary value text color.</p>"
},
"Icon":{
"shape":"ConditionalFormattingIcon",
"documentation":"<p>The conditional formatting of the primary value icon.</p>"
}
},
"documentation":"<p>The conditional formatting for the primary value of a <code>GaugeChartVisual</code>.</p>"
},
"GaugeChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"GaugeChartConfiguration",
"documentation":"<p>The configuration of a <code>GaugeChartVisual</code>.</p>"
},
"ConditionalFormatting":{
"shape":"GaugeChartConditionalFormatting",
"documentation":"<p>The conditional formatting of a <code>GaugeChartVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A gauge chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html\">Using gauge charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"GenerateEmbedUrlForAnonymousUserRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace",
"AuthorizedResourceArns",
"ExperienceConfiguration"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"SessionLifetimeInMinutes":{
"shape":"SessionLifetimeInMinutes",
"documentation":"<p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to <code>default</code>.</p>"
},
"SessionTags":{
"shape":"SessionTagList",
"documentation":"<p>The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the <code>DataSet$RowLevelPermissionTagConfiguration</code> parameter so that session tags can be used to provide row-level security.</p> <p>These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-rls-tags.html\">Using Row-Level Security (RLS) with Tags</a>in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"AuthorizedResourceArns":{
"shape":"ArnList",
"documentation":"<p>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 <code>Dashboard</code> 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.</p>"
},
"ExperienceConfiguration":{
"shape":"AnonymousUserEmbeddingExperienceConfiguration",
"documentation":"<p>The configuration of the experience that you are embedding.</p>"
},
"AllowedDomains":{
"shape":"StringList",
"documentation":"<p>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.</p> <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>. For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under <code>https://sapp.amazon.com</code>.</p>"
}
}
},
"GenerateEmbedUrlForAnonymousUserResponse":{
"type":"structure",
"required":[
"EmbedUrl",
"Status",
"RequestId",
"AnonymousUserArn"
],
"members":{
"EmbedUrl":{
"shape":"EmbeddingUrl",
"documentation":"<p>The embed URL for the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"AnonymousUserArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.</p>"
}
}
},
"GenerateEmbedUrlForRegisteredUserRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"UserArn",
"ExperienceConfiguration"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"SessionLifetimeInMinutes":{
"shape":"SessionLifetimeInMinutes",
"documentation":"<p>How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.</p>"
},
"UserArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name for the registered user.</p>"
},
"ExperienceConfiguration":{
"shape":"RegisteredUserEmbeddingExperienceConfiguration",
"documentation":"<p>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.</p>"
},
"AllowedDomains":{
"shape":"StringList",
"documentation":"<p>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.</p> <p>To include all subdomains under a specific domain to the allow list, use <code>*</code>. For example, <code>https://*.sapp.amazon.com</code> includes all subdomains under <code>https://sapp.amazon.com</code>.</p>"
}
}
},
"GenerateEmbedUrlForRegisteredUserResponse":{
"type":"structure",
"required":[
"EmbedUrl",
"Status",
"RequestId"
],
"members":{
"EmbedUrl":{
"shape":"EmbeddingUrl",
"documentation":"<p>The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, or console.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"GeoSpatialColumnGroup":{
"type":"structure",
"required":[
"Name",
"Columns"
],
"members":{
"Name":{
"shape":"ColumnGroupName",
"documentation":"<p>A display name for the hierarchy.</p>"
},
"CountryCode":{
"shape":"GeoSpatialCountryCode",
"documentation":"<p>Country code.</p>"
},
"Columns":{
"shape":"ColumnList",
"documentation":"<p>Columns in this hierarchy.</p>"
}
},
"documentation":"<p>Geospatial column group that denotes a hierarchy.</p>"
},
"GeoSpatialCountryCode":{
"type":"string",
"enum":["US"]
},
"GeoSpatialDataRole":{
"type":"string",
"enum":[
"COUNTRY",
"STATE",
"COUNTY",
"CITY",
"POSTCODE",
"LONGITUDE",
"LATITUDE"
]
},
"GeospatialCoordinateBounds":{
"type":"structure",
"required":[
"North",
"South",
"West",
"East"
],
"members":{
"North":{
"shape":"Latitude",
"documentation":"<p>The latitude of the north bound of the geospatial coordinate bounds.</p>"
},
"South":{
"shape":"Latitude",
"documentation":"<p>The latitude of the south bound of the geospatial coordinate bounds.</p>"
},
"West":{
"shape":"Longitude",
"documentation":"<p>The longitude of the west bound of the geospatial coordinate bounds.</p>"
},
"East":{
"shape":"Longitude",
"documentation":"<p>The longitude of the east bound of the geospatial coordinate bounds.</p>"
}
},
"documentation":"<p>The bound options (north, south, west, east) of the geospatial window options.</p>"
},
"GeospatialMapAggregatedFieldWells":{
"type":"structure",
"members":{
"Geospatial":{
"shape":"DimensionFieldList",
"documentation":"<p>The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The size field wells of a geospatial map. Values are aggregated based on geospatial fields.</p>"
},
"Colors":{
"shape":"DimensionFieldList",
"documentation":"<p>The color field wells of a geospatial map.</p>"
}
},
"documentation":"<p>The aggregated field wells for a geospatial map.</p>"
},
"GeospatialMapConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"GeospatialMapFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
},
"WindowOptions":{
"shape":"GeospatialWindowOptions",
"documentation":"<p>The window options of the geospatial map.</p>"
},
"MapStyleOptions":{
"shape":"GeospatialMapStyleOptions",
"documentation":"<p>The map style options of the geospatial map.</p>"
},
"PointStyleOptions":{
"shape":"GeospatialPointStyleOptions",
"documentation":"<p>The point style options of the geospatial map.</p>"
},
"VisualPalette":{"shape":"VisualPalette"}
},
"documentation":"<p>The configuration of a <code>GeospatialMapVisual</code>.</p>"
},
"GeospatialMapFieldWells":{
"type":"structure",
"members":{
"GeospatialMapAggregatedFieldWells":{
"shape":"GeospatialMapAggregatedFieldWells",
"documentation":"<p>The aggregated field well for a geospatial map.</p>"
}
},
"documentation":"<p>The field wells of a <code>GeospatialMapVisual</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"GeospatialMapStyleOptions":{
"type":"structure",
"members":{
"BaseMapStyle":{
"shape":"BaseMapStyleType",
"documentation":"<p>The base map style of the geospatial map.</p>"
}
},
"documentation":"<p>The map style options of the geospatial map.</p>"
},
"GeospatialMapVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"GeospatialMapConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A geospatial map or a points on map visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html\">Creating point maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"GeospatialPointStyleOptions":{
"type":"structure",
"members":{
"SelectedPointStyle":{
"shape":"GeospatialSelectedPointStyle",
"documentation":"<p>The selected point styles (point, cluster) of the geospatial map.</p>"
},
"ClusterMarkerConfiguration":{
"shape":"ClusterMarkerConfiguration",
"documentation":"<p>The cluster marker configuration of the geospatial point style.</p>"
}
},
"documentation":"<p>The point style of the geospatial map.</p>"
},
"GeospatialSelectedPointStyle":{
"type":"string",
"enum":[
"POINT",
"CLUSTER"
]
},
"GeospatialWindowOptions":{
"type":"structure",
"members":{
"Bounds":{
"shape":"GeospatialCoordinateBounds",
"documentation":"<p>The bounds options (north, south, west, east) of the geospatial window options.</p>"
},
"MapZoomMode":{
"shape":"MapZoomMode",
"documentation":"<p>The map zoom modes (manual, auto) of the geospatial window options.</p>"
}
},
"documentation":"<p>The window options of the geospatial map visual.</p>"
},
"GetDashboardEmbedUrlRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId",
"IdentityType"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the dashboard that you're embedding.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"IdentityType":{
"shape":"EmbeddingIdentityType",
"documentation":"<p>The authentication method that the user uses to sign in.</p>",
"location":"querystring",
"locationName":"creds-type"
},
"SessionLifetimeInMinutes":{
"shape":"SessionLifetimeInMinutes",
"documentation":"<p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>",
"location":"querystring",
"locationName":"session-lifetime"
},
"UndoRedoDisabled":{
"shape":"Boolean",
"documentation":"<p>Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.</p>",
"location":"querystring",
"locationName":"undo-redo-disabled"
},
"ResetDisabled":{
"shape":"Boolean",
"documentation":"<p>Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.</p>",
"location":"querystring",
"locationName":"reset-disabled"
},
"StatePersistenceEnabled":{
"shape":"Boolean",
"documentation":"<p>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 <code>TRUE</code>, 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 <code>FALSE</code>.</p>",
"location":"querystring",
"locationName":"state-persistence-enabled"
},
"UserArn":{
"shape":"Arn",
"documentation":"<p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:</p> <ul> <li> <p>Active Directory (AD) users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li> <li> <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.</p> </li> </ul> <p>Omit this parameter for users in the third group IAM users and IAM role-based sessions.</p>",
"location":"querystring",
"locationName":"user-arn"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set <code>Namespace = default</code>.</p>",
"location":"querystring",
"locationName":"namespace"
},
"AdditionalDashboardIds":{
"shape":"AdditionalDashboardIdList",
"documentation":"<p>A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>\", the session can access all three dashboards.</p>",
"location":"querystring",
"locationName":"additional-dashboard-ids"
}
}
},
"GetDashboardEmbedUrlResponse":{
"type":"structure",
"members":{
"EmbedUrl":{
"shape":"EmbeddingUrl",
"documentation":"<p>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 <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
},
"documentation":"<p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>"
},
"GetSessionEmbedUrlRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"EntryPoint":{
"shape":"EntryPoint",
"documentation":"<p>The URL you use to access the embedded session. The entry point URL is constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p> </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p> <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code> </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where <code>DashboardId</code> is the actual ID key from the Amazon QuickSight console URL of the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> - where <code>AnalysisId</code> is the actual ID key from the Amazon QuickSight console URL of the analysis</p> </li> </ul>",
"location":"querystring",
"locationName":"entry-point"
},
"SessionLifetimeInMinutes":{
"shape":"SessionLifetimeInMinutes",
"documentation":"<p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>",
"location":"querystring",
"locationName":"session-lifetime"
},
"UserArn":{
"shape":"Arn",
"documentation":"<p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> 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:</p> <ol> <li> <p>Active Directory (AD) users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li> <li> <p>Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol> <p>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</p>",
"location":"querystring",
"locationName":"user-arn"
}
}
},
"GetSessionEmbedUrlResponse":{
"type":"structure",
"members":{
"EmbedUrl":{
"shape":"EmbeddingUrl",
"documentation":"<p>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 <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"GlobalTableBorderOptions":{
"type":"structure",
"members":{
"UniformBorder":{
"shape":"TableBorderOptions",
"documentation":"<p>Determines the options for uniform border.</p>"
},
"SideSpecificBorder":{
"shape":"TableSideBorderOptions",
"documentation":"<p>Determines the options for side specific border.</p>"
}
},
"documentation":"<p>Determines the border options for a table visual.</p>"
},
"GradientColor":{
"type":"structure",
"members":{
"Stops":{
"shape":"GradientStopList",
"documentation":"<p>The list of gradient color stops.</p>"
}
},
"documentation":"<p>Determines the gradient color settings.</p>"
},
"GradientStop":{
"type":"structure",
"required":["GradientOffset"],
"members":{
"GradientOffset":{
"shape":"Double",
"documentation":"<p>Determines gradient offset value.</p>"
},
"DataValue":{
"shape":"Double",
"documentation":"<p>Determines the data value.</p>",
"box":true
},
"Color":{
"shape":"HexColor",
"documentation":"<p>Determines the color.</p>"
}
},
"documentation":"<p>Determines the gradient stop configuration.</p>"
},
"GradientStopList":{
"type":"list",
"member":{"shape":"GradientStop"},
"max":100
},
"GridLayoutCanvasSizeOptions":{
"type":"structure",
"members":{
"ScreenCanvasSizeOptions":{
"shape":"GridLayoutScreenCanvasSizeOptions",
"documentation":"<p>The options that determine the sizing of the canvas used in a grid layout.</p>"
}
},
"documentation":"<p>Configuration options for the canvas of a grid layout.</p>"
},
"GridLayoutConfiguration":{
"type":"structure",
"required":["Elements"],
"members":{
"Elements":{
"shape":"GridLayoutElementList",
"documentation":"<p>The elements that are included in a grid layout.</p>"
},
"CanvasSizeOptions":{"shape":"GridLayoutCanvasSizeOptions"}
},
"documentation":"<p>The configuration for a grid layout. Also called a tiled layout.</p> <p>Visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size.</p>"
},
"GridLayoutElement":{
"type":"structure",
"required":[
"ElementId",
"ElementType",
"ColumnSpan",
"RowSpan"
],
"members":{
"ElementId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>A unique identifier for an element within a grid layout.</p>"
},
"ElementType":{
"shape":"LayoutElementType",
"documentation":"<p>The type of element.</p>"
},
"ColumnIndex":{
"shape":"GridLayoutElementColumnIndex",
"documentation":"<p>The column index for the upper left corner of an element.</p>"
},
"ColumnSpan":{
"shape":"GridLayoutElementColumnSpan",
"documentation":"<p>The width of a grid element expressed as a number of grid columns.</p>"
},
"RowIndex":{
"shape":"GridLayoutElementRowIndex",
"documentation":"<p>The row index for the upper left corner of an element.</p>"
},
"RowSpan":{
"shape":"GridLayoutElementRowSpan",
"documentation":"<p>The height of a grid element expressed as a number of grid rows.</p>"
}
},
"documentation":"<p>An element within a grid layout.</p>"
},
"GridLayoutElementColumnIndex":{
"type":"integer",
"max":35,
"min":0
},
"GridLayoutElementColumnSpan":{
"type":"integer",
"max":36,
"min":1
},
"GridLayoutElementList":{
"type":"list",
"member":{"shape":"GridLayoutElement"},
"max":430
},
"GridLayoutElementRowIndex":{
"type":"integer",
"max":9009,
"min":0
},
"GridLayoutElementRowSpan":{
"type":"integer",
"max":21,
"min":1
},
"GridLayoutScreenCanvasSizeOptions":{
"type":"structure",
"required":["ResizeOption"],
"members":{
"ResizeOption":{
"shape":"ResizeOption",
"documentation":"<p>This value determines the layout behavior when the viewport is resized.</p> <ul> <li> <p> <code>FIXED</code>: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called <code>Classic</code>.</p> </li> <li> <p> <code>RESPONSIVE</code>: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called <code>Tiled</code>.</p> </li> </ul>"
},
"OptimizedViewPortWidth":{
"shape":"PixelLength",
"documentation":"<p>The width that the view port will be optimized for when the layout renders.</p>",
"box":true
}
},
"documentation":"<p>The options that determine the sizing of the canvas used in a grid layout.</p>"
},
"Group":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the group.</p>"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group.</p>"
},
"Description":{
"shape":"GroupDescription",
"documentation":"<p>The group description.</p>"
},
"PrincipalId":{
"shape":"String",
"documentation":"<p>The principal ID of the group.</p>"
}
},
"documentation":"<p>A <i>group</i> in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. </p>"
},
"GroupDescription":{
"type":"string",
"max":512,
"min":1
},
"GroupFilterAttribute":{
"type":"string",
"enum":["GROUP_NAME"]
},
"GroupFilterOperator":{
"type":"string",
"enum":["StartsWith"]
},
"GroupList":{
"type":"list",
"member":{"shape":"Group"}
},
"GroupMember":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the group member (user).</p>"
},
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The name of the group member (user).</p>"
}
},
"documentation":"<p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. .</p>"
},
"GroupMemberList":{
"type":"list",
"member":{"shape":"GroupMember"}
},
"GroupMemberName":{
"type":"string",
"max":256,
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
},
"GroupName":{
"type":"string",
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
},
"GroupSearchFilter":{
"type":"structure",
"required":[
"Operator",
"Name",
"Value"
],
"members":{
"Operator":{
"shape":"GroupFilterOperator",
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StartsWith\"</code>. Currently, the only supported operator is <code>StartsWith</code>.</p>"
},
"Name":{
"shape":"GroupFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example <code>\"Name\": \"GROUP_NAME\"</code>. Currently, the only supported name is <code>GROUP_NAME</code>.</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, in this case <code>GROUP_NAME</code>, that you want to use as a filter.</p>"
}
},
"documentation":"<p>A <code>GroupSearchFilter</code> object that you want to apply to your search.</p>"
},
"GroupSearchFilterList":{
"type":"list",
"member":{"shape":"GroupSearchFilter"},
"max":1,
"min":1
},
"GroupsList":{
"type":"list",
"member":{"shape":"String"}
},
"GrowthRateComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"PeriodSize":{
"shape":"GrowthRatePeriodSize",
"documentation":"<p>The period size setup of a growth rate computation.</p>"
}
},
"documentation":"<p>The growth rate computation configuration.</p>"
},
"GrowthRatePeriodSize":{
"type":"integer",
"max":52,
"min":2
},
"GutterStyle":{
"type":"structure",
"members":{
"Show":{
"shape":"Boolean",
"documentation":"<p>This Boolean value controls whether to display a gutter space between sheet tiles. </p>",
"box":true
}
},
"documentation":"<p>The display options for gutter spacing between tiles on a sheet.</p>"
},
"HeaderFooterSectionConfiguration":{
"type":"structure",
"required":[
"SectionId",
"Layout"
],
"members":{
"SectionId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of the header or footer section.</p>"
},
"Layout":{
"shape":"SectionLayoutConfiguration",
"documentation":"<p>The layout configuration of the header or footer section.</p>"
},
"Style":{
"shape":"SectionStyle",
"documentation":"<p>The style options of a header or footer section.</p>"
}
},
"documentation":"<p>The configuration of a header or footer section.</p>"
},
"HeaderFooterSectionConfigurationList":{
"type":"list",
"member":{"shape":"HeaderFooterSectionConfiguration"},
"max":1
},
"HeatMapAggregatedFieldWells":{
"type":"structure",
"members":{
"Rows":{
"shape":"HeatMapDimensionFieldList",
"documentation":"<p>The rows field well of a heat map.</p>"
},
"Columns":{
"shape":"HeatMapDimensionFieldList",
"documentation":"<p>The columns field well of a heat map.</p>"
},
"Values":{
"shape":"HeatMapMeasureFieldList",
"documentation":"<p>The values field well of a heat map.</p>"
}
},
"documentation":"<p>The aggregated field wells of a heat map.</p>"
},
"HeatMapConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"HeatMapFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"HeatMapSortConfiguration",
"documentation":"<p>The sort configuration of a heat map.</p>"
},
"RowLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options of the row that is displayed in a <code>heat map</code>.</p>"
},
"ColumnLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options of the column that is displayed in a heat map.</p>"
},
"ColorScale":{
"shape":"ColorScale",
"documentation":"<p>The color options (gradient color, point of divergence) in a heat map.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a heat map.</p>"
},
"HeatMapDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"HeatMapFieldWells":{
"type":"structure",
"members":{
"HeatMapAggregatedFieldWells":{
"shape":"HeatMapAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a heat map.</p>"
}
},
"documentation":"<p>The field well configuration of a heat map.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"HeatMapMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"HeatMapSortConfiguration":{
"type":"structure",
"members":{
"HeatMapRowSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The field sort configuration of the rows fields.</p>"
},
"HeatMapColumnSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The column sort configuration for heat map for columns that aren't a part of a field well.</p>"
},
"HeatMapRowItemsLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of rows that are displayed in a heat map.</p>"
},
"HeatMapColumnItemsLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of columns that are displayed in a heat map.</p>"
}
},
"documentation":"<p>The sort configuration of a heat map.</p>"
},
"HeatMapVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"HeatMapConfiguration",
"documentation":"<p>The configuration of a heat map.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A heat map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html\">Using heat maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"HexColor":{
"type":"string",
"pattern":"^#[A-F0-9]{6}$"
},
"HexColorWithTransparency":{
"type":"string",
"pattern":"^#[A-F0-9]{6}(?:[A-F0-9]{2})?$"
},
"HierarchyId":{
"type":"string",
"max":512,
"min":1
},
"HistogramAggregatedFieldWells":{
"type":"structure",
"members":{
"Values":{
"shape":"HistogramMeasureFieldList",
"documentation":"<p>The value field wells of a histogram. Values are aggregated by <code>COUNT</code> or <code>DISTINCT_COUNT</code>.</p>"
}
},
"documentation":"<p>The field well configuration of a histogram.</p>"
},
"HistogramBinOptions":{
"type":"structure",
"members":{
"SelectedBinType":{
"shape":"HistogramBinType",
"documentation":"<p>The options that determine the selected bin type.</p>"
},
"BinCount":{
"shape":"BinCountOptions",
"documentation":"<p>The options that determine the bin count of a histogram.</p>"
},
"BinWidth":{
"shape":"BinWidthOptions",
"documentation":"<p>The options that determine the bin width of a histogram.</p>"
},
"StartValue":{
"shape":"Double",
"documentation":"<p>The options that determine the bin start value.</p>",
"box":true
}
},
"documentation":"<p>The options that determine the presentation of histogram bins.</p>"
},
"HistogramBinType":{
"type":"string",
"enum":[
"BIN_COUNT",
"BIN_WIDTH"
]
},
"HistogramConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"HistogramFieldWells",
"documentation":"<p>The field well configuration of a histogram.</p>"
},
"XAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the x-axis.</p>"
},
"XAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the x-axis label.</p>"
},
"YAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the y-axis.</p>"
},
"BinOptions":{
"shape":"HistogramBinOptions",
"documentation":"<p>The options that determine the presentation of histogram bins.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The data label configuration of a histogram.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip configuration of a histogram.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The visual palette configuration of a histogram.</p>"
}
},
"documentation":"<p>The configuration for a <code>HistogramVisual</code>.</p>"
},
"HistogramFieldWells":{
"type":"structure",
"members":{
"HistogramAggregatedFieldWells":{
"shape":"HistogramAggregatedFieldWells",
"documentation":"<p>The field well configuration of a histogram.</p>"
}
},
"documentation":"<p>The field well configuration of a histogram.</p>"
},
"HistogramMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"HistogramVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"HistogramConfiguration",
"documentation":"<p>The configuration for a <code>HistogramVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A histogram.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html\">Using histograms</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"HorizontalTextAlignment":{
"type":"string",
"enum":[
"LEFT",
"CENTER",
"RIGHT",
"AUTO"
]
},
"Host":{
"type":"string",
"max":256,
"min":1
},
"IAMPolicyAssignment":{
"type":"structure",
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>"
},
"AssignmentId":{
"shape":"String",
"documentation":"<p>Assignment ID.</p>"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>Assignment name.</p>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the IAM policy.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>Identities.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>Assignment status.</p>"
}
},
"documentation":"<p>An Identity and Access Management (IAM) policy assignment.</p>"
},
"IAMPolicyAssignmentName":{
"type":"string",
"min":1,
"pattern":"(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$"
},
"IAMPolicyAssignmentSummary":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>Assignment name.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>Assignment status.</p>"
}
},
"documentation":"<p>IAM policy assignment summary.</p>"
},
"IAMPolicyAssignmentSummaryList":{
"type":"list",
"member":{"shape":"IAMPolicyAssignmentSummary"}
},
"Icon":{
"type":"string",
"enum":[
"CARET_UP",
"CARET_DOWN",
"PLUS",
"MINUS",
"ARROW_UP",
"ARROW_DOWN",
"ARROW_LEFT",
"ARROW_UP_LEFT",
"ARROW_DOWN_LEFT",
"ARROW_RIGHT",
"ARROW_UP_RIGHT",
"ARROW_DOWN_RIGHT",
"FACE_UP",
"FACE_DOWN",
"FACE_FLAT",
"ONE_BAR",
"TWO_BAR",
"THREE_BAR",
"CIRCLE",
"TRIANGLE",
"SQUARE",
"FLAG",
"THUMBS_UP",
"THUMBS_DOWN",
"CHECKMARK",
"X"
]
},
"IdentityMap":{
"type":"map",
"key":{"shape":"String"},
"value":{"shape":"IdentityNameList"}
},
"IdentityName":{
"type":"string",
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
},
"IdentityNameList":{
"type":"list",
"member":{"shape":"IdentityName"}
},
"IdentityStore":{
"type":"string",
"enum":["QUICKSIGHT"]
},
"IdentityType":{
"type":"string",
"enum":[
"IAM",
"QUICKSIGHT"
]
},
"IdentityTypeNotSupportedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The identity type specified isn't supported. Supported identity types include <code>IAM</code> and <code>QUICKSIGHT</code>.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"Ingestion":{
"type":"structure",
"required":[
"Arn",
"IngestionStatus",
"CreatedTime"
],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>Ingestion ID.</p>"
},
"IngestionStatus":{
"shape":"IngestionStatus",
"documentation":"<p>Ingestion status.</p>"
},
"ErrorInfo":{
"shape":"ErrorInfo",
"documentation":"<p>Error information for this ingestion.</p>"
},
"RowInfo":{"shape":"RowInfo"},
"QueueInfo":{"shape":"QueueInfo"},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this ingestion started.</p>"
},
"IngestionTimeInSeconds":{
"shape":"Long",
"documentation":"<p>The time that this ingestion took, measured in seconds.</p>",
"box":true
},
"IngestionSizeInBytes":{
"shape":"Long",
"documentation":"<p>The size of the data ingested, in bytes.</p>",
"box":true
},
"RequestSource":{
"shape":"IngestionRequestSource",
"documentation":"<p>Event source for this ingestion.</p>"
},
"RequestType":{
"shape":"IngestionRequestType",
"documentation":"<p>Type of this ingestion.</p>"
}
},
"documentation":"<p>Information about the SPICE ingestion for a dataset.</p>"
},
"IngestionErrorType":{
"type":"string",
"enum":[
"FAILURE_TO_ASSUME_ROLE",
"INGESTION_SUPERSEDED",
"INGESTION_CANCELED",
"DATA_SET_DELETED",
"DATA_SET_NOT_SPICE",
"S3_UPLOADED_FILE_DELETED",
"S3_MANIFEST_ERROR",
"DATA_TOLERANCE_EXCEPTION",
"SPICE_TABLE_NOT_FOUND",
"DATA_SET_SIZE_LIMIT_EXCEEDED",
"ROW_SIZE_LIMIT_EXCEEDED",
"ACCOUNT_CAPACITY_LIMIT_EXCEEDED",
"CUSTOMER_ERROR",
"DATA_SOURCE_NOT_FOUND",
"IAM_ROLE_NOT_AVAILABLE",
"CONNECTION_FAILURE",
"SQL_TABLE_NOT_FOUND",
"PERMISSION_DENIED",
"SSL_CERTIFICATE_VALIDATION_FAILURE",
"OAUTH_TOKEN_FAILURE",
"SOURCE_API_LIMIT_EXCEEDED_FAILURE",
"PASSWORD_AUTHENTICATION_FAILURE",
"SQL_SCHEMA_MISMATCH_ERROR",
"INVALID_DATE_FORMAT",
"INVALID_DATAPREP_SYNTAX",
"SOURCE_RESOURCE_LIMIT_EXCEEDED",
"SQL_INVALID_PARAMETER_VALUE",
"QUERY_TIMEOUT",
"SQL_NUMERIC_OVERFLOW",
"UNRESOLVABLE_HOST",
"UNROUTABLE_HOST",
"SQL_EXCEPTION",
"S3_FILE_INACCESSIBLE",
"IOT_FILE_NOT_FOUND",
"IOT_DATA_SET_FILE_EMPTY",
"INVALID_DATA_SOURCE_CONFIG",
"DATA_SOURCE_AUTH_FAILED",
"DATA_SOURCE_CONNECTION_FAILED",
"FAILURE_TO_PROCESS_JSON_FILE",
"INTERNAL_SERVICE_ERROR",
"REFRESH_SUPPRESSED_BY_EDIT",
"PERMISSION_NOT_FOUND",
"ELASTICSEARCH_CURSOR_NOT_ENABLED",
"CURSOR_NOT_ENABLED"
]
},
"IngestionId":{
"type":"string",
"max":128,
"min":1,
"pattern":"^[a-zA-Z0-9-_]+$"
},
"IngestionMaxResults":{
"type":"integer",
"max":100,
"min":1
},
"IngestionRequestSource":{
"type":"string",
"enum":[
"MANUAL",
"SCHEDULED"
]
},
"IngestionRequestType":{
"type":"string",
"documentation":"This defines the type of ingestion request. This is returned as part of create ingestion response.",
"enum":[
"INITIAL_INGESTION",
"EDIT",
"INCREMENTAL_REFRESH",
"FULL_REFRESH"
]
},
"IngestionStatus":{
"type":"string",
"enum":[
"INITIALIZED",
"QUEUED",
"RUNNING",
"FAILED",
"COMPLETED",
"CANCELLED"
]
},
"IngestionType":{
"type":"string",
"documentation":"This defines the type of ingestion user wants to trigger. This is part of create ingestion request.",
"enum":[
"INCREMENTAL_REFRESH",
"FULL_REFRESH"
]
},
"Ingestions":{
"type":"list",
"member":{"shape":"Ingestion"}
},
"InputColumn":{
"type":"structure",
"required":[
"Name",
"Type"
],
"members":{
"Name":{
"shape":"ColumnName",
"documentation":"<p>The name of this column in the underlying data source.</p>"
},
"Type":{
"shape":"InputColumnDataType",
"documentation":"<p>The data type of the column.</p>"
}
},
"documentation":"<p>Metadata for a column that is used as the input of a transform operation.</p>"
},
"InputColumnDataType":{
"type":"string",
"enum":[
"STRING",
"INTEGER",
"DECIMAL",
"DATETIME",
"BIT",
"BOOLEAN",
"JSON"
]
},
"InputColumnList":{
"type":"list",
"member":{"shape":"InputColumn"},
"max":2048,
"min":1
},
"InsightConfiguration":{
"type":"structure",
"members":{
"Computations":{
"shape":"ComputationList",
"documentation":"<p>The computations configurations of the insight visual</p>"
},
"CustomNarrative":{
"shape":"CustomNarrativeOptions",
"documentation":"<p>The custom narrative of the insight visual.</p>"
}
},
"documentation":"<p>The configuration of an insight visual.</p>"
},
"InsightVisual":{
"type":"structure",
"required":[
"VisualId",
"DataSetIdentifier"
],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"InsightConfiguration":{
"shape":"InsightConfiguration",
"documentation":"<p>The configuration of an insight visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The dataset that is used in the insight visual.</p>"
}
},
"documentation":"<p>An insight visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html\">Working with insights</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"InstanceId":{
"type":"string",
"max":64,
"min":1
},
"Integer":{"type":"integer"},
"IntegerDefaultValueList":{
"type":"list",
"member":{"shape":"SensitiveLongObject"},
"max":50000
},
"IntegerDefaultValues":{
"type":"structure",
"members":{
"DynamicValue":{
"shape":"DynamicDefaultValue",
"documentation":"<p>The dynamic value of the <code>IntegerDefaultValues</code>. Different defaults are displayed according to users, groups, and values mapping.</p>"
},
"StaticValues":{
"shape":"IntegerDefaultValueList",
"documentation":"<p>The static values of the <code>IntegerDefaultValues</code>.</p>"
}
},
"documentation":"<p>The default values of the <code>IntegerParameterDeclaration</code>.</p>"
},
"IntegerParameter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of the integer parameter.</p>"
},
"Values":{
"shape":"SensitiveLongList",
"documentation":"<p>The values for the integer parameter.</p>"
}
},
"documentation":"<p>An integer parameter.</p>"
},
"IntegerParameterDeclaration":{
"type":"structure",
"required":[
"ParameterValueType",
"Name"
],
"members":{
"ParameterValueType":{
"shape":"ParameterValueType",
"documentation":"<p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>"
},
"Name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter that is being declared.</p>"
},
"DefaultValues":{
"shape":"IntegerDefaultValues",
"documentation":"<p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>"
},
"ValueWhenUnset":{
"shape":"IntegerValueWhenUnsetConfiguration",
"documentation":"<p>A parameter declaration for the <code>Integer</code> data type.</p>"
}
},
"documentation":"<p>A parameter declaration for the <code>Integer</code> data type.</p>"
},
"IntegerParameterList":{
"type":"list",
"member":{"shape":"IntegerParameter"},
"max":100
},
"IntegerValueWhenUnsetConfiguration":{
"type":"structure",
"members":{
"ValueWhenUnsetOption":{
"shape":"ValueWhenUnsetOption",
"documentation":"<p>The built-in options for default values. The value can be one of the following:</p> <ul> <li> <p> <code>RECOMMENDED</code>: The recommended value.</p> </li> <li> <p> <code>NULL</code>: The <code>NULL</code> value.</p> </li> </ul>"
},
"CustomValue":{
"shape":"SensitiveLong",
"documentation":"<p>A custom value that's used when the value of a parameter isn't set.</p>",
"box":true
}
},
"documentation":"<p>A parameter declaration for the <code>Integer</code> data type.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"InternalFailureException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>An internal failure occurred.</p>",
"error":{"httpStatusCode":500},
"exception":true,
"fault":true
},
"InvalidNextTokenException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The <code>NextToken</code> value isn't valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidParameterValueException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>One or more parameters has a value that isn't valid.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"InvalidRequestException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"IpRestrictionRuleDescription":{
"type":"string",
"max":150,
"min":0
},
"IpRestrictionRuleMap":{
"type":"map",
"key":{"shape":"CIDR"},
"value":{"shape":"IpRestrictionRuleDescription"}
},
"ItemsLimitConfiguration":{
"type":"structure",
"members":{
"ItemsLimit":{
"shape":"Long",
"documentation":"<p>The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.</p>",
"box":true
},
"OtherCategories":{
"shape":"OtherCategories",
"documentation":"<p>The <code>Show other</code> of an axis in the chart. Choose one of the following options:</p> <ul> <li> <p> <code>INCLUDE</code> </p> </li> <li> <p> <code>EXCLUDE</code> </p> </li> </ul>"
}
},
"documentation":"<p>The limit configuration of the visual display for an axis.</p>"
},
"JiraParameters":{
"type":"structure",
"required":["SiteBaseUrl"],
"members":{
"SiteBaseUrl":{
"shape":"SiteBaseUrl",
"documentation":"<p>The base URL of the Jira site.</p>"
}
},
"documentation":"<p>The parameters for Jira.</p>"
},
"JoinInstruction":{
"type":"structure",
"required":[
"LeftOperand",
"RightOperand",
"Type",
"OnClause"
],
"members":{
"LeftOperand":{
"shape":"LogicalTableId",
"documentation":"<p>The operand on the left side of a join.</p>"
},
"RightOperand":{
"shape":"LogicalTableId",
"documentation":"<p>The operand on the right side of a join.</p>"
},
"LeftJoinKeyProperties":{
"shape":"JoinKeyProperties",
"documentation":"<p>Join key properties of the left operand.</p>"
},
"RightJoinKeyProperties":{
"shape":"JoinKeyProperties",
"documentation":"<p>Join key properties of the right operand.</p>"
},
"Type":{
"shape":"JoinType",
"documentation":"<p>The type of join that it is.</p>"
},
"OnClause":{
"shape":"OnClause",
"documentation":"<p>The join instructions provided in the <code>ON</code> clause of a join.</p>"
}
},
"documentation":"<p>The instructions associated with a join. </p>"
},
"JoinKeyProperties":{
"type":"structure",
"members":{
"UniqueKey":{
"shape":"Boolean",
"documentation":"<p>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.</p>",
"box":true
}
},
"documentation":"<p>Properties associated with the columns participating in a join.</p>"
},
"JoinType":{
"type":"string",
"enum":[
"INNER",
"OUTER",
"LEFT",
"RIGHT"
]
},
"KPIConditionalFormatting":{
"type":"structure",
"members":{
"ConditionalFormattingOptions":{
"shape":"KPIConditionalFormattingOptionList",
"documentation":"<p>The conditional formatting options of a KPI visual.</p>"
}
},
"documentation":"<p>The conditional formatting of a KPI visual.</p>"
},
"KPIConditionalFormattingOption":{
"type":"structure",
"members":{
"PrimaryValue":{
"shape":"KPIPrimaryValueConditionalFormatting",
"documentation":"<p>The conditional formatting for the primary value of a KPI visual.</p>"
},
"ProgressBar":{
"shape":"KPIProgressBarConditionalFormatting",
"documentation":"<p>The conditional formatting for the progress bar of a KPI visual.</p>"
}
},
"documentation":"<p>The conditional formatting options of a KPI visual.</p>"
},
"KPIConditionalFormattingOptionList":{
"type":"list",
"member":{"shape":"KPIConditionalFormattingOption"},
"max":100
},
"KPIConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"KPIFieldWells",
"documentation":"<p>The field well configuration of a KPI visual.</p>"
},
"SortConfiguration":{
"shape":"KPISortConfiguration",
"documentation":"<p>The sort configuration of a KPI visual.</p>"
},
"KPIOptions":{
"shape":"KPIOptions",
"documentation":"<p>The options that determine the presentation of a KPI visual.</p>"
}
},
"documentation":"<p>The configuration of a KPI visual.</p>"
},
"KPIFieldWells":{
"type":"structure",
"members":{
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a KPI visual.</p>"
},
"TargetValues":{
"shape":"MeasureFieldList",
"documentation":"<p>The target value field wells of a KPI visual.</p>"
},
"TrendGroups":{
"shape":"DimensionFieldList",
"documentation":"<p>The trend group field wells of a KPI visual.</p>"
}
},
"documentation":"<p>The field well configuration of a KPI visual.</p>"
},
"KPIOptions":{
"type":"structure",
"members":{
"ProgressBar":{
"shape":"ProgressBarOptions",
"documentation":"<p>The options that determine the presentation of the progress bar of a KPI visual.</p>"
},
"TrendArrows":{
"shape":"TrendArrowOptions",
"documentation":"<p>The options that determine the presentation of trend arrows in a KPI visual.</p>"
},
"SecondaryValue":{
"shape":"SecondaryValueOptions",
"documentation":"<p>The options that determine the presentation of the secondary value of a KPI visual.</p>"
},
"Comparison":{
"shape":"ComparisonConfiguration",
"documentation":"<p>The comparison configuration of a KPI visual.</p>"
},
"PrimaryValueDisplayType":{
"shape":"PrimaryValueDisplayType",
"documentation":"<p>The options that determine the primary value display type.</p>"
},
"PrimaryValueFontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The options that determine the primary value font configuration.</p>"
},
"SecondaryValueFontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The options that determine the secondary value font configuration.</p>"
}
},
"documentation":"<p>The options that determine the presentation of a KPI visual.</p>"
},
"KPIPrimaryValueConditionalFormatting":{
"type":"structure",
"members":{
"TextColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting of the primary value's text color.</p>"
},
"Icon":{
"shape":"ConditionalFormattingIcon",
"documentation":"<p>The conditional formatting of the primary value's icon.</p>"
}
},
"documentation":"<p>The conditional formatting for the primary value of a KPI visual.</p>"
},
"KPIProgressBarConditionalFormatting":{
"type":"structure",
"members":{
"ForegroundColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting of the progress bar's foreground color.</p>"
}
},
"documentation":"<p>The conditional formatting for the progress bar of a KPI visual.</p>"
},
"KPISortConfiguration":{
"type":"structure",
"members":{
"TrendGroupSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the trend group fields.</p>"
}
},
"documentation":"<p>The sort configuration of a KPI visual.</p>"
},
"KPIVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"KPIConfiguration",
"documentation":"<p>The configuration of a KPI visual.</p>"
},
"ConditionalFormatting":{
"shape":"KPIConditionalFormatting",
"documentation":"<p>The conditional formatting of a KPI visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A key performance indicator (KPI).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/kpi.html\">Using KPIs</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"LabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the label is visible.</p>"
},
"FontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration of the label.</p>"
},
"CustomLabel":{
"shape":"String",
"documentation":"<p>The text for the label.</p>"
}
},
"documentation":"<p>The share label options for the labels.</p>"
},
"Latitude":{
"type":"double",
"max":90,
"min":-90
},
"Layout":{
"type":"structure",
"required":["Configuration"],
"members":{
"Configuration":{
"shape":"LayoutConfiguration",
"documentation":"<p>The configuration that determines what the type of layout for a sheet.</p>"
}
},
"documentation":"<p>A <code>Layout</code> defines the placement of elements within a sheet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html\">Types of layout</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"LayoutConfiguration":{
"type":"structure",
"members":{
"GridLayout":{
"shape":"GridLayoutConfiguration",
"documentation":"<p>A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: <code>FIXED</code> or <code>RESPONSIVE</code>.</p>"
},
"FreeFormLayout":{
"shape":"FreeFormLayoutConfiguration",
"documentation":"<p>A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.</p>"
},
"SectionBasedLayout":{
"shape":"SectionBasedLayoutConfiguration",
"documentation":"<p>A section based layout organizes visuals into multiple sections and has customized header, footer and page break.</p>"
}
},
"documentation":"<p>The configuration that determines what the type of layout will be used on a sheet.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"LayoutElementType":{
"type":"string",
"enum":[
"VISUAL",
"FILTER_CONTROL",
"PARAMETER_CONTROL",
"TEXT_BOX"
]
},
"LayoutList":{
"type":"list",
"member":{"shape":"Layout"},
"max":1,
"min":1
},
"LegendOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the legend is visible.</p>"
},
"Title":{
"shape":"LabelOptions",
"documentation":"<p>The custom title for the legend.</p>"
},
"Position":{
"shape":"LegendPosition",
"documentation":"<p>The positions for the legend. Choose one of the following options:</p> <ul> <li> <p> <code>AUTO</code> </p> </li> <li> <p> <code>RIGHT</code> </p> </li> <li> <p> <code>BOTTOM</code> </p> </li> <li> <p> <code>LEFT</code> </p> </li> </ul>"
},
"Width":{
"shape":"PixelLength",
"documentation":"<p>The width of the legend. If this value is omitted, a default width is used when rendering.</p>"
},
"Height":{
"shape":"PixelLength",
"documentation":"<p>The height of the legend. If this value is omitted, a default height is used when rendering.</p>"
}
},
"documentation":"<p>The options for the legend setup of a visual.</p>"
},
"LegendPosition":{
"type":"string",
"enum":[
"AUTO",
"RIGHT",
"BOTTOM",
"TOP"
]
},
"Length":{
"type":"string",
"documentation":"String based length that is composed of value and unit"
},
"LimitExceededException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"ExceptionResourceType",
"documentation":"<p>Limit exceeded.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>A limit is exceeded.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"LineChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Category":{
"shape":"DimensionFieldList",
"documentation":"<p>The category field wells of a line chart. Values are grouped by category fields.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a line chart. Values are aggregated based on categories.</p>"
},
"Colors":{
"shape":"DimensionFieldList",
"documentation":"<p>The color field wells of a line chart. Values are grouped by category fields.</p>"
},
"SmallMultiples":{
"shape":"SmallMultiplesDimensionFieldList",
"documentation":"<p>The small multiples field well of a line chart.</p>"
}
},
"documentation":"<p>The field well configuration of a line chart.</p>"
},
"LineChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"LineChartFieldWells",
"documentation":"<p>The field well configuration of a line chart.</p>"
},
"SortConfiguration":{
"shape":"LineChartSortConfiguration",
"documentation":"<p>The sort configuration of a line chart.</p>"
},
"ForecastConfigurations":{
"shape":"ForecastConfigurationList",
"documentation":"<p>The forecast configuration of a line chart.</p>"
},
"Type":{
"shape":"LineChartType",
"documentation":"<p>Determines the type of the line chart.</p>"
},
"SmallMultiplesOptions":{
"shape":"SmallMultiplesOptions",
"documentation":"<p>The small multiples setup for the visual.</p>"
},
"XAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the x-axis.</p>"
},
"XAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the x-axis label.</p>"
},
"PrimaryYAxisDisplayOptions":{
"shape":"LineSeriesAxisDisplayOptions",
"documentation":"<p>The series axis configuration of a line chart.</p>"
},
"PrimaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the y-axis label.</p>"
},
"SecondaryYAxisDisplayOptions":{
"shape":"LineSeriesAxisDisplayOptions",
"documentation":"<p>The series axis configuration of a line chart.</p>"
},
"SecondaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the secondary y-axis label.</p>"
},
"DefaultSeriesSettings":{
"shape":"LineChartDefaultSeriesSettings",
"documentation":"<p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>"
},
"Series":{
"shape":"SeriesItemList",
"documentation":"<p>The series item configuration of a line chart.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend configuration of a line chart.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The data label configuration of a line chart.</p>"
},
"ReferenceLines":{
"shape":"ReferenceLineList",
"documentation":"<p>The reference lines configuration of a line chart.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip configuration of a line chart.</p>"
},
"ContributionAnalysisDefaults":{
"shape":"ContributionAnalysisDefaultList",
"documentation":"<p>The default configuration of a line chart's contribution analysis.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The visual palette configuration of a line chart.</p>"
}
},
"documentation":"<p>The configuration of a line chart.</p>"
},
"LineChartDefaultSeriesSettings":{
"type":"structure",
"members":{
"AxisBinding":{
"shape":"AxisBinding",
"documentation":"<p>The axis to which you are binding all line series to.</p>"
},
"LineStyleSettings":{
"shape":"LineChartLineStyleSettings",
"documentation":"<p>Line styles options for all line series in the visual.</p>"
},
"MarkerStyleSettings":{
"shape":"LineChartMarkerStyleSettings",
"documentation":"<p>Marker styles options for all line series in the visual.</p>"
}
},
"documentation":"<p>The options that determine the default presentation of all line series in <code>LineChartVisual</code>.</p>"
},
"LineChartFieldWells":{
"type":"structure",
"members":{
"LineChartAggregatedFieldWells":{
"shape":"LineChartAggregatedFieldWells",
"documentation":"<p>The field well configuration of a line chart.</p>"
}
},
"documentation":"<p>The field well configuration of a line chart.</p>"
},
"LineChartLineStyle":{
"type":"string",
"enum":[
"SOLID",
"DOTTED",
"DASHED"
]
},
"LineChartLineStyleSettings":{
"type":"structure",
"members":{
"LineVisibility":{
"shape":"Visibility",
"documentation":"<p>Configuration option that determines whether to show the line for the series.</p>"
},
"LineInterpolation":{
"shape":"LineInterpolation",
"documentation":"<p>Interpolation style for line series.</p> <ul> <li> <p> <code>LINEAR</code>: Show as default, linear style.</p> </li> <li> <p> <code>SMOOTH</code>: Show as a smooth curve.</p> </li> <li> <p> <code>STEPPED</code>: Show steps in line.</p> </li> </ul>"
},
"LineStyle":{
"shape":"LineChartLineStyle",
"documentation":"<p>Line style for line series.</p> <ul> <li> <p> <code>SOLID</code>: Show as a solid line.</p> </li> <li> <p> <code>DOTTED</code>: Show as a dotted line.</p> </li> <li> <p> <code>DASHED</code>: Show as a dashed line.</p> </li> </ul>"
},
"LineWidth":{
"shape":"PixelLength",
"documentation":"<p>Width that determines the line thickness.</p>"
}
},
"documentation":"<p>Line styles options for a line series in <code>LineChartVisual</code>.</p>"
},
"LineChartMarkerShape":{
"type":"string",
"enum":[
"CIRCLE",
"TRIANGLE",
"SQUARE",
"DIAMOND",
"ROUNDED_SQUARE"
]
},
"LineChartMarkerStyleSettings":{
"type":"structure",
"members":{
"MarkerVisibility":{
"shape":"Visibility",
"documentation":"<p>Configuration option that determines whether to show the markers in the series.</p>"
},
"MarkerShape":{
"shape":"LineChartMarkerShape",
"documentation":"<p>Shape option for markers in the series.</p> <ul> <li> <p> <code>CIRCLE</code>: Show marker as a circle.</p> </li> <li> <p> <code>TRIANGLE</code>: Show marker as a triangle.</p> </li> <li> <p> <code>SQUARE</code>: Show marker as a square.</p> </li> <li> <p> <code>DIAMOND</code>: Show marker as a diamond.</p> </li> <li> <p> <code>ROUNDED_SQUARE</code>: Show marker as a rounded square.</p> </li> </ul>"
},
"MarkerSize":{
"shape":"PixelLength",
"documentation":"<p>Size of marker in the series.</p>"
},
"MarkerColor":{
"shape":"HexColor",
"documentation":"<p>Color of marker in the series.</p>"
}
},
"documentation":"<p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>"
},
"LineChartSeriesSettings":{
"type":"structure",
"members":{
"LineStyleSettings":{
"shape":"LineChartLineStyleSettings",
"documentation":"<p>Line styles options for a line series in <code>LineChartVisual</code>.</p>"
},
"MarkerStyleSettings":{
"shape":"LineChartMarkerStyleSettings",
"documentation":"<p>Marker styles options for a line series in <code>LineChartVisual</code>.</p>"
}
},
"documentation":"<p>The options that determine the presentation of a line series in the visual</p>"
},
"LineChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the category fields.</p>"
},
"CategoryItemsLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of categories that are displayed in a line chart.</p>"
},
"ColorItemsLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of lines that are displayed in a line chart.</p>"
},
"SmallMultiplesSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the small multiples field.</p>"
},
"SmallMultiplesLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of small multiples panels that are displayed.</p>"
}
},
"documentation":"<p>The sort configuration of a line chart.</p>"
},
"LineChartType":{
"type":"string",
"enum":[
"LINE",
"AREA",
"STACKED_AREA"
]
},
"LineChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"LineChartConfiguration",
"documentation":"<p>The configuration of a line chart.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A line chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html\">Using line charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"LineInterpolation":{
"type":"string",
"enum":[
"LINEAR",
"SMOOTH",
"STEPPED"
]
},
"LineSeriesAxisDisplayOptions":{
"type":"structure",
"members":{
"AxisOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the line series axis.</p>"
},
"MissingDataConfigurations":{
"shape":"MissingDataConfigurationList",
"documentation":"<p>The configuration options that determine how missing data is treated during the rendering of a line chart.</p>"
}
},
"documentation":"<p>The series axis configuration of a line chart.</p>"
},
"LinkSharingConfiguration":{
"type":"structure",
"members":{
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that contains the permissions of a shareable link.</p>"
}
},
"documentation":"<p>A structure that contains the configuration of a shareable link to the dashboard.</p>"
},
"ListAnalysesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analyses.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListAnalysesResponse":{
"type":"structure",
"members":{
"AnalysisSummaryList":{
"shape":"AnalysisSummaryList",
"documentation":"<p>Metadata describing each of the analyses that are listed.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListControlDisplayOptions":{
"type":"structure",
"members":{
"SearchOptions":{
"shape":"ListControlSearchOptions",
"documentation":"<p>The configuration of the search options in a list control.</p>"
},
"SelectAllOptions":{
"shape":"ListControlSelectAllOptions",
"documentation":"<p>The configuration of the <code>Select all</code> options in a list control.</p>"
},
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"ListControlSearchOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration of the search options in a list control.</p>"
}
},
"documentation":"<p>The configuration of the search options in a list control.</p>"
},
"ListControlSelectAllOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration of the <code>Select all</code> options in a list control.</p>"
}
},
"documentation":"<p>The configuration of the <code>Select all</code> options in a list control.</p>"
},
"ListDashboardVersionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDashboardVersionsResponse":{
"type":"structure",
"members":{
"DashboardVersionSummaryList":{
"shape":"DashboardVersionSummaryList",
"documentation":"<p>A structure that contains information about each version of the dashboard.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListDashboardsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboards that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDashboardsResponse":{
"type":"structure",
"members":{
"DashboardSummaryList":{
"shape":"DashboardSummaryList",
"documentation":"<p>A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListDataSetsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDataSetsResponse":{
"type":"structure",
"members":{
"DataSetSummaries":{
"shape":"DataSetSummaryList",
"documentation":"<p>The list of dataset summaries.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListDataSourcesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDataSourcesResponse":{
"type":"structure",
"members":{
"DataSources":{
"shape":"DataSourceList",
"documentation":"<p>A list of data sources.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListFolderMembersRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListFolderMembersResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"FolderMemberList":{
"shape":"FolderMemberList",
"documentation":"<p>A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListFoldersRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListFoldersResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"FolderSummaryList":{
"shape":"FolderSummaryList",
"documentation":"<p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListGroupMembershipsRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to see a membership list of.</p>",
"location":"uri",
"locationName":"GroupName"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the group that you want a list of users from.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListGroupMembershipsResponse":{
"type":"structure",
"members":{
"GroupMemberList":{
"shape":"GroupMemberList",
"documentation":"<p>The list of the members of the group.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListGroupsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want a list of groups from.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListGroupsResponse":{
"type":"structure",
"members":{
"GroupList":{
"shape":"GroupList",
"documentation":"<p>The list of the groups.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIAMPolicyAssignmentsForUserRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"UserName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the assignments.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user.</p>",
"location":"uri",
"locationName":"UserName"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListIAMPolicyAssignmentsForUserResponse":{
"type":"structure",
"members":{
"ActiveAssignments":{
"shape":"ActiveIAMPolicyAssignmentList",
"documentation":"<p>The active assignments for this user.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIAMPolicyAssignmentsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains these IAM policy assignments.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignments.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace for the assignments.</p>",
"location":"uri",
"locationName":"Namespace"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListIAMPolicyAssignmentsResponse":{
"type":"structure",
"members":{
"IAMPolicyAssignments":{
"shape":"IAMPolicyAssignmentSummaryList",
"documentation":"<p>Information describing the IAM policy assignments.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIngestionsRequest":{
"type":"structure",
"required":[
"DataSetId",
"AwsAccountId"
],
"members":{
"DataSetId":{
"shape":"String",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"MaxResults":{
"shape":"IngestionMaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListIngestionsResponse":{
"type":"structure",
"members":{
"Ingestions":{
"shape":"Ingestions",
"documentation":"<p>A list of the ingestions.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListNamespacesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>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 <code>ListNameSpaces</code> API call if there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> 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 <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListNamespacesResponse":{
"type":"structure",
"members":{
"Namespaces":{
"shape":"Namespaces",
"documentation":"<p>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.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A unique pagination token that can be used in a subsequent request. Receiving <code>NextToken</code> in your response inticates that there is more data that can be returned. To receive the data, make another <code>ListNamespaces</code> 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 <code>ListNamespaces</code> API call with an expired token, you will receive a <code>HTTP 400 InvalidNextTokenException</code> error.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListTagsForResourceRequest":{
"type":"structure",
"required":["ResourceArn"],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want a list of tags for.</p>",
"location":"uri",
"locationName":"ResourceArn"
}
}
},
"ListTagsForResourceResponse":{
"type":"structure",
"members":{
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListTemplateAliasesRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template aliases that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-result"
}
}
},
"ListTemplateAliasesResponse":{
"type":"structure",
"members":{
"TemplateAliasList":{
"shape":"TemplateAliasList",
"documentation":"<p>A structure containing the list of the template's aliases.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
}
}
},
"ListTemplateVersionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListTemplateVersionsResponse":{
"type":"structure",
"members":{
"TemplateVersionSummaryList":{
"shape":"TemplateVersionSummaryList",
"documentation":"<p>A structure containing a list of all the versions of the specified template.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListTemplatesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the templates that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-result"
}
}
},
"ListTemplatesResponse":{
"type":"structure",
"members":{
"TemplateSummaryList":{
"shape":"TemplateSummaryList",
"documentation":"<p>A structure containing information about the templates in the list.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListThemeAliasesRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme aliases that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-result"
}
}
},
"ListThemeAliasesResponse":{
"type":"structure",
"members":{
"ThemeAliasList":{
"shape":"ThemeAliasList",
"documentation":"<p>A structure containing the list of the theme's aliases.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
}
}
},
"ListThemeVersionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListThemeVersionsResponse":{
"type":"structure",
"members":{
"ThemeVersionSummaryList":{
"shape":"ThemeVersionSummaryList",
"documentation":"<p>A structure containing a list of all the versions of the specified theme.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListThemesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the themes that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Type":{
"shape":"ThemeType",
"documentation":"<p>The type of themes that you want to list. Valid options include the following:</p> <ul> <li> <p> <code>ALL (default)</code>- Display all existing themes.</p> </li> <li> <p> <code>CUSTOM</code> - Display only the themes created by people using Amazon QuickSight.</p> </li> <li> <p> <code>QUICKSIGHT</code> - Display only the starting themes defined by Amazon QuickSight.</p> </li> </ul>",
"location":"querystring",
"locationName":"type"
}
}
},
"ListThemesResponse":{
"type":"structure",
"members":{
"ThemeSummaryList":{
"shape":"ThemeSummaryList",
"documentation":"<p>Information about the themes in the list.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"ListUserGroupsRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The Amazon QuickSight user name that you want to list group memberships for.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListUserGroupsResponse":{
"type":"structure",
"members":{
"GroupList":{
"shape":"GroupList",
"documentation":"<p>The list of groups the user is a member of.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListUsersRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListUsersResponse":{
"type":"structure",
"members":{
"UserList":{
"shape":"UserList",
"documentation":"<p>The list of users.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"LoadingAnimation":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration of <code>LoadingAnimation</code>.</p>"
}
},
"documentation":"<p>The configuration of loading animation in free-form layout. </p>"
},
"LocalNavigationConfiguration":{
"type":"structure",
"required":["TargetSheetId"],
"members":{
"TargetSheetId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The sheet that is targeted for navigation in the same analysis.</p>"
}
},
"documentation":"<p>The navigation configuration for <code>CustomActionNavigationOperation</code>.</p>"
},
"LogicalTable":{
"type":"structure",
"required":[
"Alias",
"Source"
],
"members":{
"Alias":{
"shape":"LogicalTableAlias",
"documentation":"<p>A display name for the logical table.</p>"
},
"DataTransforms":{
"shape":"TransformOperationList",
"documentation":"<p>Transform operations that act on this logical table.</p>"
},
"Source":{
"shape":"LogicalTableSource",
"documentation":"<p>Source of this logical table.</p>"
}
},
"documentation":"<p>A <i>logical table</i> is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.</p>"
},
"LogicalTableAlias":{
"type":"string",
"max":64,
"min":1
},
"LogicalTableId":{
"type":"string",
"max":64,
"min":1,
"pattern":"[0-9a-zA-Z-]*"
},
"LogicalTableMap":{
"type":"map",
"key":{"shape":"LogicalTableId"},
"value":{"shape":"LogicalTable"},
"max":64,
"min":1
},
"LogicalTableSource":{
"type":"structure",
"members":{
"JoinInstruction":{
"shape":"JoinInstruction",
"documentation":"<p>Specifies the result of a join of two logical tables.</p>"
},
"PhysicalTableId":{
"shape":"PhysicalTableId",
"documentation":"<p>Physical table ID.</p>"
},
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Number (ARN) of the parent dataset.</p>"
}
},
"documentation":"<p>Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"Long":{"type":"long"},
"LongFormatText":{
"type":"structure",
"members":{
"PlainText":{
"shape":"LongPlainText",
"documentation":"<p>Plain text format.</p>"
},
"RichText":{
"shape":"LongRichText",
"documentation":"<p>Rich text. Examples of rich text include bold, underline, and italics.</p>"
}
},
"documentation":"<p>The text format for a subtitle.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"LongPlainText":{
"type":"string",
"max":1024,
"min":1
},
"LongRichText":{
"type":"string",
"max":2048,
"min":1
},
"Longitude":{
"type":"double",
"max":1800,
"min":-1800
},
"ManifestFileLocation":{
"type":"structure",
"required":[
"Bucket",
"Key"
],
"members":{
"Bucket":{
"shape":"S3Bucket",
"documentation":"<p>Amazon S3 bucket.</p>"
},
"Key":{
"shape":"S3Key",
"documentation":"<p>Amazon S3 key that identifies an object.</p>"
}
},
"documentation":"<p>Amazon S3 manifest file location.</p>"
},
"MapZoomMode":{
"type":"string",
"enum":[
"AUTO",
"MANUAL"
]
},
"MarginStyle":{
"type":"structure",
"members":{
"Show":{
"shape":"Boolean",
"documentation":"<p>This Boolean value controls whether to display sheet margins.</p>",
"box":true
}
},
"documentation":"<p>The display options for margins around the outside edge of sheets.</p>"
},
"MariaDbParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for MariaDB.</p>"
},
"MaxResults":{
"type":"integer",
"max":100,
"min":1
},
"MaximumLabelType":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the maximum label.</p>"
}
},
"documentation":"<p>The maximum label of a data path label.</p>"
},
"MaximumMinimumComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time",
"Type"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"Type":{
"shape":"MaximumMinimumComputationType",
"documentation":"<p>The type of computation. Choose one of the following options:</p> <ul> <li> <p>MAXIMUM: A maximum computation.</p> </li> <li> <p>MINIMUM: A minimum computation.</p> </li> </ul>"
}
},
"documentation":"<p>The maximum and minimum computation configuration.</p>"
},
"MaximumMinimumComputationType":{
"type":"string",
"enum":[
"MAXIMUM",
"MINIMUM"
]
},
"MeasureField":{
"type":"structure",
"members":{
"NumericalMeasureField":{
"shape":"NumericalMeasureField",
"documentation":"<p>The measure type field with numerical type columns.</p>"
},
"CategoricalMeasureField":{
"shape":"CategoricalMeasureField",
"documentation":"<p>The measure type field with categorical type columns.</p>"
},
"DateMeasureField":{
"shape":"DateMeasureField",
"documentation":"<p>The measure type field with date type columns.</p>"
},
"CalculatedMeasureField":{
"shape":"CalculatedMeasureField",
"documentation":"<p>The calculated measure field only used in pivot tables.</p>"
}
},
"documentation":"<p>The measure (metric) type field.</p>"
},
"MeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":200
},
"MemberIdArnPair":{
"type":"structure",
"members":{
"MemberId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the member.</p>"
},
"MemberArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the member.</p>"
}
},
"documentation":"<p>An object that consists of a member Amazon Resource Name (ARN) and a member ID.</p>"
},
"MemberType":{
"type":"string",
"enum":[
"DASHBOARD",
"ANALYSIS",
"DATASET"
]
},
"MetricComparisonComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time",
"FromValue",
"TargetValue"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"FromValue":{
"shape":"MeasureField",
"documentation":"<p>The field that is used in a metric comparison from value setup.</p>"
},
"TargetValue":{
"shape":"MeasureField",
"documentation":"<p>The field that is used in a metric comparison to value setup.</p>"
}
},
"documentation":"<p>The metric comparison computation configuration.</p>"
},
"MinimumLabelType":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the minimum label.</p>"
}
},
"documentation":"<p>The minimum label of a data path label.</p>"
},
"MissingDataConfiguration":{
"type":"structure",
"members":{
"TreatmentOption":{
"shape":"MissingDataTreatmentOption",
"documentation":"<p>The treatment option that determines how missing data should be rendered. Choose from the following options:</p> <ul> <li> <p> <code>INTERPOLATE</code>: Interpolate missing values between the prior and the next known value.</p> </li> <li> <p> <code>SHOW_AS_ZERO</code>: Show missing values as the value <code>0</code>.</p> </li> <li> <p> <code>SHOW_AS_BLANK</code>: Display a blank space when rendering missing data.</p> </li> </ul>"
}
},
"documentation":"<p>The configuration options that determine how missing data is treated during the rendering of a line chart.</p>"
},
"MissingDataConfigurationList":{
"type":"list",
"member":{"shape":"MissingDataConfiguration"},
"max":100
},
"MissingDataTreatmentOption":{
"type":"string",
"enum":[
"INTERPOLATE",
"SHOW_AS_ZERO",
"SHOW_AS_BLANK"
]
},
"MySqlParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for MySQL.</p>"
},
"Namespace":{
"type":"string",
"max":64,
"pattern":"^[a-zA-Z0-9._-]*$"
},
"NamespaceError":{
"type":"structure",
"members":{
"Type":{
"shape":"NamespaceErrorType",
"documentation":"<p>The error type.</p>"
},
"Message":{
"shape":"String",
"documentation":"<p>The message for the error.</p>"
}
},
"documentation":"<p>Errors that occur during namespace creation.</p>"
},
"NamespaceErrorType":{
"type":"string",
"enum":[
"PERMISSION_DENIED",
"INTERNAL_SERVICE_ERROR"
]
},
"NamespaceInfoV2":{
"type":"structure",
"members":{
"Name":{
"shape":"Namespace",
"documentation":"<p>The name of the error.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The namespace ARN.</p>"
},
"CapacityRegion":{
"shape":"String",
"documentation":"<p>The namespace Amazon Web Services Region.</p>"
},
"CreationStatus":{
"shape":"NamespaceStatus",
"documentation":"<p>The creation status of a namespace that is not yet completely created.</p>"
},
"IdentityStore":{
"shape":"IdentityStore",
"documentation":"<p>The identity store used for the namespace.</p>"
},
"NamespaceError":{
"shape":"NamespaceError",
"documentation":"<p>An error that occurred when the namespace was created.</p>"
}
},
"documentation":"<p>The error type.</p>"
},
"NamespaceStatus":{
"type":"string",
"enum":[
"CREATED",
"CREATING",
"DELETING",
"RETRYABLE_FAILURE",
"NON_RETRYABLE_FAILURE"
]
},
"Namespaces":{
"type":"list",
"member":{"shape":"NamespaceInfoV2"}
},
"NarrativeString":{
"type":"string",
"max":150000
},
"NegativeValueConfiguration":{
"type":"structure",
"required":["DisplayMode"],
"members":{
"DisplayMode":{
"shape":"NegativeValueDisplayMode",
"documentation":"<p>Determines the display mode of the negative value configuration.</p>"
}
},
"documentation":"<p>The options that determine the negative value configuration.</p>"
},
"NegativeValueDisplayMode":{
"type":"string",
"enum":[
"POSITIVE",
"NEGATIVE"
]
},
"NonEmptyString":{
"type":"string",
"pattern":".*\\S.*"
},
"NullString":{
"type":"string",
"max":128,
"min":1,
"sensitive":true
},
"NullValueFormatConfiguration":{
"type":"structure",
"required":["NullString"],
"members":{
"NullString":{
"shape":"NullString",
"documentation":"<p>Determines the null string of null values.</p>"
}
},
"documentation":"<p>The options that determine the null value format configuration.</p>"
},
"NullableBoolean":{"type":"boolean"},
"NumberDisplayFormatConfiguration":{
"type":"structure",
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"<p>Determines the prefix value of the number format.</p>"
},
"Suffix":{
"shape":"Suffix",
"documentation":"<p>Determines the suffix value of the number format.</p>"
},
"SeparatorConfiguration":{
"shape":"NumericSeparatorConfiguration",
"documentation":"<p>The options that determine the numeric separator configuration.</p>"
},
"DecimalPlacesConfiguration":{
"shape":"DecimalPlacesConfiguration",
"documentation":"<p>The option that determines the decimal places configuration.</p>"
},
"NumberScale":{
"shape":"NumberScale",
"documentation":"<p>Determines the number scale value of the number format.</p>"
},
"NegativeValueConfiguration":{
"shape":"NegativeValueConfiguration",
"documentation":"<p>The options that determine the negative value configuration.</p>"
},
"NullValueFormatConfiguration":{
"shape":"NullValueFormatConfiguration",
"documentation":"<p>The options that determine the null value format configuration.</p>"
}
},
"documentation":"<p>The options that determine the number display format configuration.</p>"
},
"NumberFormatConfiguration":{
"type":"structure",
"members":{
"FormatConfiguration":{
"shape":"NumericFormatConfiguration",
"documentation":"<p>The options that determine the numeric format configuration.</p>"
}
},
"documentation":"<p>Formatting configuration for number fields.</p>"
},
"NumberScale":{
"type":"string",
"enum":[
"NONE",
"AUTO",
"THOUSANDS",
"MILLIONS",
"BILLIONS",
"TRILLIONS"
]
},
"NumericAxisOptions":{
"type":"structure",
"members":{
"Scale":{
"shape":"AxisScale",
"documentation":"<p>The scale setup of a numeric axis.</p>"
},
"Range":{
"shape":"AxisDisplayRange",
"documentation":"<p>The range setup of a numeric axis.</p>"
}
},
"documentation":"<p>The options for an axis with a numeric field.</p>"
},
"NumericEqualityDrillDownFilter":{
"type":"structure",
"required":[
"Column",
"Value"
],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The value of the double input numeric drill down filter.</p>"
}
},
"documentation":"<p>The category drill down filter.</p>"
},
"NumericEqualityFilter":{
"type":"structure",
"required":[
"FilterId",
"Column",
"MatchOperator",
"NullOption"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The input value.</p>",
"box":true
},
"SelectAllOptions":{
"shape":"NumericFilterSelectAllOptions",
"documentation":"<p>Select all of the values. Null is not the assigned value of select all.</p> <ul> <li> <p> <code>FILTER_ALL_VALUES</code> </p> </li> </ul>"
},
"MatchOperator":{
"shape":"NumericEqualityMatchOperator",
"documentation":"<p>The match operator that is used to determine if a filter should be applied.</p>"
},
"AggregationFunction":{
"shape":"AggregationFunction",
"documentation":"<p>The aggregation function of the filter.</p>"
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The parameter whose value should be used for the filter value.</p>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
}
},
"documentation":"<p>A <code>NumericEqualityFilter</code> filters values that are equal to the specified value.</p>"
},
"NumericEqualityMatchOperator":{
"type":"string",
"enum":[
"EQUALS",
"DOES_NOT_EQUAL"
]
},
"NumericFilterSelectAllOptions":{
"type":"string",
"enum":["FILTER_ALL_VALUES"]
},
"NumericFormatConfiguration":{
"type":"structure",
"members":{
"NumberDisplayFormatConfiguration":{
"shape":"NumberDisplayFormatConfiguration",
"documentation":"<p>The options that determine the number display format configuration.</p>"
},
"CurrencyDisplayFormatConfiguration":{
"shape":"CurrencyDisplayFormatConfiguration",
"documentation":"<p>The options that determine the currency display format configuration.</p>"
},
"PercentageDisplayFormatConfiguration":{
"shape":"PercentageDisplayFormatConfiguration",
"documentation":"<p>The options that determine the percentage display format configuration.</p>"
}
},
"documentation":"<p>The options that determine the numeric format configuration.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"NumericRangeFilter":{
"type":"structure",
"required":[
"FilterId",
"Column",
"NullOption"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"IncludeMinimum":{
"shape":"Boolean",
"documentation":"<p>Determines whether the minimum value in the filter value range should be included in the filtered results.</p>",
"box":true
},
"IncludeMaximum":{
"shape":"Boolean",
"documentation":"<p>Determines whether the maximum value in the filter value range should be included in the filtered results.</p>",
"box":true
},
"RangeMinimum":{
"shape":"NumericRangeFilterValue",
"documentation":"<p>The minimum value for the filter value range.</p>",
"box":true
},
"RangeMaximum":{
"shape":"NumericRangeFilterValue",
"documentation":"<p>The maximum value for the filter value range.</p>",
"box":true
},
"SelectAllOptions":{
"shape":"NumericFilterSelectAllOptions",
"documentation":"<p>Select all of the values. Null is not the assigned value of select all.</p> <ul> <li> <p> <code>FILTER_ALL_VALUES</code> </p> </li> </ul>"
},
"AggregationFunction":{
"shape":"AggregationFunction",
"documentation":"<p>The aggregation function of the filter.</p>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
}
},
"documentation":"<p>A <code>NumericRangeFilter</code> filters values that are within the value range.</p>"
},
"NumericRangeFilterValue":{
"type":"structure",
"members":{
"StaticValue":{
"shape":"Double",
"documentation":"<p>The static value of the numeric range filter.</p>",
"box":true
},
"Parameter":{
"shape":"ParameterName",
"documentation":"<p>The parameter that is used in the numeric range.</p>"
}
},
"documentation":"<p>The value input pf the numeric range filter.</p>"
},
"NumericSeparatorConfiguration":{
"type":"structure",
"members":{
"DecimalSeparator":{
"shape":"NumericSeparatorSymbol",
"documentation":"<p>Determines the decimal separator.</p>"
},
"ThousandsSeparator":{
"shape":"ThousandSeparatorOptions",
"documentation":"<p>The options that determine the thousands separator configuration.</p>"
}
},
"documentation":"<p>The options that determine the numeric separator configuration.</p>"
},
"NumericSeparatorSymbol":{
"type":"string",
"enum":[
"COMMA",
"DOT",
"SPACE"
]
},
"NumericalAggregationFunction":{
"type":"structure",
"members":{
"SimpleNumericalAggregation":{
"shape":"SimpleNumericalAggregationFunction",
"documentation":"<p>Built-in aggregation functions for numerical values.</p> <ul> <li> <p> <code>SUM</code>: The sum of a dimension or measure. </p> </li> <li> <p> <code>AVERAGE</code>: The average of a dimension or measure.</p> </li> <li> <p> <code>MIN</code>: The minimum value of a dimension or measure.</p> </li> <li> <p> <code>MAX</code>: The maximum value of a dimension or measure.</p> </li> <li> <p> <code>COUNT</code>: The count of a dimension or measure.</p> </li> <li> <p> <code>DISTINCT_COUNT</code>: The count of distinct values in a dimension or measure.</p> </li> <li> <p> <code>VAR</code>: The variance of a dimension or measure.</p> </li> <li> <p> <code>VARP</code>: The partitioned variance of a dimension or measure.</p> </li> <li> <p> <code>STDEV</code>: The standard deviation of a dimension or measure.</p> </li> <li> <p> <code>STDEVP</code>: The partitioned standard deviation of a dimension or measure.</p> </li> <li> <p> <code>MEDIAN</code>: The median value of a dimension or measure.</p> </li> </ul>"
},
"PercentileAggregation":{
"shape":"PercentileAggregation",
"documentation":"<p>An aggregation based on the percentile of values in a dimension or measure.</p>"
}
},
"documentation":"<p>Aggregation for numerical values.</p>"
},
"NumericalDimensionField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>NumericalDimensionField</code>.</p>"
},
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The custom hierarchy ID.</p>"
},
"FormatConfiguration":{
"shape":"NumberFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The dimension type field with numerical type columns.</p>"
},
"NumericalMeasureField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>NumericalMeasureField</code>.</p>"
},
"AggregationFunction":{
"shape":"NumericalAggregationFunction",
"documentation":"<p>The aggregation function of the measure field.</p>"
},
"FormatConfiguration":{
"shape":"NumberFormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The measure type field with numerical type columns.</p>"
},
"OnClause":{
"type":"string",
"max":512,
"min":1
},
"OptionalPort":{
"type":"integer",
"max":65535,
"min":0
},
"OracleParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>An Oracle host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for Oracle.</p>"
},
"OtherCategories":{
"type":"string",
"enum":[
"INCLUDE",
"EXCLUDE"
]
},
"OutputColumn":{
"type":"structure",
"members":{
"Name":{
"shape":"ColumnName",
"documentation":"<p>A display name for the dataset.</p>"
},
"Description":{
"shape":"ColumnDescriptiveText",
"documentation":"<p>A description for a column.</p>"
},
"Type":{
"shape":"ColumnDataType",
"documentation":"<p>Type.</p>"
}
},
"documentation":"<p>Output column.</p>"
},
"OutputColumnList":{
"type":"list",
"member":{"shape":"OutputColumn"}
},
"PageNumber":{
"type":"long",
"min":0
},
"PaginationConfiguration":{
"type":"structure",
"required":[
"PageSize",
"PageNumber"
],
"members":{
"PageSize":{
"shape":"Long",
"documentation":"<p>Indicates how many items render in one page.</p>",
"box":true
},
"PageNumber":{
"shape":"PageNumber",
"documentation":"<p>Indicates the page number.</p>"
}
},
"documentation":"<p>The pagination configuration for a table visual or boxplot.</p>"
},
"PanelBorderStyle":{
"type":"string",
"enum":[
"SOLID",
"DASHED",
"DOTTED"
]
},
"PanelConfiguration":{
"type":"structure",
"members":{
"Title":{
"shape":"PanelTitleOptions",
"documentation":"<p>Configures the title display within each small multiples panel.</p>"
},
"BorderVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not each panel displays a border.</p>"
},
"BorderThickness":{
"shape":"PixelLength",
"documentation":"<p>Sets the line thickness of panel borders.</p>"
},
"BorderStyle":{
"shape":"PanelBorderStyle",
"documentation":"<p>Sets the line style of panel borders.</p>"
},
"BorderColor":{
"shape":"HexColorWithTransparency",
"documentation":"<p>Sets the line color of panel borders.</p>"
},
"GutterVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not negative space between sibling panels is rendered.</p>"
},
"GutterSpacing":{
"shape":"PixelLength",
"documentation":"<p>Sets the total amount of negative space to display between sibling panels.</p>"
},
"BackgroundVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not a background for each small multiples panel is rendered.</p>"
},
"BackgroundColor":{
"shape":"HexColorWithTransparency",
"documentation":"<p>Sets the background color for each panel.</p>"
}
},
"documentation":"<p>A collection of options that configure how each panel displays in a small multiples chart.</p>"
},
"PanelTitleOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not panel titles are displayed.</p>"
},
"FontConfiguration":{"shape":"FontConfiguration"},
"HorizontalTextAlignment":{
"shape":"HorizontalTextAlignment",
"documentation":"<p>Sets the horizontal text alignment of the title within each panel.</p>"
}
},
"documentation":"<p>The options that determine the title styles for each small multiples panel.</p>"
},
"PaperOrientation":{
"type":"string",
"enum":[
"PORTRAIT",
"LANDSCAPE"
]
},
"PaperSize":{
"type":"string",
"enum":[
"US_LETTER",
"US_LEGAL",
"US_TABLOID_LEDGER",
"A0",
"A1",
"A2",
"A3",
"A4",
"A5",
"JIS_B4",
"JIS_B5"
]
},
"ParameterControl":{
"type":"structure",
"members":{
"DateTimePicker":{
"shape":"ParameterDateTimePickerControl",
"documentation":"<p>A control from a date parameter that specifies date and time.</p>"
},
"List":{
"shape":"ParameterListControl",
"documentation":"<p>A control to display a list with buttons or boxes that are used to select either a single value or multiple values.</p>"
},
"Dropdown":{
"shape":"ParameterDropDownControl",
"documentation":"<p>A control to display a dropdown list with buttons that are used to select a single value.</p>"
},
"TextField":{
"shape":"ParameterTextFieldControl",
"documentation":"<p>A control to display a text box that is used to enter a single entry.</p>"
},
"TextArea":{
"shape":"ParameterTextAreaControl",
"documentation":"<p>A control to display a text box that is used to enter multiple entries.</p>"
},
"Slider":{
"shape":"ParameterSliderControl",
"documentation":"<p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>"
}
},
"documentation":"<p>The control of a parameter that users can interact with in a dashboard or an analysis.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ParameterControlList":{
"type":"list",
"member":{"shape":"ParameterControl"},
"max":200
},
"ParameterDateTimePickerControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterDateTimePickerControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterDateTimePickerControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The name of the <code>ParameterDateTimePickerControl</code>.</p>"
},
"DisplayOptions":{
"shape":"DateTimePickerControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control from a date parameter that specifies date and time.</p>"
},
"ParameterDeclaration":{
"type":"structure",
"members":{
"StringParameterDeclaration":{
"shape":"StringParameterDeclaration",
"documentation":"<p>A parameter declaration for the <code>String</code> data type.</p>"
},
"DecimalParameterDeclaration":{
"shape":"DecimalParameterDeclaration",
"documentation":"<p>A parameter declaration for the <code>Decimal</code> data type.</p>"
},
"IntegerParameterDeclaration":{
"shape":"IntegerParameterDeclaration",
"documentation":"<p>A parameter declaration for the <code>Integer</code> data type.</p>"
},
"DateTimeParameterDeclaration":{
"shape":"DateTimeParameterDeclaration",
"documentation":"<p>A parameter declaration for the <code>DateTime</code> data type.</p>"
}
},
"documentation":"<p>The declaration definition of a parameter.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html\">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ParameterDeclarationList":{
"type":"list",
"member":{"shape":"ParameterDeclaration"},
"max":200
},
"ParameterDropDownControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterDropDownControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterDropDownControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The source parameter name of the <code>ParameterDropDownControl</code>.</p>"
},
"DisplayOptions":{
"shape":"DropDownControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"Type":{
"shape":"SheetControlListType",
"documentation":"<p>The type parameter name of the <code>ParameterDropDownControl</code>.</p>"
},
"SelectableValues":{
"shape":"ParameterSelectableValues",
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"CascadingControlConfiguration":{
"shape":"CascadingControlConfiguration",
"documentation":"<p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>"
}
},
"documentation":"<p>A control to display a dropdown list with buttons that are used to select a single value.</p>"
},
"ParameterListControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterListControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterListControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The source parameter name of the <code>ParameterListControl</code>.</p>"
},
"DisplayOptions":{
"shape":"ListControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"Type":{
"shape":"SheetControlListType",
"documentation":"<p>The type of <code>ParameterListControl</code>.</p>"
},
"SelectableValues":{
"shape":"ParameterSelectableValues",
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"CascadingControlConfiguration":{
"shape":"CascadingControlConfiguration",
"documentation":"<p>The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.</p>"
}
},
"documentation":"<p>A control to display a list with buttons or boxes that are used to select either a single value or multiple values.</p>"
},
"ParameterName":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^[a-zA-Z0-9]+$"
},
"ParameterSelectableValueList":{
"type":"list",
"member":{"shape":"String"},
"max":50000
},
"ParameterSelectableValues":{
"type":"structure",
"members":{
"Values":{
"shape":"ParameterSelectableValueList",
"documentation":"<p>The values that are used in <code>ParameterSelectableValues</code>.</p>"
},
"LinkToDataSetColumn":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column identifier that fetches values from the data set.</p>"
}
},
"documentation":"<p>A list of selectable values that are used in a control.</p>"
},
"ParameterSliderControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName",
"MaximumValue",
"MinimumValue",
"StepSize"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterSliderControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterSliderControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The source parameter name of the <code>ParameterSliderControl</code>.</p>"
},
"DisplayOptions":{
"shape":"SliderControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
},
"MaximumValue":{
"shape":"Double",
"documentation":"<p>The smaller value that is displayed at the left of the slider.</p>"
},
"MinimumValue":{
"shape":"Double",
"documentation":"<p>The larger value that is displayed at the right of the slider.</p>"
},
"StepSize":{
"shape":"Double",
"documentation":"<p>The number of increments that the slider bar is divided into.</p>"
}
},
"documentation":"<p>A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.</p>"
},
"ParameterTextAreaControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterTextAreaControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterTextAreaControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The source parameter name of the <code>ParameterTextAreaControl</code>.</p>"
},
"Delimiter":{
"shape":"TextAreaControlDelimiter",
"documentation":"<p>The delimiter that is used to separate the lines in text.</p>"
},
"DisplayOptions":{
"shape":"TextAreaControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control to display a text box that is used to enter multiple entries.</p>"
},
"ParameterTextFieldControl":{
"type":"structure",
"required":[
"ParameterControlId",
"Title",
"SourceParameterName"
],
"members":{
"ParameterControlId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>ParameterTextFieldControl</code>.</p>"
},
"Title":{
"shape":"SheetControlTitle",
"documentation":"<p>The title of the <code>ParameterTextFieldControl</code>.</p>"
},
"SourceParameterName":{
"shape":"ParameterName",
"documentation":"<p>The source parameter name of the <code>ParameterTextFieldControl</code>.</p>"
},
"DisplayOptions":{
"shape":"TextFieldControlDisplayOptions",
"documentation":"<p>The display options of a control.</p>"
}
},
"documentation":"<p>A control to display a text box that is used to enter a single entry.</p>"
},
"ParameterValueType":{
"type":"string",
"enum":[
"MULTI_VALUED",
"SINGLE_VALUED"
]
},
"Parameters":{
"type":"structure",
"members":{
"StringParameters":{
"shape":"StringParameterList",
"documentation":"<p>The parameters that have a data type of string.</p>"
},
"IntegerParameters":{
"shape":"IntegerParameterList",
"documentation":"<p>The parameters that have a data type of integer.</p>"
},
"DecimalParameters":{
"shape":"DecimalParameterList",
"documentation":"<p>The parameters that have a data type of decimal.</p>"
},
"DateTimeParameters":{
"shape":"DateTimeParameterList",
"documentation":"<p>The parameters that have a data type of date-time.</p>"
}
},
"documentation":"<p>A list of Amazon QuickSight parameters and the list's override values.</p>"
},
"Password":{
"type":"string",
"max":1024,
"min":1
},
"Path":{
"type":"list",
"member":{"shape":"Arn"},
"max":10,
"min":1
},
"PercentNumber":{
"type":"double",
"max":100,
"min":0
},
"PercentVisibleRange":{
"type":"structure",
"members":{
"From":{
"shape":"PercentNumber",
"documentation":"<p>The lower bound of the range.</p>",
"box":true
},
"To":{
"shape":"PercentNumber",
"documentation":"<p>The top bound of the range.</p>",
"box":true
}
},
"documentation":"<p>The percent range in the visible range.</p>"
},
"PercentageDisplayFormatConfiguration":{
"type":"structure",
"members":{
"Prefix":{
"shape":"Prefix",
"documentation":"<p>Determines the prefix value of the percentage format.</p>"
},
"Suffix":{
"shape":"Suffix",
"documentation":"<p>Determines the suffix value of the percentage format.</p>"
},
"SeparatorConfiguration":{
"shape":"NumericSeparatorConfiguration",
"documentation":"<p>The options that determine the numeric separator configuration.</p>"
},
"DecimalPlacesConfiguration":{
"shape":"DecimalPlacesConfiguration",
"documentation":"<p>The option that determines the decimal places configuration.</p>"
},
"NegativeValueConfiguration":{
"shape":"NegativeValueConfiguration",
"documentation":"<p>The options that determine the negative value configuration.</p>"
},
"NullValueFormatConfiguration":{
"shape":"NullValueFormatConfiguration",
"documentation":"<p>The options that determine the null value format configuration.</p>"
}
},
"documentation":"<p>The options that determine the percentage display format configuration.</p>"
},
"PercentileAggregation":{
"type":"structure",
"members":{
"PercentileValue":{
"shape":"PercentileValue",
"documentation":"<p>The percentile value. This value can be any numeric constant 0100. A percentile value of 50 computes the median value of the measure.</p>"
}
},
"documentation":"<p>An aggregation based on the percentile of values in a dimension or measure.</p>"
},
"PercentileValue":{
"type":"double",
"max":100,
"min":0
},
"PeriodOverPeriodComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
}
},
"documentation":"<p>The period over period computation configuration.</p>"
},
"PeriodToDateComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"PeriodTimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The time granularity setup of period to date computation. Choose from the following options:</p> <ul> <li> <p>YEAR: Year to date.</p> </li> <li> <p>MONTH: Month to date.</p> </li> </ul>"
}
},
"documentation":"<p>The period to date computation configuration.</p>"
},
"PeriodsBackward":{
"type":"integer",
"max":1000,
"min":0
},
"PeriodsForward":{
"type":"integer",
"max":1000,
"min":1
},
"PhysicalTable":{
"type":"structure",
"members":{
"RelationalTable":{
"shape":"RelationalTable",
"documentation":"<p>A physical table type for relational data sources.</p>"
},
"CustomSql":{
"shape":"CustomSql",
"documentation":"<p>A physical table type built from the results of the custom SQL query.</p>"
},
"S3Source":{
"shape":"S3Source",
"documentation":"<p>A physical table type for as S3 data source.</p>"
}
},
"documentation":"<p>A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"PhysicalTableId":{
"type":"string",
"max":64,
"min":1,
"pattern":"[0-9a-zA-Z-]*"
},
"PhysicalTableMap":{
"type":"map",
"key":{"shape":"PhysicalTableId"},
"value":{"shape":"PhysicalTable"},
"max":32,
"min":0
},
"PieChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Category":{
"shape":"DimensionFieldList",
"documentation":"<p>The category (group/color) field wells of a pie chart.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a pie chart. Values are aggregated based on categories.</p>"
},
"SmallMultiples":{
"shape":"SmallMultiplesDimensionFieldList",
"documentation":"<p>The small multiples field well of a pie chart.</p>"
}
},
"documentation":"<p>The field well configuration of a pie chart.</p>"
},
"PieChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"PieChartFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"PieChartSortConfiguration",
"documentation":"<p>The sort configuration of a pie chart.</p>"
},
"DonutOptions":{
"shape":"DonutOptions",
"documentation":"<p>The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.</p>"
},
"SmallMultiplesOptions":{
"shape":"SmallMultiplesOptions",
"documentation":"<p>The small multiples setup for the visual.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options of the group/color that is displayed in a pie chart.</p>"
},
"ValueLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options for the value that is displayed in a pie chart.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The palette (chart color) display setup of the visual.</p>"
},
"ContributionAnalysisDefaults":{
"shape":"ContributionAnalysisDefaultList",
"documentation":"<p>The contribution analysis (anomaly configuration) setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a pie chart.</p>"
},
"PieChartFieldWells":{
"type":"structure",
"members":{
"PieChartAggregatedFieldWells":{
"shape":"PieChartAggregatedFieldWells",
"documentation":"<p>The field well configuration of a pie chart.</p>"
}
},
"documentation":"<p>The field well configuration of a pie chart.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"PieChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the category fields.</p>"
},
"CategoryItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of categories that are displayed in a pie chart.</p>"
},
"SmallMultiplesSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the small multiples field.</p>"
},
"SmallMultiplesLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of small multiples panels that are displayed.</p>"
}
},
"documentation":"<p>The sort configuration of a pie chart.</p>"
},
"PieChartVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"PieChartConfiguration",
"documentation":"<p>The configuration of a pie chart.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A pie or donut chart.</p> <p>The <code>PieChartVisual</code> structure describes a visual that is a member of the pie chart family.</p> <p>The following charts can be described by using this structure:</p> <ul> <li> <p>Pie charts</p> </li> <li> <p>Donut charts</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html\">Using pie charts</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/donut-chart.html\">Using donut charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"PivotFieldSortOptions":{
"type":"structure",
"required":[
"FieldId",
"SortBy"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID for the field sort options.</p>"
},
"SortBy":{
"shape":"PivotTableSortBy",
"documentation":"<p>The sort by field for the field sort options.</p>"
}
},
"documentation":"<p>The field sort options for a pivot table sort configuration.</p>"
},
"PivotFieldSortOptionsList":{
"type":"list",
"member":{"shape":"PivotFieldSortOptions"},
"max":200
},
"PivotMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":20
},
"PivotTableAggregatedFieldWells":{
"type":"structure",
"members":{
"Rows":{
"shape":"PivotTableDimensionList",
"documentation":"<p>The rows field well for a pivot table. Values are grouped by rows fields.</p>"
},
"Columns":{
"shape":"PivotTableDimensionList",
"documentation":"<p>The columns field well for a pivot table. Values are grouped by columns fields.</p>"
},
"Values":{
"shape":"PivotMeasureFieldList",
"documentation":"<p>The values field well for a pivot table. Values are aggregated based on rows and columns fields.</p>"
}
},
"documentation":"<p>The aggregated field well for the pivot table.</p>"
},
"PivotTableCellConditionalFormatting":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the cell for conditional formatting.</p>"
},
"TextFormat":{
"shape":"TextConditionalFormat",
"documentation":"<p>The text format of the cell for conditional formatting.</p>"
},
"Scope":{
"shape":"PivotTableConditionalFormattingScope",
"documentation":"<p>The scope of the cell for conditional formatting.</p>"
}
},
"documentation":"<p>The cell conditional formatting option for a pivot table.</p>"
},
"PivotTableConditionalFormatting":{
"type":"structure",
"members":{
"ConditionalFormattingOptions":{
"shape":"PivotTableConditionalFormattingOptionList",
"documentation":"<p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>"
}
},
"documentation":"<p>The conditional formatting for a <code>PivotTableVisual</code>.</p>"
},
"PivotTableConditionalFormattingOption":{
"type":"structure",
"members":{
"Cell":{
"shape":"PivotTableCellConditionalFormatting",
"documentation":"<p>The cell conditional formatting option for a pivot table.</p>"
}
},
"documentation":"<p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>"
},
"PivotTableConditionalFormattingOptionList":{
"type":"list",
"member":{"shape":"PivotTableConditionalFormattingOption"},
"max":100
},
"PivotTableConditionalFormattingScope":{
"type":"structure",
"members":{
"Role":{
"shape":"PivotTableConditionalFormattingScopeRole",
"documentation":"<p>The role (field, field total, grand total) of the cell for conditional formatting.</p>"
}
},
"documentation":"<p>The scope of the cell for conditional formatting.</p>"
},
"PivotTableConditionalFormattingScopeRole":{
"type":"string",
"enum":[
"FIELD",
"FIELD_TOTAL",
"GRAND_TOTAL"
]
},
"PivotTableConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"PivotTableFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"PivotTableSortConfiguration",
"documentation":"<p>The sort configuration for a <code>PivotTableVisual</code>.</p>"
},
"TableOptions":{
"shape":"PivotTableOptions",
"documentation":"<p>The table options for a pivot table visual.</p>"
},
"TotalOptions":{
"shape":"PivotTableTotalOptions",
"documentation":"<p>The total options for a pivot table visual.</p>"
},
"FieldOptions":{
"shape":"PivotTableFieldOptions",
"documentation":"<p>The field options for a pivot table visual.</p>"
},
"PaginatedReportOptions":{
"shape":"PivotTablePaginatedReportOptions",
"documentation":"<p>The paginated report options for a pivot table visual.</p>"
}
},
"documentation":"<p>The configuration for a <code>PivotTableVisual</code>.</p>"
},
"PivotTableDataPathOption":{
"type":"structure",
"required":["DataPathList"],
"members":{
"DataPathList":{
"shape":"DataPathValueList",
"documentation":"<p>The list of data path values for the data path options.</p>"
},
"Width":{
"shape":"PixelLength",
"documentation":"<p>The width of the data path option.</p>"
}
},
"documentation":"<p>The data path options for the pivot table field options.</p>"
},
"PivotTableDataPathOptionList":{
"type":"list",
"member":{"shape":"PivotTableDataPathOption"},
"max":100
},
"PivotTableDimensionList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":20
},
"PivotTableFieldOption":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the pivot table field.</p>"
},
"CustomLabel":{
"shape":"CustomLabel",
"documentation":"<p>The custom label of the pivot table field.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the pivot table field.</p>"
}
},
"documentation":"<p>The selected field options for the pivot table field options.</p>"
},
"PivotTableFieldOptionList":{
"type":"list",
"member":{"shape":"PivotTableFieldOption"},
"max":100
},
"PivotTableFieldOptions":{
"type":"structure",
"members":{
"SelectedFieldOptions":{
"shape":"PivotTableFieldOptionList",
"documentation":"<p>The selected field options for the pivot table field options.</p>"
},
"DataPathOptions":{
"shape":"PivotTableDataPathOptionList",
"documentation":"<p>The data path options for the pivot table field options.</p>"
}
},
"documentation":"<p>The field options for a pivot table visual.</p>"
},
"PivotTableFieldSubtotalOptions":{
"type":"structure",
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the subtotal options.</p>"
}
},
"documentation":"<p>The optional configuration of subtotals cells.</p>"
},
"PivotTableFieldSubtotalOptionsList":{
"type":"list",
"member":{"shape":"PivotTableFieldSubtotalOptions"},
"max":100
},
"PivotTableFieldWells":{
"type":"structure",
"members":{
"PivotTableAggregatedFieldWells":{
"shape":"PivotTableAggregatedFieldWells",
"documentation":"<p>The aggregated field well for the pivot table.</p>"
}
},
"documentation":"<p>The field wells for a pivot table visual.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"PivotTableMetricPlacement":{
"type":"string",
"enum":[
"ROW",
"COLUMN"
]
},
"PivotTableOptions":{
"type":"structure",
"members":{
"MetricPlacement":{
"shape":"PivotTableMetricPlacement",
"documentation":"<p>The metric placement (row, column) options.</p>"
},
"SingleMetricVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the single metric options.</p>"
},
"ColumnNamesVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the column names.</p>"
},
"ToggleButtonsVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the pivot table.</p>"
},
"ColumnHeaderStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of the column header.</p>"
},
"RowHeaderStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of the row headers.</p>"
},
"CellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of cells.</p>"
},
"RowFieldNamesStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of row field names.</p>"
},
"RowAlternateColorOptions":{
"shape":"RowAlternateColorOptions",
"documentation":"<p>The row alternate color options (widget status, row alternate colors).</p>"
}
},
"documentation":"<p>The table options for a pivot table visual.</p>"
},
"PivotTablePaginatedReportOptions":{
"type":"structure",
"members":{
"VerticalOverflowVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the printing table overflow across pages.</p>"
},
"OverflowColumnHeaderVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the repeating header rows on each page.</p>"
}
},
"documentation":"<p>The paginated report options for a pivot table visual.</p>"
},
"PivotTableSortBy":{
"type":"structure",
"members":{
"Field":{
"shape":"FieldSort",
"documentation":"<p>The field sort (field id, direction) for the pivot table sort by options.</p>"
},
"Column":{
"shape":"ColumnSort",
"documentation":"<p>The column sort (field id, direction) for the pivot table sort by options.</p>"
},
"DataPath":{
"shape":"DataPathSort",
"documentation":"<p>The data path sort (data path value, direction) for the pivot table sort by options.</p>"
}
},
"documentation":"<p>The sort by field for the field sort options.</p>"
},
"PivotTableSortConfiguration":{
"type":"structure",
"members":{
"FieldSortOptions":{
"shape":"PivotFieldSortOptionsList",
"documentation":"<p>The field sort options for a pivot table sort configuration.</p>"
}
},
"documentation":"<p>The sort configuration for a <code>PivotTableVisual</code>.</p>"
},
"PivotTableSubtotalLevel":{
"type":"string",
"enum":[
"ALL",
"CUSTOM",
"LAST"
]
},
"PivotTableTotalOptions":{
"type":"structure",
"members":{
"RowSubtotalOptions":{
"shape":"SubtotalOptions",
"documentation":"<p>The row subtotal options.</p>"
},
"ColumnSubtotalOptions":{
"shape":"SubtotalOptions",
"documentation":"<p>The column subtotal options.</p>"
},
"RowTotalOptions":{
"shape":"PivotTotalOptions",
"documentation":"<p>The row total options.</p>"
},
"ColumnTotalOptions":{
"shape":"PivotTotalOptions",
"documentation":"<p>The column total options.</p>"
}
},
"documentation":"<p>The total options for a pivot table visual.</p>"
},
"PivotTableVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"PivotTableConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"ConditionalFormatting":{
"shape":"PivotTableConditionalFormatting",
"documentation":"<p>The conditional formatting for a <code>PivotTableVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A pivot table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html\">Using pivot tables</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"PivotTotalOptions":{
"type":"structure",
"members":{
"TotalsVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration for the total cells.</p>"
},
"Placement":{
"shape":"TableTotalsPlacement",
"documentation":"<p>The placement (start, end) for the total cells.</p>"
},
"ScrollStatus":{
"shape":"TableTotalsScrollStatus",
"documentation":"<p>The scroll status (pinned, scrolled) for the total cells.</p>"
},
"CustomLabel":{
"shape":"String",
"documentation":"<p>The custom label string for the total cells.</p>"
},
"TotalCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the total cells.</p>"
},
"ValueCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the totals of value cells.</p>"
},
"MetricHeaderCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the total of header cells.</p>"
}
},
"documentation":"<p>The optional configuration of totals cells in a <code>PivotTableVisual</code>.</p>"
},
"PixelLength":{
"type":"string",
"documentation":"String based length that is composed of value and unit in px"
},
"Port":{
"type":"integer",
"max":65535,
"min":1
},
"PositiveInteger":{
"type":"integer",
"min":1
},
"PostgreSqlParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for PostgreSQL.</p>"
},
"PreconditionNotMetException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>One or more preconditions aren't met.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"PredefinedHierarchy":{
"type":"structure",
"required":[
"HierarchyId",
"Columns"
],
"members":{
"HierarchyId":{
"shape":"HierarchyId",
"documentation":"<p>The hierarchy ID of the predefined hierarchy.</p>"
},
"Columns":{
"shape":"PredefinedHierarchyColumnList",
"documentation":"<p>The list of columns that define the predefined hierarchy.</p>"
},
"DrillDownFilters":{
"shape":"DrillDownFilterList",
"documentation":"<p>The option that determines the drill down filters for the predefined hierarchy.</p>"
}
},
"documentation":"<p>The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.</p>"
},
"PredefinedHierarchyColumnList":{
"type":"list",
"member":{"shape":"ColumnIdentifier"},
"max":10,
"min":1
},
"PredictionInterval":{
"type":"integer",
"max":95,
"min":50
},
"Prefix":{
"type":"string",
"max":128,
"min":1,
"sensitive":true
},
"PrestoParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Catalog"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Catalog":{
"shape":"Catalog",
"documentation":"<p>Catalog.</p>"
}
},
"documentation":"<p>The parameters for Presto.</p>"
},
"PrimaryValueDisplayType":{
"type":"string",
"enum":[
"HIDDEN",
"COMPARISON",
"ACTUAL"
]
},
"Principal":{
"type":"string",
"max":256,
"min":1
},
"PrincipalList":{
"type":"list",
"member":{"shape":"String"},
"max":100,
"min":1
},
"ProgressBarOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the progress bar.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the progress bar of a KPI visual.</p>"
},
"ProjectOperation":{
"type":"structure",
"required":["ProjectedColumns"],
"members":{
"ProjectedColumns":{
"shape":"ProjectedColumnList",
"documentation":"<p>Projected columns.</p>"
}
},
"documentation":"<p>A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.</p>"
},
"ProjectedColumnList":{
"type":"list",
"member":{"shape":"String"},
"max":2000,
"min":1
},
"Query":{
"type":"string",
"max":256,
"min":1
},
"QueueInfo":{
"type":"structure",
"required":[
"WaitingOnIngestion",
"QueuedIngestion"
],
"members":{
"WaitingOnIngestion":{
"shape":"String",
"documentation":"<p>The ID of the queued ingestion.</p>"
},
"QueuedIngestion":{
"shape":"String",
"documentation":"<p>The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.</p>"
}
},
"documentation":"<p>Information about a queued dataset SPICE ingestion.</p>"
},
"QuickSightUserNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"RangeEndsLabelType":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the range ends label.</p>"
}
},
"documentation":"<p>The range ends label type of a data path label.</p>"
},
"RdsParameters":{
"type":"structure",
"required":[
"InstanceId",
"Database"
],
"members":{
"InstanceId":{
"shape":"InstanceId",
"documentation":"<p>Instance ID.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for Amazon RDS.</p>"
},
"RecoveryWindowInDays":{
"type":"long",
"max":30,
"min":7
},
"RedshiftParameters":{
"type":"structure",
"required":["Database"],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host. This field can be blank if <code>ClusterId</code> is provided.</p>"
},
"Port":{
"shape":"OptionalPort",
"documentation":"<p>Port. This field can be blank if the <code>ClusterId</code> is provided.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
},
"ClusterId":{
"shape":"ClusterId",
"documentation":"<p>Cluster ID. This field can be blank if the <code>Host</code> and <code>Port</code> are provided.</p>"
}
},
"documentation":"<p>The parameters for Amazon Redshift. The <code>ClusterId</code> field can be blank if <code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>"
},
"ReferenceLine":{
"type":"structure",
"required":["DataConfiguration"],
"members":{
"Status":{
"shape":"WidgetStatus",
"documentation":"<p>The status of the reference line. Choose one of the following options:</p> <ul> <li> <p> <code>ENABLE</code> </p> </li> <li> <p> <code>DISABLE</code> </p> </li> </ul>"
},
"DataConfiguration":{
"shape":"ReferenceLineDataConfiguration",
"documentation":"<p>The data configuration of the reference line.</p>"
},
"StyleConfiguration":{
"shape":"ReferenceLineStyleConfiguration",
"documentation":"<p>The style configuration of the reference line.</p>"
},
"LabelConfiguration":{
"shape":"ReferenceLineLabelConfiguration",
"documentation":"<p>The label configuration of the reference line.</p>"
}
},
"documentation":"<p>The reference line visual display options.</p>"
},
"ReferenceLineCustomLabelConfiguration":{
"type":"structure",
"required":["CustomLabel"],
"members":{
"CustomLabel":{
"shape":"NonEmptyString",
"documentation":"<p>The string text of the custom label.</p>"
}
},
"documentation":"<p>The configuration for a custom label on a <code>ReferenceLine</code>.</p>"
},
"ReferenceLineDataConfiguration":{
"type":"structure",
"members":{
"StaticConfiguration":{
"shape":"ReferenceLineStaticDataConfiguration",
"documentation":"<p>The static data configuration of the reference line data configuration.</p>"
},
"DynamicConfiguration":{
"shape":"ReferenceLineDynamicDataConfiguration",
"documentation":"<p>The dynamic configuration of the reference line data configuration.</p>"
},
"AxisBinding":{
"shape":"AxisBinding",
"documentation":"<p>The axis binding type of the reference line. Choose one of the following options:</p> <ul> <li> <p>PrimaryY</p> </li> <li> <p>SecondaryY</p> </li> </ul>"
}
},
"documentation":"<p>The data configuration of the reference line.</p>"
},
"ReferenceLineDynamicDataConfiguration":{
"type":"structure",
"required":[
"Column",
"MeasureAggregationFunction",
"Calculation"
],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the dynamic data targets.</p>"
},
"MeasureAggregationFunction":{
"shape":"AggregationFunction",
"documentation":"<p>The aggregation function that is used in the dynamic data.</p>"
},
"Calculation":{
"shape":"NumericalAggregationFunction",
"documentation":"<p>The calculation that is used in the dynamic data.</p>"
}
},
"documentation":"<p>The dynamic configuration of the reference line data configuration.</p>"
},
"ReferenceLineLabelConfiguration":{
"type":"structure",
"members":{
"ValueLabelConfiguration":{
"shape":"ReferenceLineValueLabelConfiguration",
"documentation":"<p>The value label configuration of the label in a reference line.</p>"
},
"CustomLabelConfiguration":{
"shape":"ReferenceLineCustomLabelConfiguration",
"documentation":"<p>The custom label configuration of the label in a reference line.</p>"
},
"FontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration of the label in a reference line.</p>"
},
"FontColor":{
"shape":"HexColor",
"documentation":"<p>The font color configuration of the label in a reference line.</p>"
},
"HorizontalPosition":{
"shape":"ReferenceLineLabelHorizontalPosition",
"documentation":"<p>The horizontal position configuration of the label in a reference line. Choose one of the following options:</p> <ul> <li> <p> <code>LEFT</code> </p> </li> <li> <p> <code>CENTER</code> </p> </li> <li> <p> <code>RIGHT</code> </p> </li> </ul>"
},
"VerticalPosition":{
"shape":"ReferenceLineLabelVerticalPosition",
"documentation":"<p>The vertical position configuration of the label in a reference line. Choose one of the following options:</p> <ul> <li> <p> <code>ABOVE</code> </p> </li> <li> <p> <code>BELOW</code> </p> </li> </ul>"
}
},
"documentation":"<p>The label configuration of a reference line.</p>"
},
"ReferenceLineLabelHorizontalPosition":{
"type":"string",
"enum":[
"LEFT",
"CENTER",
"RIGHT"
]
},
"ReferenceLineLabelVerticalPosition":{
"type":"string",
"enum":[
"ABOVE",
"BELOW"
]
},
"ReferenceLineList":{
"type":"list",
"member":{"shape":"ReferenceLine"},
"max":20
},
"ReferenceLinePatternType":{
"type":"string",
"enum":[
"SOLID",
"DASHED",
"DOTTED"
]
},
"ReferenceLineStaticDataConfiguration":{
"type":"structure",
"required":["Value"],
"members":{
"Value":{
"shape":"SensitiveDouble",
"documentation":"<p>The double input of the static data.</p>"
}
},
"documentation":"<p>The static data configuration of the reference line data configuration.</p>"
},
"ReferenceLineStyleConfiguration":{
"type":"structure",
"members":{
"Pattern":{
"shape":"ReferenceLinePatternType",
"documentation":"<p>The pattern type of the line style. Choose one of the following options:</p> <ul> <li> <p> <code>SOLID</code> </p> </li> <li> <p> <code>DASHED</code> </p> </li> <li> <p> <code>DOTTED</code> </p> </li> </ul>"
},
"Color":{
"shape":"HexColor",
"documentation":"<p>The hex color of the reference line.</p>"
}
},
"documentation":"<p>The style configuration of the reference line.</p>"
},
"ReferenceLineValueLabelConfiguration":{
"type":"structure",
"members":{
"RelativePosition":{
"shape":"ReferenceLineValueLabelRelativePosition",
"documentation":"<p>The relative position of the value label. Choose one of the following options:</p> <ul> <li> <p> <code>BEFORE_CUSTOM_LABEL</code> </p> </li> <li> <p> <code>AFTER_CUSTOM_LABEL</code> </p> </li> </ul>"
},
"FormatConfiguration":{
"shape":"NumericFormatConfiguration",
"documentation":"<p>The format configuration of the value label.</p>"
}
},
"documentation":"<p>The value label configuration of the label in a reference line.</p>"
},
"ReferenceLineValueLabelRelativePosition":{
"type":"string",
"enum":[
"BEFORE_CUSTOM_LABEL",
"AFTER_CUSTOM_LABEL"
]
},
"RegisterUserRequest":{
"type":"structure",
"required":[
"IdentityType",
"Email",
"UserRole",
"AwsAccountId",
"Namespace"
],
"members":{
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:</p> <ul> <li> <p> <code>IAM</code>: A user whose identity maps to an existing IAM user or role. </p> </li> <li> <p> <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by Amazon QuickSight. </p> </li> </ul>"
},
"Email":{
"shape":"String",
"documentation":"<p>The email address of the user that you want to register.</p>"
},
"UserRole":{
"shape":"UserRole",
"documentation":"<p>The Amazon QuickSight role for the user. The user role can be one of the following:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> <li> <p> <code>RESTRICTED_READER</code>: This role isn't currently available for use.</p> </li> <li> <p> <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p> </li> </ul>"
},
"IamArn":{
"shape":"String",
"documentation":"<p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>"
},
"SessionName":{
"shape":"RoleSessionName",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html\"> <code>assume-role</code> </a> in the <i>CLI Reference.</i> </p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The Amazon QuickSight user name that you want to create for the user you are registering.</p>"
},
"CustomPermissionsName":{
"shape":"RoleName",
"documentation":"<p>(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:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>To add custom permissions to an existing user, use <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html\">UpdateUser</a> </code> instead.</p> <p>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 <code>RegisterUser</code> API operation to assign the named set of permissions to a Amazon QuickSight user. </p> <p>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).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
},
"ExternalLoginFederationProviderType":{
"shape":"String",
"documentation":"<p>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.</p> <ul> <li> <p> <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, dont use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.</p> </li> <li> <p> <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p> </li> </ul>"
},
"CustomFederationProviderUrl":{
"shape":"String",
"documentation":"<p>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 <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>"
},
"ExternalLoginId":{
"shape":"String",
"documentation":"<p>The identity ID for a user in the external login provider.</p>"
}
}
},
"RegisterUserResponse":{
"type":"structure",
"members":{
"User":{
"shape":"User",
"documentation":"<p>The user's user name.</p>"
},
"UserInvitationUrl":{
"shape":"String",
"documentation":"<p>The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"RegisteredUserDashboardEmbeddingConfiguration":{
"type":"structure",
"required":["InitialDashboardId"],
"members":{
"InitialDashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>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.</p> <p>If the user does not have permission to view this dashboard, they see a permissions error message.</p>"
}
},
"documentation":"<p>Information about the dashboard you want to embed.</p>"
},
"RegisteredUserDashboardVisualEmbeddingConfiguration":{
"type":"structure",
"required":["InitialDashboardVisualId"],
"members":{
"InitialDashboardVisualId":{
"shape":"DashboardVisualId",
"documentation":"<p>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.</p> <p>The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the <code>AuthorizedResourceArns</code> parameter. Otherwise, the request will fail with <code>InvalidParameterValueException</code>.</p>"
}
},
"documentation":"<p>The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.</p>"
},
"RegisteredUserEmbeddingExperienceConfiguration":{
"type":"structure",
"members":{
"Dashboard":{
"shape":"RegisteredUserDashboardEmbeddingConfiguration",
"documentation":"<p>The configuration details for providing a dashboard embedding experience.</p>"
},
"QuickSightConsole":{
"shape":"RegisteredUserQuickSightConsoleEmbeddingConfiguration",
"documentation":"<p>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 <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>Use <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GenerateEmbedUrlForRegisteredUser.html\">GenerateEmbedUrlForRegisteredUser</a> </code> 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 <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html\">UpdateUser</a> </code> API operation. Use the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_RegisterUser.html\">RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics-full-console-for-authenticated-users.html\">Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> </p> </li> </ul> <p>For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/quicksight-dev-portal.html\">Amazon QuickSight Developer Portal</a>.</p>"
},
"QSearchBar":{
"shape":"RegisteredUserQSearchBarEmbeddingConfiguration",
"documentation":"<p>The configuration details for embedding the Q search bar.</p> <p>For more information about embedding the Q search bar, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-overview.html\">Embedding Overview</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"DashboardVisual":{
"shape":"RegisteredUserDashboardVisualEmbeddingConfiguration",
"documentation":"<p>The type of embedding experience. In this case, Amazon QuickSight visuals.</p>"
}
},
"documentation":"<p>The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.</p> <note> <p>Exactly one of the experience configurations is required. You can choose <code>Dashboard</code> or <code>QuickSightConsole</code>. You cannot choose more than one experience configuration.</p> </note>"
},
"RegisteredUserQSearchBarEmbeddingConfiguration":{
"type":"structure",
"members":{
"InitialTopicId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>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.</p> <p>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.</p>"
}
},
"documentation":"<p>Information about the Q search bar embedding experience.</p>"
},
"RegisteredUserQuickSightConsoleEmbeddingConfiguration":{
"type":"structure",
"members":{
"InitialPath":{
"shape":"EntryPath",
"documentation":"<p>The initial URL path for the Amazon QuickSight console. <code>InitialPath</code> is required.</p> <p>The entry point URL is constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p> </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p> <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code> </p> </li> <li> <p> <code>/dashboards/DashboardId</code>. <i>DashboardId</i> is the actual ID key from the Amazon QuickSight console URL of the dashboard.</p> </li> <li> <p> <code>/analyses/AnalysisId</code>. <i>AnalysisId</i> is the actual ID key from the Amazon QuickSight console URL of the analysis.</p> </li> </ul>"
}
},
"documentation":"<p>Information about the Amazon QuickSight console that you want to embed.</p>"
},
"RelationalTable":{
"type":"structure",
"required":[
"DataSourceArn",
"Name",
"InputColumns"
],
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data source.</p>"
},
"Catalog":{
"shape":"RelationalTableCatalog",
"documentation":"<p>The catalog associated with a table.</p>"
},
"Schema":{
"shape":"RelationalTableSchema",
"documentation":"<p>The schema name. This name applies to certain relational database engines.</p>"
},
"Name":{
"shape":"RelationalTableName",
"documentation":"<p>The name of the relational table.</p>"
},
"InputColumns":{
"shape":"InputColumnList",
"documentation":"<p>The column schema of the table.</p>"
}
},
"documentation":"<p>A physical table type for relational data sources.</p>"
},
"RelationalTableCatalog":{
"type":"string",
"max":256
},
"RelationalTableName":{
"type":"string",
"max":64,
"min":1
},
"RelationalTableSchema":{
"type":"string",
"max":64
},
"RelativeDateTimeControlDisplayOptions":{
"type":"structure",
"members":{
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
},
"DateTimeFormat":{
"shape":"DateTimeFormat",
"documentation":"<p>Customize how dates are formatted in controls.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"RelativeDateType":{
"type":"string",
"enum":[
"PREVIOUS",
"THIS",
"LAST",
"NOW",
"NEXT"
]
},
"RelativeDatesFilter":{
"type":"structure",
"required":[
"FilterId",
"Column",
"AnchorDateConfiguration",
"TimeGranularity",
"RelativeDateType",
"NullOption"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"AnchorDateConfiguration":{
"shape":"AnchorDateConfiguration",
"documentation":"<p>The date configuration of the filter.</p>"
},
"MinimumGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The minimum granularity (period granularity) of the relative dates filter.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
},
"RelativeDateType":{
"shape":"RelativeDateType",
"documentation":"<p>The range date type of the filter. Choose one of the options below:</p> <ul> <li> <p> <code>PREVIOUS</code> </p> </li> <li> <p> <code>THIS</code> </p> </li> <li> <p> <code>LAST</code> </p> </li> <li> <p> <code>NOW</code> </p> </li> <li> <p> <code>NEXT</code> </p> </li> </ul>"
},
"RelativeDateValue":{
"shape":"Integer",
"documentation":"<p>The date value of the filter.</p>",
"box":true
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The parameter whose value should be used for the filter value.</p>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
},
"ExcludePeriodConfiguration":{
"shape":"ExcludePeriodConfiguration",
"documentation":"<p>The configuration for the exclude period of the filter.</p>"
}
},
"documentation":"<p>A <code>RelativeDatesFilter</code> filters relative dates values.</p>"
},
"RelativeFontSize":{
"type":"string",
"enum":[
"EXTRA_SMALL",
"SMALL",
"MEDIUM",
"LARGE",
"EXTRA_LARGE"
]
},
"RenameColumnOperation":{
"type":"structure",
"required":[
"ColumnName",
"NewColumnName"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>The name of the column to be renamed.</p>"
},
"NewColumnName":{
"shape":"ColumnName",
"documentation":"<p>The new name for the column.</p>"
}
},
"documentation":"<p>A transform operation that renames a column.</p>"
},
"ResizeOption":{
"type":"string",
"enum":[
"FIXED",
"RESPONSIVE"
]
},
"ResourceExistsException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"ExceptionResourceType",
"documentation":"<p>The resource type for this request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The resource specified already exists. </p>",
"error":{"httpStatusCode":409},
"exception":true
},
"ResourceId":{"type":"string"},
"ResourceName":{
"type":"string",
"max":128,
"min":1
},
"ResourceNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"ExceptionResourceType",
"documentation":"<p>The resource type for this request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>One or more resources can't be found.</p>",
"error":{"httpStatusCode":404},
"exception":true
},
"ResourcePermission":{
"type":"structure",
"required":[
"Principal",
"Actions"
],
"members":{
"Principal":{
"shape":"Principal",
"documentation":"<p>The Amazon Resource Name (ARN) of the principal. This can be one of the following:</p> <ul> <li> <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p> </li> <li> <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p> </li> <li> <p>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.) </p> </li> </ul>"
},
"Actions":{
"shape":"ActionList",
"documentation":"<p>The IAM action to grant or revoke permissions on.</p>"
}
},
"documentation":"<p>Permission for the resource.</p>"
},
"ResourcePermissionList":{
"type":"list",
"member":{"shape":"ResourcePermission"},
"max":64,
"min":1
},
"ResourceStatus":{
"type":"string",
"enum":[
"CREATION_IN_PROGRESS",
"CREATION_SUCCESSFUL",
"CREATION_FAILED",
"UPDATE_IN_PROGRESS",
"UPDATE_SUCCESSFUL",
"UPDATE_FAILED",
"DELETED"
]
},
"ResourceUnavailableException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"ResourceType":{
"shape":"ExceptionResourceType",
"documentation":"<p>The resource type for this request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>This resource is currently unavailable.</p>",
"error":{"httpStatusCode":503},
"exception":true
},
"RestoreAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analysis.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're restoring.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"RestoreAnalysisResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis that you're restoring.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're restoring. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"RestrictiveResourceId":{
"type":"string",
"max":2048,
"min":1,
"pattern":"[\\w\\-]+"
},
"RoleArn":{
"type":"string",
"max":2048,
"min":20
},
"RoleName":{
"type":"string",
"max":64,
"min":1,
"pattern":"^[a-zA-Z0-9+=,.@_-]+$"
},
"RoleSessionName":{
"type":"string",
"max":64,
"min":2,
"pattern":"[\\w+=.@-]*"
},
"RollingDateConfiguration":{
"type":"structure",
"required":["Expression"],
"members":{
"DataSetIdentifier":{
"shape":"DataSetIdentifier",
"documentation":"<p>The data set that is used in the rolling date configuration.</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression of the rolling date configuration.</p>"
}
},
"documentation":"<p>The rolling date configuration of a date time filter.</p>"
},
"RowAlternateColorList":{
"type":"list",
"member":{"shape":"HexColor"},
"max":1
},
"RowAlternateColorOptions":{
"type":"structure",
"members":{
"Status":{
"shape":"WidgetStatus",
"documentation":"<p>Determines the widget status.</p>"
},
"RowAlternateColors":{
"shape":"RowAlternateColorList",
"documentation":"<p>Determines the list of row alternate colors.</p>"
}
},
"documentation":"<p>Determines the row alternate color options.</p>"
},
"RowInfo":{
"type":"structure",
"members":{
"RowsIngested":{
"shape":"Long",
"documentation":"<p>The number of rows that were ingested.</p>",
"box":true
},
"RowsDropped":{
"shape":"Long",
"documentation":"<p>The number of rows that were not ingested.</p>",
"box":true
},
"TotalRowsInDataset":{
"shape":"Long",
"documentation":"<p>The total number of rows in the dataset.</p>",
"box":true
}
},
"documentation":"<p>Information about rows for a data set SPICE ingestion.</p>"
},
"RowLevelPermissionDataSet":{
"type":"structure",
"required":[
"Arn",
"PermissionPolicy"
],
"members":{
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the dataset that contains permissions for RLS.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.</p>"
},
"PermissionPolicy":{
"shape":"RowLevelPermissionPolicy",
"documentation":"<p>The type of permissions to use when interpreting the permissions for RLS. <code>DENY_ACCESS</code> is included for backward compatibility only.</p>"
},
"FormatVersion":{
"shape":"RowLevelPermissionFormatVersion",
"documentation":"<p>The user or group rules associated with the dataset that contains permissions for RLS.</p> <p>By default, <code>FormatVersion</code> is <code>VERSION_1</code>. When <code>FormatVersion</code> is <code>VERSION_1</code>, <code>UserName</code> and <code>GroupName</code> are required. When <code>FormatVersion</code> is <code>VERSION_2</code>, <code>UserARN</code> and <code>GroupARN</code> are required, and <code>Namespace</code> must not exist.</p>"
},
"Status":{
"shape":"Status",
"documentation":"<p>The status of the row-level security permission dataset. If enabled, the status is <code>ENABLED</code>. If disabled, the status is <code>DISABLED</code>.</p>"
}
},
"documentation":"<p>Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html\">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported for new RLS datasets.</p>"
},
"RowLevelPermissionFormatVersion":{
"type":"string",
"enum":[
"VERSION_1",
"VERSION_2"
]
},
"RowLevelPermissionPolicy":{
"type":"string",
"enum":[
"GRANT_ACCESS",
"DENY_ACCESS"
]
},
"RowLevelPermissionTagConfiguration":{
"type":"structure",
"required":["TagRules"],
"members":{
"Status":{
"shape":"Status",
"documentation":"<p>The status of row-level security tags. If enabled, the status is <code>ENABLED</code>. If disabled, the status is <code>DISABLED</code>.</p>"
},
"TagRules":{
"shape":"RowLevelPermissionTagRuleList",
"documentation":"<p>A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.</p>"
}
},
"documentation":"<p>The configuration of tags on a dataset to set row-level security. </p>"
},
"RowLevelPermissionTagDelimiter":{
"type":"string",
"max":10
},
"RowLevelPermissionTagRule":{
"type":"structure",
"required":[
"TagKey",
"ColumnName"
],
"members":{
"TagKey":{
"shape":"SessionTagKey",
"documentation":"<p>The unique key for a tag.</p>"
},
"ColumnName":{
"shape":"String",
"documentation":"<p>The column name that a tag key is assigned to.</p>"
},
"TagMultiValueDelimiter":{
"shape":"RowLevelPermissionTagDelimiter",
"documentation":"<p>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.</p>"
},
"MatchAllValue":{
"shape":"SessionTagValue",
"documentation":"<p>A string that you want to use to filter by all the values in a column in the dataset and dont want to list the values one by one. For example, you can use an asterisk as your match all value.</p>"
}
},
"documentation":"<p>A set of rules associated with a tag.</p>"
},
"RowLevelPermissionTagRuleList":{
"type":"list",
"member":{"shape":"RowLevelPermissionTagRule"},
"max":50,
"min":1
},
"RowSortList":{
"type":"list",
"member":{"shape":"FieldSortOptions"},
"max":100
},
"S3Bucket":{
"type":"string",
"max":1024,
"min":1
},
"S3Key":{
"type":"string",
"max":1024,
"min":1
},
"S3Parameters":{
"type":"structure",
"required":["ManifestFileLocation"],
"members":{
"ManifestFileLocation":{
"shape":"ManifestFileLocation",
"documentation":"<p>Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.</p>"
}
},
"documentation":"<p>The parameters for S3.</p>"
},
"S3Source":{
"type":"structure",
"required":[
"DataSourceArn",
"InputColumns"
],
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data source.</p>"
},
"UploadSettings":{
"shape":"UploadSettings",
"documentation":"<p>Information about the format for the S3 source file or files.</p>"
},
"InputColumns":{
"shape":"InputColumnList",
"documentation":"<p>A physical table type for an S3 data source.</p> <note> <p>For files that aren't JSON, only <code>STRING</code> data types are supported in input columns.</p> </note>"
}
},
"documentation":"<p>A physical table type for an S3 data source.</p>"
},
"SameSheetTargetVisualConfiguration":{
"type":"structure",
"members":{
"TargetVisuals":{
"shape":"TargetVisualList",
"documentation":"<p>A list of the target visual IDs that are located in the same sheet of the analysis.</p>"
},
"TargetVisualOptions":{
"shape":"TargetVisualOptions",
"documentation":"<p>The options that choose the target visual in the same sheet.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>ALL_VISUALS</code>: Applies the filter operation to all visuals in the same sheet.</p> </li> </ul>"
}
},
"documentation":"<p>The configuration of the same-sheet target visuals that you want to be filtered.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"SankeyDiagramAggregatedFieldWells":{
"type":"structure",
"members":{
"Source":{
"shape":"DimensionFieldList",
"documentation":"<p>The source field wells of a sankey diagram.</p>"
},
"Destination":{
"shape":"DimensionFieldList",
"documentation":"<p>The destination field wells of a sankey diagram.</p>"
},
"Weight":{
"shape":"MeasureFieldList",
"documentation":"<p>The weight field wells of a sankey diagram.</p>"
}
},
"documentation":"<p>The field well configuration of a sankey diagram.</p>"
},
"SankeyDiagramChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"SankeyDiagramFieldWells",
"documentation":"<p>The field well configuration of a sankey diagram.</p>"
},
"SortConfiguration":{
"shape":"SankeyDiagramSortConfiguration",
"documentation":"<p>The sort configuration of a sankey diagram.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The data label configuration of a sankey diagram.</p>"
}
},
"documentation":"<p>The configuration of a sankey diagram.</p>"
},
"SankeyDiagramFieldWells":{
"type":"structure",
"members":{
"SankeyDiagramAggregatedFieldWells":{
"shape":"SankeyDiagramAggregatedFieldWells",
"documentation":"<p>The field well configuration of a sankey diagram.</p>"
}
},
"documentation":"<p>The field well configuration of a sankey diagram.</p>"
},
"SankeyDiagramSortConfiguration":{
"type":"structure",
"members":{
"WeightSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the weight fields.</p>"
},
"SourceItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of source nodes that are displayed in a sankey diagram.</p>"
},
"DestinationItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of destination nodes that are displayed in a sankey diagram.</p>"
}
},
"documentation":"<p>The sort configuration of a sankey diagram.</p>"
},
"SankeyDiagramVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"SankeyDiagramChartConfiguration",
"documentation":"<p>The configuration of a sankey diagram.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A sankey diagram.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html\">Using Sankey diagrams</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ScatterPlotCategoricallyAggregatedFieldWells":{
"type":"structure",
"members":{
"XAxis":{
"shape":"MeasureFieldList",
"documentation":"<p>The x-axis field well of a scatter plot.</p> <p>The x-axis is aggregated by category.</p>"
},
"YAxis":{
"shape":"MeasureFieldList",
"documentation":"<p>The y-axis field well of a scatter plot.</p> <p>The y-axis is aggregated by category.</p>"
},
"Category":{
"shape":"DimensionFieldList",
"documentation":"<p>The category field well of a scatter plot.</p>"
},
"Size":{
"shape":"MeasureFieldList",
"documentation":"<p>The size field well of a scatter plot.</p>"
}
},
"documentation":"<p>The aggregated field well of a scatter plot.</p>"
},
"ScatterPlotConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"ScatterPlotFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"XAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.</p>"
},
"XAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.</p>"
},
"YAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.</p>"
},
"YAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The palette (chart color) display setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a scatter plot.</p>"
},
"ScatterPlotFieldWells":{
"type":"structure",
"members":{
"ScatterPlotCategoricallyAggregatedFieldWells":{
"shape":"ScatterPlotCategoricallyAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a scatter plot. Scatter plots that have a field in the category (group/color) field will have aggregated field wells. The x and y-axes of these scatter plots are aggregated by category.</p>"
},
"ScatterPlotUnaggregatedFieldWells":{
"shape":"ScatterPlotUnaggregatedFieldWells",
"documentation":"<p>The unaggregated field wells of a scatter plot. Scatter plots without a category field well have unaggregated field wells. The x and y-axes of these scatter plots are unaggregated.</p>"
}
},
"documentation":"<p>The field well configuration of a scatter plot.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ScatterPlotUnaggregatedFieldWells":{
"type":"structure",
"members":{
"XAxis":{
"shape":"DimensionFieldList",
"documentation":"<p>The x-axis field well of a scatter plot.</p> <p>The x-axis is a dimension field and cannot be aggregated.</p>"
},
"YAxis":{
"shape":"DimensionFieldList",
"documentation":"<p>The y-axis field well of a scatter plot.</p> <p>The y-axis is a dimension field and cannot be aggregated.</p>"
},
"Size":{
"shape":"MeasureFieldList",
"documentation":"<p>The size field well of a scatter plot.</p>"
}
},
"documentation":"<p>The unaggregated field wells of a scatter plot.</p>"
},
"ScatterPlotVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"ScatterPlotConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A scatter plot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html\">Using scatter plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ScrollBarOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the data zoom scroll bar.</p>"
},
"VisibleRange":{
"shape":"VisibleRangeOptions",
"documentation":"<p>The visibility range for the data zoom scroll bar.</p>"
}
},
"documentation":"<p>The visual display options for a data zoom scroll bar.</p>"
},
"SearchAnalysesRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analyses that you're searching for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Filters":{
"shape":"AnalysisSearchFilterList",
"documentation":"<p>The structure for the search filters that you want to apply to your search. </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true
}
}
},
"SearchAnalysesResponse":{
"type":"structure",
"members":{
"AnalysisSummaryList":{
"shape":"AnalysisSummaryList",
"documentation":"<p>Metadata describing the analyses that you searched for.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"SearchDashboardsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for. </p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Filters":{
"shape":"DashboardSearchFilterList",
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true
}
}
},
"SearchDashboardsResponse":{
"type":"structure",
"members":{
"DashboardSummaryList":{
"shape":"DashboardSummaryList",
"documentation":"<p>The list of dashboards owned by the user specified in <code>Filters</code> in your request.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"SearchDataSetsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Filters":{
"shape":"DataSetSearchFilterList",
"documentation":"<p>The filters to apply to the search.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true
}
}
},
"SearchDataSetsResponse":{
"type":"structure",
"members":{
"DataSetSummaries":{
"shape":"DataSetSummaryList",
"documentation":"<p>A <code>DataSetSummaries</code> object that returns a summary of a dataset.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"SearchDataSourcesRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Filters":{
"shape":"DataSourceSearchFilterList",
"documentation":"<p>The filters to apply to the search.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true
}
}
},
"SearchDataSourcesResponse":{
"type":"structure",
"members":{
"DataSourceSummaries":{
"shape":"DataSourceSummaryList",
"documentation":"<p>A <code>DataSourceSummaries</code> object that returns a summary of a data source.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"SearchFoldersRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Filters":{
"shape":"FolderSearchFilterList",
"documentation":"<p>The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, <code>\"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ]</code>.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true
}
}
},
"SearchFoldersResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"FolderSummaryList":{
"shape":"FolderSummaryList",
"documentation":"<p>A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"SearchGroupsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace",
"Filters"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to search.</p>",
"location":"uri",
"locationName":"Namespace"
},
"Filters":{
"shape":"GroupSearchFilterList",
"documentation":"<p>The structure for the search filters that you want to apply to your search.</p>"
}
}
},
"SearchGroupsResponse":{
"type":"structure",
"members":{
"GroupList":{
"shape":"GroupList",
"documentation":"<p>A list of groups in a specified namespace that match the filters you set in your <code>SearchGroups</code> request.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"Seasonality":{
"type":"integer",
"max":180,
"min":1
},
"SecondaryValueOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the secondary value.</p>"
}
},
"documentation":"<p>The options that determine the presentation of the secondary value of a KPI visual.</p>"
},
"SecretArn":{
"type":"string",
"max":2048,
"min":1,
"pattern":"^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+"
},
"SectionAfterPageBreak":{
"type":"structure",
"members":{
"Status":{
"shape":"SectionPageBreakStatus",
"documentation":"<p>The option that enables or disables a page break at the end of a section.</p>"
}
},
"documentation":"<p>The configuration of a page break after a section.</p>"
},
"SectionBasedLayoutCanvasSizeOptions":{
"type":"structure",
"members":{
"PaperCanvasSizeOptions":{
"shape":"SectionBasedLayoutPaperCanvasSizeOptions",
"documentation":"<p>The options for a paper canvas of a section-based layout.</p>"
}
},
"documentation":"<p>The options for the canvas of a section-based layout.</p>"
},
"SectionBasedLayoutConfiguration":{
"type":"structure",
"required":[
"HeaderSections",
"BodySections",
"FooterSections",
"CanvasSizeOptions"
],
"members":{
"HeaderSections":{
"shape":"HeaderFooterSectionConfigurationList",
"documentation":"<p>A list of header section configurations.</p>"
},
"BodySections":{
"shape":"BodySectionConfigurationList",
"documentation":"<p>A list of body section configurations.</p>"
},
"FooterSections":{
"shape":"HeaderFooterSectionConfigurationList",
"documentation":"<p>A list of footer section configurations.</p>"
},
"CanvasSizeOptions":{
"shape":"SectionBasedLayoutCanvasSizeOptions",
"documentation":"<p>The options for the canvas of a section-based layout.</p>"
}
},
"documentation":"<p>The configuration for a section-based layout.</p>"
},
"SectionBasedLayoutPaperCanvasSizeOptions":{
"type":"structure",
"members":{
"PaperSize":{
"shape":"PaperSize",
"documentation":"<p>The paper size that is used to define canvas dimensions.</p>"
},
"PaperOrientation":{
"shape":"PaperOrientation",
"documentation":"<p>The paper orientation that is used to define canvas dimensions. Choose one of the following options:</p> <ul> <li> <p>PORTRAIT</p> </li> <li> <p>LANDSCAPE</p> </li> </ul>"
},
"PaperMargin":{
"shape":"Spacing",
"documentation":"<p>Defines the spacing between the canvas content and the top, bottom, left, and right edges.</p>"
}
},
"documentation":"<p>The options for a paper canvas of a section-based layout.</p>"
},
"SectionLayoutConfiguration":{
"type":"structure",
"required":["FreeFormLayout"],
"members":{
"FreeFormLayout":{
"shape":"FreeFormSectionLayoutConfiguration",
"documentation":"<p>The free-form layout configuration of a section.</p>"
}
},
"documentation":"<p>The layout configuration of a section.</p>"
},
"SectionPageBreakConfiguration":{
"type":"structure",
"members":{
"After":{
"shape":"SectionAfterPageBreak",
"documentation":"<p>The configuration of a page break after a section.</p>"
}
},
"documentation":"<p>The configuration of a page break for a section.</p>"
},
"SectionPageBreakStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"SectionStyle":{
"type":"structure",
"members":{
"Height":{
"shape":"PixelLength",
"documentation":"<p>The height of a section.</p> <p>Heights can only be defined for header and footer sections. The default height margin is 0.5 inches. </p>"
},
"Padding":{
"shape":"Spacing",
"documentation":"<p>The spacing between section content and its top, bottom, left, and right edges.</p> <p>There is no padding by default.</p>"
}
},
"documentation":"<p>The options that style a section.</p>"
},
"SelectAllValueOptions":{
"type":"string",
"enum":["ALL_VALUES"]
},
"SelectedFieldList":{
"type":"list",
"member":{"shape":"FieldId"},
"max":20,
"min":1
},
"SelectedFieldOptions":{
"type":"string",
"enum":["ALL_FIELDS"]
},
"SelectedSheetsFilterScopeConfiguration":{
"type":"structure",
"members":{
"SheetVisualScopingConfigurations":{
"shape":"SheetVisualScopingConfigurations",
"documentation":"<p>The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.</p>"
}
},
"documentation":"<p>The configuration for applying a filter to specific sheets or visuals. You can apply this filter to multiple visuals that are on one sheet or to all visuals on a sheet.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"SelectedTooltipType":{
"type":"string",
"enum":[
"BASIC",
"DETAILED"
]
},
"SensitiveDouble":{
"type":"double",
"sensitive":true
},
"SensitiveDoubleList":{
"type":"list",
"member":{"shape":"SensitiveDouble"}
},
"SensitiveDoubleObject":{
"type":"double",
"sensitive":true
},
"SensitiveLong":{
"type":"long",
"sensitive":true
},
"SensitiveLongList":{
"type":"list",
"member":{"shape":"SensitiveLong"}
},
"SensitiveLongObject":{
"type":"long",
"sensitive":true
},
"SensitiveString":{
"type":"string",
"sensitive":true
},
"SensitiveStringList":{
"type":"list",
"member":{"shape":"SensitiveString"}
},
"SensitiveStringObject":{
"type":"string",
"sensitive":true
},
"SensitiveTimestamp":{
"type":"timestamp",
"sensitive":true
},
"SensitiveTimestampList":{
"type":"list",
"member":{"shape":"SensitiveTimestamp"}
},
"SeriesItem":{
"type":"structure",
"members":{
"FieldSeriesItem":{
"shape":"FieldSeriesItem",
"documentation":"<p>The field series item configuration of a line chart.</p>"
},
"DataFieldSeriesItem":{
"shape":"DataFieldSeriesItem",
"documentation":"<p>The data field series item configuration of a line chart.</p>"
}
},
"documentation":"<p>The series item configuration of a line chart.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"SeriesItemList":{
"type":"list",
"member":{"shape":"SeriesItem"},
"max":10
},
"ServiceNowParameters":{
"type":"structure",
"required":["SiteBaseUrl"],
"members":{
"SiteBaseUrl":{
"shape":"SiteBaseUrl",
"documentation":"<p>URL of the base site.</p>"
}
},
"documentation":"<p>The parameters for ServiceNow.</p>"
},
"SessionLifetimeInMinutes":{
"type":"long",
"max":600,
"min":15
},
"SessionLifetimeInMinutesInvalidException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>The number of minutes specified for the lifetime of a session isn't valid. The session lifetime must be 15-600 minutes.</p>",
"error":{"httpStatusCode":400},
"exception":true
},
"SessionTag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"SessionTagKey",
"documentation":"<p>The key for the tag.</p>"
},
"Value":{
"shape":"SessionTagValue",
"documentation":"<p>The value that you want to assign the tag.</p>"
}
},
"documentation":"<p>The key-value pair used for the row-level security tags feature.</p>"
},
"SessionTagKey":{
"type":"string",
"max":128,
"min":1
},
"SessionTagList":{
"type":"list",
"member":{"shape":"SessionTag"},
"max":50,
"min":1
},
"SessionTagValue":{
"type":"string",
"max":256,
"min":1,
"sensitive":true
},
"SetParameterValueConfiguration":{
"type":"structure",
"required":[
"DestinationParameterName",
"Value"
],
"members":{
"DestinationParameterName":{
"shape":"ParameterName",
"documentation":"<p>The destination parameter name of the <code>SetParameterValueConfiguration</code>.</p>"
},
"Value":{"shape":"DestinationParameterValueConfiguration"}
},
"documentation":"<p>The configuration of adding parameters in action.</p>"
},
"SetParameterValueConfigurationList":{
"type":"list",
"member":{"shape":"SetParameterValueConfiguration"},
"max":200,
"min":1
},
"ShapeConditionalFormat":{
"type":"structure",
"required":["BackgroundColor"],
"members":{
"BackgroundColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting for the shape background color of a filled map visual.</p>"
}
},
"documentation":"<p>The shape conditional formatting of a filled map visual.</p>"
},
"Sheet":{
"type":"structure",
"members":{
"SheetId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier associated with a sheet.</p>"
},
"Name":{
"shape":"SheetName",
"documentation":"<p>The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.</p>"
}
},
"documentation":"<p>A <i>sheet</i>, which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.</p>"
},
"SheetContentType":{
"type":"string",
"enum":[
"PAGINATED",
"INTERACTIVE"
]
},
"SheetControlDateTimePickerType":{
"type":"string",
"enum":[
"SINGLE_VALUED",
"DATE_RANGE"
]
},
"SheetControlLayout":{
"type":"structure",
"required":["Configuration"],
"members":{
"Configuration":{
"shape":"SheetControlLayoutConfiguration",
"documentation":"<p>The configuration that determines the elements and canvas size options of sheet control.</p>"
}
},
"documentation":"<p>A grid layout to define the placement of sheet control.</p>"
},
"SheetControlLayoutConfiguration":{
"type":"structure",
"members":{
"GridLayout":{
"shape":"GridLayoutConfiguration",
"documentation":"<p>The configuration that determines the elements and canvas size options of sheet control.</p>"
}
},
"documentation":"<p>The configuration that determines the elements and canvas size options of sheet control.</p>"
},
"SheetControlLayoutList":{
"type":"list",
"member":{"shape":"SheetControlLayout"},
"max":1,
"min":0
},
"SheetControlListType":{
"type":"string",
"enum":[
"MULTI_SELECT",
"SINGLE_SELECT"
]
},
"SheetControlSliderType":{
"type":"string",
"enum":[
"SINGLE_POINT",
"RANGE"
]
},
"SheetControlTitle":{
"type":"string",
"max":2048,
"min":1
},
"SheetControlsOption":{
"type":"structure",
"members":{
"VisibilityState":{
"shape":"DashboardUIState",
"documentation":"<p>Visibility state.</p>"
}
},
"documentation":"<p>Sheet controls option.</p>"
},
"SheetDefinition":{
"type":"structure",
"required":["SheetId"],
"members":{
"SheetId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a sheet.</p>"
},
"Title":{
"shape":"SheetTitle",
"documentation":"<p>The title of the sheet.</p>"
},
"Description":{
"shape":"SheetDescription",
"documentation":"<p>A description of the sheet.</p>"
},
"Name":{
"shape":"SheetName",
"documentation":"<p>The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.</p>"
},
"ParameterControls":{
"shape":"ParameterControlList",
"documentation":"<p>The list of parameter controls that are on a sheet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-controls.html\">Using a Control with a Parameter in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FilterControls":{
"shape":"FilterControlList",
"documentation":"<p>The list of filter controls that are on a sheet.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/filter-controls.html\">Adding filter controls to analysis sheets</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"Visuals":{
"shape":"VisualList",
"documentation":"<p>A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.</p>"
},
"TextBoxes":{
"shape":"SheetTextBoxList",
"documentation":"<p>The text boxes that are on a sheet.</p>"
},
"Layouts":{
"shape":"LayoutList",
"documentation":"<p>Layouts define how the components of a sheet are arranged.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/types-of-layout.html\">Types of layout</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"SheetControlLayouts":{
"shape":"SheetControlLayoutList",
"documentation":"<p>The control layouts of the sheet.</p>"
},
"ContentType":{
"shape":"SheetContentType",
"documentation":"<p>The layout content type of the sheet. Choose one of the following options:</p> <ul> <li> <p> <code>PAGINATED</code>: Creates a sheet for a paginated report.</p> </li> <li> <p> <code>INTERACTIVE</code>: Creates a sheet for an interactive dashboard.</p> </li> </ul>"
}
},
"documentation":"<p>A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.</p>"
},
"SheetDefinitionList":{
"type":"list",
"member":{"shape":"SheetDefinition"},
"max":20
},
"SheetDescription":{
"type":"string",
"max":1024,
"min":1
},
"SheetElementConfigurationOverrides":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the overrides are visible. Choose one of the following options:</p> <ul> <li> <p> <code>VISIBLE</code> </p> </li> <li> <p> <code>HIDDEN</code> </p> </li> </ul>"
}
},
"documentation":"<p>The override configuration of the rendering rules of a sheet.</p>"
},
"SheetElementRenderingRule":{
"type":"structure",
"required":[
"Expression",
"ConfigurationOverrides"
],
"members":{
"Expression":{
"shape":"Expression",
"documentation":"<p>The expression of the rendering rules of a sheet.</p>"
},
"ConfigurationOverrides":{
"shape":"SheetElementConfigurationOverrides",
"documentation":"<p>The override configuration of the rendering rules of a sheet.</p>"
}
},
"documentation":"<p>The rendering rules of a sheet that uses a free-form layout.</p>"
},
"SheetElementRenderingRuleList":{
"type":"list",
"member":{"shape":"SheetElementRenderingRule"},
"max":10000
},
"SheetList":{
"type":"list",
"member":{"shape":"Sheet"},
"max":20
},
"SheetName":{
"type":"string",
"max":2048,
"min":1
},
"SheetStyle":{
"type":"structure",
"members":{
"Tile":{
"shape":"TileStyle",
"documentation":"<p>The display options for tiles.</p>"
},
"TileLayout":{
"shape":"TileLayoutStyle",
"documentation":"<p>The layout options for tiles.</p>"
}
},
"documentation":"<p>The theme display options for sheets. </p>"
},
"SheetTextBox":{
"type":"structure",
"required":["SheetTextBoxId"],
"members":{
"SheetTextBoxId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.</p>"
},
"Content":{
"shape":"SheetTextBoxContent",
"documentation":"<p>The content that is displayed in the text box.</p>"
}
},
"documentation":"<p>A text box.</p>"
},
"SheetTextBoxContent":{
"type":"string",
"max":150000
},
"SheetTextBoxList":{
"type":"list",
"member":{"shape":"SheetTextBox"},
"max":100
},
"SheetTitle":{
"type":"string",
"max":1024,
"min":1
},
"SheetVisualScopingConfiguration":{
"type":"structure",
"required":[
"SheetId",
"Scope"
],
"members":{
"SheetId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The selected sheet that the filter is applied to.</p>"
},
"Scope":{
"shape":"FilterVisualScope",
"documentation":"<p>The scope of the applied entities. Choose one of the following options:</p> <ul> <li> <p> <code>ALL_VISUALS</code> </p> </li> <li> <p> <code>SELECTED_VISUALS</code> </p> </li> </ul>"
},
"VisualIds":{
"shape":"FilteredVisualsList",
"documentation":"<p>The selected visuals that the filter is applied to.</p>"
}
},
"documentation":"<p>The filter that is applied to the options.</p>"
},
"SheetVisualScopingConfigurations":{
"type":"list",
"member":{"shape":"SheetVisualScopingConfiguration"},
"max":50,
"min":1
},
"ShortFormatText":{
"type":"structure",
"members":{
"PlainText":{
"shape":"ShortPlainText",
"documentation":"<p>Plain text format.</p>"
},
"RichText":{
"shape":"ShortRichText",
"documentation":"<p>Rich text. Examples of rich text include bold, underline, and italics.</p>"
}
},
"documentation":"<p>The text format for the title.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"ShortPlainText":{
"type":"string",
"max":512,
"min":1
},
"ShortRestrictiveResourceId":{
"type":"string",
"max":512,
"min":1,
"pattern":"[\\w\\-]+"
},
"ShortRichText":{
"type":"string",
"max":1024,
"min":1
},
"SignupResponse":{
"type":"structure",
"members":{
"IAMUser":{
"shape":"Boolean",
"documentation":"<p>A Boolean that is <code>TRUE</code> if the Amazon QuickSight uses IAM as an authentication method.</p>"
},
"userLoginName":{
"shape":"String",
"documentation":"<p>The user login name for your Amazon QuickSight account.</p>"
},
"accountName":{
"shape":"String",
"documentation":"<p>The name of your Amazon QuickSight account.</p>"
},
"directoryType":{
"shape":"String",
"documentation":"<p>The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are <code>SIMPLE_AD</code>, <code>AD_CONNECTOR</code>, and <code>MICROSOFT_AD</code>.</p>"
}
},
"documentation":"<p>A <code>SignupResponse</code> object that contains a summary of a newly created account.</p>"
},
"SimpleClusterMarker":{
"type":"structure",
"members":{
"Color":{
"shape":"HexColor",
"documentation":"<p>The color of the simple cluster marker.</p>"
}
},
"documentation":"<p>The simple cluster marker of the cluster marker.</p>"
},
"SimpleNumericalAggregationFunction":{
"type":"string",
"enum":[
"SUM",
"AVERAGE",
"MIN",
"MAX",
"COUNT",
"DISTINCT_COUNT",
"VAR",
"VARP",
"STDEV",
"STDEVP",
"MEDIAN"
]
},
"SiteBaseUrl":{
"type":"string",
"max":1024,
"min":1
},
"SliderControlDisplayOptions":{
"type":"structure",
"members":{
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"SmallMultiplesDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"SmallMultiplesOptions":{
"type":"structure",
"members":{
"MaxVisibleRows":{
"shape":"VisiblePanelRows",
"documentation":"<p>Sets the maximum number of visible rows to display in the grid of small multiples panels.</p> <p>The default value is <code>Auto</code>, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.</p>"
},
"MaxVisibleColumns":{
"shape":"VisiblePanelColumns",
"documentation":"<p>Sets the maximum number of visible columns to display in the grid of small multiples panels.</p> <p>The default is <code>Auto</code>, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.</p>"
},
"PanelConfiguration":{
"shape":"PanelConfiguration",
"documentation":"<p>Configures the display options for each small multiples panel.</p>"
}
},
"documentation":"<p>Options that determine the layout and display options of a chart's small multiples.</p>"
},
"SnowflakeParameters":{
"type":"structure",
"required":[
"Host",
"Database",
"Warehouse"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
},
"Warehouse":{
"shape":"Warehouse",
"documentation":"<p>Warehouse.</p>"
}
},
"documentation":"<p>The parameters for Snowflake.</p>"
},
"SortDirection":{
"type":"string",
"enum":[
"ASC",
"DESC"
]
},
"Spacing":{
"type":"structure",
"members":{
"Top":{
"shape":"Length",
"documentation":"<p>Define the top spacing.</p>"
},
"Bottom":{
"shape":"Length",
"documentation":"<p>Define the bottom spacing.</p>"
},
"Left":{
"shape":"Length",
"documentation":"<p>Define the left spacing.</p>"
},
"Right":{
"shape":"Length",
"documentation":"<p>Define the right spacing.</p>"
}
},
"documentation":"<p>The configuration of spacing (often a margin or padding).</p>"
},
"SparkParameters":{
"type":"structure",
"required":[
"Host",
"Port"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
}
},
"documentation":"<p>The parameters for Spark.</p>"
},
"SqlEndpointPath":{
"type":"string",
"max":4096,
"min":1
},
"SqlQuery":{
"type":"string",
"max":65536,
"min":1
},
"SqlServerParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for SQL Server.</p>"
},
"SslProperties":{
"type":"structure",
"members":{
"DisableSsl":{
"shape":"Boolean",
"documentation":"<p>A Boolean option to control whether SSL should be disabled.</p>"
}
},
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying data source.</p>"
},
"Status":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"StatusCode":{"type":"integer"},
"String":{"type":"string"},
"StringDefaultValueList":{
"type":"list",
"member":{"shape":"SensitiveStringObject"},
"max":50000
},
"StringDefaultValues":{
"type":"structure",
"members":{
"DynamicValue":{
"shape":"DynamicDefaultValue",
"documentation":"<p>The dynamic value of the <code>StringDefaultValues</code>. Different defaults displayed according to users, groups, and values mapping.</p>"
},
"StaticValues":{
"shape":"StringDefaultValueList",
"documentation":"<p>The static values of the <code>DecimalDefaultValues</code>.</p>"
}
},
"documentation":"<p>The default values of the <code>StringParameterDeclaration</code>.</p>"
},
"StringFormatConfiguration":{
"type":"structure",
"members":{
"NullValueFormatConfiguration":{
"shape":"NullValueFormatConfiguration",
"documentation":"<p>The options that determine the null value format configuration.</p>"
},
"NumericFormatConfiguration":{
"shape":"NumericFormatConfiguration",
"documentation":"<p>The formatting configuration for numeric strings.</p>"
}
},
"documentation":"<p>Formatting configuration for string fields.</p>"
},
"StringList":{
"type":"list",
"member":{"shape":"String"}
},
"StringParameter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A display name for a string parameter.</p>"
},
"Values":{
"shape":"SensitiveStringList",
"documentation":"<p>The values of a string parameter.</p>"
}
},
"documentation":"<p>A string parameter.</p>"
},
"StringParameterDeclaration":{
"type":"structure",
"required":[
"ParameterValueType",
"Name"
],
"members":{
"ParameterValueType":{
"shape":"ParameterValueType",
"documentation":"<p>The value type determines whether the parameter is a single-value or multi-value parameter.</p>"
},
"Name":{
"shape":"ParameterName",
"documentation":"<p>The name of the parameter that is being declared.</p>"
},
"DefaultValues":{
"shape":"StringDefaultValues",
"documentation":"<p>The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.</p>"
},
"ValueWhenUnset":{
"shape":"StringValueWhenUnsetConfiguration",
"documentation":"<p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>"
}
},
"documentation":"<p>A parameter declaration for the <code>String</code> data type.</p>"
},
"StringParameterList":{
"type":"list",
"member":{"shape":"StringParameter"},
"max":100
},
"StringValueWhenUnsetConfiguration":{
"type":"structure",
"members":{
"ValueWhenUnsetOption":{
"shape":"ValueWhenUnsetOption",
"documentation":"<p>The built-in options for default values. The value can be one of the following:</p> <ul> <li> <p> <code>RECOMMENDED</code>: The recommended value.</p> </li> <li> <p> <code>NULL</code>: The <code>NULL</code> value.</p> </li> </ul>"
},
"CustomValue":{
"shape":"SensitiveString",
"documentation":"<p>A custom value that's used when the value of a parameter isn't set.</p>"
}
},
"documentation":"<p>The configuration that defines the default value of a <code>String</code> parameter when a value has not been set.</p>"
},
"SubtotalOptions":{
"type":"structure",
"members":{
"TotalsVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration for the subtotal cells.</p>"
},
"CustomLabel":{
"shape":"String",
"documentation":"<p>The custom label string for the subtotal cells.</p>"
},
"FieldLevel":{
"shape":"PivotTableSubtotalLevel",
"documentation":"<p>The field level (all, custom, last) for the subtotal cells.</p>"
},
"FieldLevelOptions":{
"shape":"PivotTableFieldSubtotalOptionsList",
"documentation":"<p>The optional configuration of subtotal cells.</p>"
},
"TotalCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the subtotal cells.</p>"
},
"ValueCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the subtotals of value cells.</p>"
},
"MetricHeaderCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The cell styling options for the subtotals of header cells.</p>"
}
},
"documentation":"<p>The subtotal options.</p>"
},
"Suffix":{
"type":"string",
"max":128,
"min":1,
"sensitive":true
},
"TableAggregatedFieldWells":{
"type":"structure",
"members":{
"GroupBy":{
"shape":"DimensionFieldList",
"documentation":"<p>The group by field well for a pivot table. Values are grouped by group by fields.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The values field well for a pivot table. Values are aggregated based on group by fields.</p>"
}
},
"documentation":"<p>The aggregated field well for the table.</p>"
},
"TableBorderOptions":{
"type":"structure",
"members":{
"Color":{
"shape":"HexColor",
"documentation":"<p>The color of a table border.</p>"
},
"Thickness":{
"shape":"TableBorderThickness",
"documentation":"<p>The thickness of a table border.</p>"
},
"Style":{
"shape":"TableBorderStyle",
"documentation":"<p>The style (none, solid) of a table border.</p>"
}
},
"documentation":"<p>The border options for a table border.</p>"
},
"TableBorderStyle":{
"type":"string",
"enum":[
"NONE",
"SOLID"
]
},
"TableBorderThickness":{
"type":"integer",
"max":4,
"min":1
},
"TableCellConditionalFormatting":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID of the cell for conditional formatting.</p>"
},
"TextFormat":{
"shape":"TextConditionalFormat",
"documentation":"<p>The text format of the cell for conditional formatting.</p>"
}
},
"documentation":"<p>The cell conditional formatting option for a table.</p>"
},
"TableCellImageScalingConfiguration":{
"type":"string",
"enum":[
"FIT_TO_CELL_HEIGHT",
"FIT_TO_CELL_WIDTH",
"DO_NOT_SCALE"
]
},
"TableCellImageSizingConfiguration":{
"type":"structure",
"members":{
"TableCellImageScalingConfiguration":{
"shape":"TableCellImageScalingConfiguration",
"documentation":"<p>The cell scaling configuration of the sizing options for the table image configuration.</p>"
}
},
"documentation":"<p>The sizing options for the table image configuration.</p>"
},
"TableCellStyle":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the table cells.</p>"
},
"FontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration of the table cells.</p>"
},
"TextWrap":{
"shape":"TextWrap",
"documentation":"<p>The text wrap (none, wrap) for the table cells.</p>"
},
"HorizontalTextAlignment":{
"shape":"HorizontalTextAlignment",
"documentation":"<p>The horizontal text alignment (left, center, right, auto) for the table cells.</p>"
},
"VerticalTextAlignment":{
"shape":"VerticalTextAlignment",
"documentation":"<p>The vertical text alignment (top, middle, bottom) for the table cells.</p>"
},
"BackgroundColor":{
"shape":"HexColor",
"documentation":"<p>The background color for the table cells.</p>"
},
"Height":{
"shape":"TableFieldHeight",
"documentation":"<p>The height color for the table cells.</p>"
},
"Border":{
"shape":"GlobalTableBorderOptions",
"documentation":"<p>The borders for the table cells.</p>"
}
},
"documentation":"<p>The table cell style for a cell in pivot table or table visual.</p>"
},
"TableConditionalFormatting":{
"type":"structure",
"members":{
"ConditionalFormattingOptions":{
"shape":"TableConditionalFormattingOptionList",
"documentation":"<p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>"
}
},
"documentation":"<p>The conditional formatting for a <code>PivotTableVisual</code>.</p>"
},
"TableConditionalFormattingOption":{
"type":"structure",
"members":{
"Cell":{
"shape":"TableCellConditionalFormatting",
"documentation":"<p>The cell conditional formatting option for a table.</p>"
},
"Row":{
"shape":"TableRowConditionalFormatting",
"documentation":"<p>The row conditional formatting option for a table.</p>"
}
},
"documentation":"<p>Conditional formatting options for a <code>PivotTableVisual</code>.</p>"
},
"TableConditionalFormattingOptionList":{
"type":"list",
"member":{"shape":"TableConditionalFormattingOption"},
"max":100
},
"TableConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"TableFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"TableSortConfiguration",
"documentation":"<p>The sort configuration for a <code>TableVisual</code>.</p>"
},
"TableOptions":{
"shape":"TableOptions",
"documentation":"<p>The table options for a table visual.</p>"
},
"TotalOptions":{
"shape":"TotalOptions",
"documentation":"<p>The total options for a table visual.</p>"
},
"FieldOptions":{
"shape":"TableFieldOptions",
"documentation":"<p>The field options for a table visual.</p>"
},
"PaginatedReportOptions":{
"shape":"TablePaginatedReportOptions",
"documentation":"<p>The paginated report options for a table visual.</p>"
}
},
"documentation":"<p>The configuration for a <code>TableVisual</code>.</p>"
},
"TableFieldCustomIconContent":{
"type":"structure",
"members":{
"Icon":{
"shape":"TableFieldIconSetType",
"documentation":"<p>The icon set type (link) of the custom icon content for table URL link content.</p>"
}
},
"documentation":"<p>The custom icon content for the table link content configuration.</p>"
},
"TableFieldCustomTextContent":{
"type":"structure",
"required":["FontConfiguration"],
"members":{
"Value":{
"shape":"String",
"documentation":"<p>The string value of the custom text content for the table URL link content.</p>"
},
"FontConfiguration":{
"shape":"FontConfiguration",
"documentation":"<p>The font configuration of the custom text content for the table URL link content.</p>"
}
},
"documentation":"<p>The custom text content (value, font configuration) for the table link content configuration.</p>"
},
"TableFieldHeight":{
"type":"integer",
"max":500,
"min":8
},
"TableFieldIconSetType":{
"type":"string",
"enum":["LINK"]
},
"TableFieldImageConfiguration":{
"type":"structure",
"members":{
"SizingOptions":{
"shape":"TableCellImageSizingConfiguration",
"documentation":"<p>The sizing options for the table image configuration.</p>"
}
},
"documentation":"<p>The image configuration of a table field URL.</p>"
},
"TableFieldLinkConfiguration":{
"type":"structure",
"required":[
"Target",
"Content"
],
"members":{
"Target":{
"shape":"URLTargetConfiguration",
"documentation":"<p>The URL target (new tab, new window, same tab) for the table link configuration.</p>"
},
"Content":{
"shape":"TableFieldLinkContentConfiguration",
"documentation":"<p>The URL content (text, icon) for the table link configuration.</p>"
}
},
"documentation":"<p>The link configuration of a table field URL.</p>"
},
"TableFieldLinkContentConfiguration":{
"type":"structure",
"members":{
"CustomTextContent":{
"shape":"TableFieldCustomTextContent",
"documentation":"<p>The custom text content (value, font configuration) for the table link content configuration.</p>"
},
"CustomIconContent":{
"shape":"TableFieldCustomIconContent",
"documentation":"<p>The custom icon content for the table link content configuration.</p>"
}
},
"documentation":"<p>The URL content (text, icon) for the table link configuration.</p>"
},
"TableFieldOption":{
"type":"structure",
"required":["FieldId"],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The field ID for a table field.</p>"
},
"Width":{
"shape":"PixelLength",
"documentation":"<p>The width for a table field.</p>"
},
"CustomLabel":{
"shape":"CustomLabel",
"documentation":"<p>The custom label for a table field.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of a table field.</p>"
},
"URLStyling":{
"shape":"TableFieldURLConfiguration",
"documentation":"<p>The URL configuration for a table field.</p>"
}
},
"documentation":"<p>The options for a table field.</p>"
},
"TableFieldOptionList":{
"type":"list",
"member":{"shape":"TableFieldOption"},
"max":100
},
"TableFieldOptions":{
"type":"structure",
"members":{
"SelectedFieldOptions":{
"shape":"TableFieldOptionList",
"documentation":"<p>The selected field options for the table field options.</p>"
},
"Order":{
"shape":"FieldOrderList",
"documentation":"<p>The order of field IDs of the field options for a table visual.</p>"
}
},
"documentation":"<p>The field options for a table visual.</p>"
},
"TableFieldURLConfiguration":{
"type":"structure",
"members":{
"LinkConfiguration":{
"shape":"TableFieldLinkConfiguration",
"documentation":"<p>The link configuration of a table field URL.</p>"
},
"ImageConfiguration":{
"shape":"TableFieldImageConfiguration",
"documentation":"<p>The image configuration of a table field URL.</p>"
}
},
"documentation":"<p>The URL configuration for a table field.</p>"
},
"TableFieldWells":{
"type":"structure",
"members":{
"TableAggregatedFieldWells":{
"shape":"TableAggregatedFieldWells",
"documentation":"<p>The aggregated field well for the table.</p>"
},
"TableUnaggregatedFieldWells":{
"shape":"TableUnaggregatedFieldWells",
"documentation":"<p>The unaggregated field well for the table.</p>"
}
},
"documentation":"<p>The field wells for a table visual.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"TableOptions":{
"type":"structure",
"members":{
"Orientation":{
"shape":"TableOrientation",
"documentation":"<p>The orientation (vertical, horizontal) for a table.</p>"
},
"HeaderStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of a table header.</p>"
},
"CellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>The table cell style of table cells.</p>"
},
"RowAlternateColorOptions":{
"shape":"RowAlternateColorOptions",
"documentation":"<p>The row alternate color options (widget status, row alternate colors) for a table.</p>"
}
},
"documentation":"<p>The table options for a table visual.</p>"
},
"TableOrientation":{
"type":"string",
"enum":[
"VERTICAL",
"HORIZONTAL"
]
},
"TablePaginatedReportOptions":{
"type":"structure",
"members":{
"VerticalOverflowVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of printing table overflow across pages.</p>"
},
"OverflowColumnHeaderVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of repeating header rows on each page.</p>"
}
},
"documentation":"<p>The paginated report options for a table visual.</p>"
},
"TableRowConditionalFormatting":{
"type":"structure",
"members":{
"BackgroundColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting color (solid, gradient) of the background for a table row.</p>"
},
"TextColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting color (solid, gradient) of the text for a table row.</p>"
}
},
"documentation":"<p>The conditional formatting of a table row.</p>"
},
"TableSideBorderOptions":{
"type":"structure",
"members":{
"InnerVertical":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the inner vertical border.</p>"
},
"InnerHorizontal":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the inner horizontal border.</p>"
},
"Left":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the left border.</p>"
},
"Right":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the right border.</p>"
},
"Top":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the top border.</p>"
},
"Bottom":{
"shape":"TableBorderOptions",
"documentation":"<p>The table border options of the bottom border.</p>"
}
},
"documentation":"<p>The side border options for a table.</p>"
},
"TableSortConfiguration":{
"type":"structure",
"members":{
"RowSort":{
"shape":"RowSortList",
"documentation":"<p>The field sort options for rows in the table.</p>"
},
"PaginationConfiguration":{
"shape":"PaginationConfiguration",
"documentation":"<p>The pagination configuration (page size, page number) for the table.</p>"
}
},
"documentation":"<p>The sort configuration for a <code>TableVisual</code>.</p>"
},
"TableTotalsPlacement":{
"type":"string",
"enum":[
"START",
"END"
]
},
"TableTotalsScrollStatus":{
"type":"string",
"enum":[
"PINNED",
"SCROLLED"
]
},
"TableUnaggregatedFieldWells":{
"type":"structure",
"members":{
"Values":{
"shape":"UnaggregatedFieldList",
"documentation":"<p>The values field well for a pivot table. Values are unaggregated for an unaggregated table.</p>"
}
},
"documentation":"<p>The unaggregated field well for the table.</p>"
},
"TableVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"TableConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"ConditionalFormatting":{
"shape":"TableConditionalFormatting",
"documentation":"<p>The conditional formatting for a <code>PivotTableVisual</code>.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
}
},
"documentation":"<p>A table visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/tabular.html\">Using tables as visuals</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"Tag":{
"type":"structure",
"required":[
"Key",
"Value"
],
"members":{
"Key":{
"shape":"TagKey",
"documentation":"<p>Tag key.</p>"
},
"Value":{
"shape":"TagValue",
"documentation":"<p>Tag value.</p>"
}
},
"documentation":"<p>The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
},
"TagColumnOperation":{
"type":"structure",
"required":[
"ColumnName",
"Tags"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>The column that this operation acts on.</p>"
},
"Tags":{
"shape":"ColumnTagList",
"documentation":"<p>The dataset column tag, currently only used for geospatial type tagging.</p> <note> <p>This is not tags for the Amazon Web Services tagging feature.</p> </note>"
}
},
"documentation":"<p>A transform operation that tags a column with additional information.</p>"
},
"TagKey":{
"type":"string",
"max":128,
"min":1
},
"TagKeyList":{
"type":"list",
"member":{"shape":"TagKey"},
"max":200,
"min":1
},
"TagList":{
"type":"list",
"member":{"shape":"Tag"},
"max":200,
"min":1
},
"TagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"Tags"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to tag.</p>",
"location":"uri",
"locationName":"ResourceArn"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
}
}
},
"TagResourceResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"TagValue":{
"type":"string",
"max":256,
"min":1
},
"TargetVisualList":{
"type":"list",
"member":{"shape":"ShortRestrictiveResourceId"},
"max":30,
"min":1
},
"TargetVisualOptions":{
"type":"string",
"enum":["ALL_VISUALS"]
},
"Template":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>The display name of the template.</p>"
},
"Version":{
"shape":"TemplateVersion",
"documentation":"<p>A structure describing the versions of the template.</p>"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>Time when this was last updated.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>Time when this was created.</p>"
}
},
"documentation":"<p>A template object. A <i>template</i> is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.</p> <p>You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to create a template or a dashboard from an existing template.</p>"
},
"TemplateAlias":{
"type":"structure",
"members":{
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The display name of the template alias.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template alias.</p>"
},
"TemplateVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template alias.</p>"
}
},
"documentation":"<p>The template alias.</p>"
},
"TemplateAliasList":{
"type":"list",
"member":{"shape":"TemplateAlias"},
"max":100
},
"TemplateError":{
"type":"structure",
"members":{
"Type":{
"shape":"TemplateErrorType",
"documentation":"<p>Type of error.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>Description of the error type.</p>"
},
"ViolatedEntities":{
"shape":"EntityList",
"documentation":"<p/>"
}
},
"documentation":"<p>List of errors that occurred when the template version creation failed.</p>"
},
"TemplateErrorList":{
"type":"list",
"member":{"shape":"TemplateError"},
"min":1
},
"TemplateErrorType":{
"type":"string",
"enum":[
"SOURCE_NOT_FOUND",
"DATA_SET_NOT_FOUND",
"INTERNAL_FAILURE",
"ACCESS_DENIED"
]
},
"TemplateName":{
"type":"string",
"max":2048,
"min":1
},
"TemplateSourceAnalysis":{
"type":"structure",
"required":[
"Arn",
"DataSetReferences"
],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"DataSetReferences":{
"shape":"DataSetReferenceList",
"documentation":"<p>A structure containing information about the dataset references used as placeholders in the template.</p>"
}
},
"documentation":"<p>The source analysis of the template.</p>"
},
"TemplateSourceEntity":{
"type":"structure",
"members":{
"SourceAnalysis":{
"shape":"TemplateSourceAnalysis",
"documentation":"<p>The source analysis, if it is based on an analysis.</p>"
},
"SourceTemplate":{
"shape":"TemplateSourceTemplate",
"documentation":"<p>The source template, if it is based on an template.</p>"
}
},
"documentation":"<p>The source entity of the template.</p>"
},
"TemplateSourceTemplate":{
"type":"structure",
"required":["Arn"],
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
}
},
"documentation":"<p>The source template of the template.</p>"
},
"TemplateSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>A summary of a template.</p>"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>A display name for the template.</p>"
},
"LatestVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>A structure containing a list of version numbers for the template summary.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this template was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this template was updated.</p>"
}
},
"documentation":"<p>The template summary.</p>"
},
"TemplateSummaryList":{
"type":"list",
"member":{"shape":"TemplateSummary"},
"max":100
},
"TemplateVersion":{
"type":"structure",
"members":{
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this template version was created.</p>"
},
"Errors":{
"shape":"TemplateErrorList",
"documentation":"<p>Errors associated with this template version.</p>"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template version.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The HTTP status of the request.</p>"
},
"DataSetConfigurations":{
"shape":"DataSetConfigurationList",
"documentation":"<p>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.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the template.</p>"
},
"SourceEntityArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the theme associated with this version of the template.</p>"
},
"Sheets":{
"shape":"SheetList",
"documentation":"<p>A list of the associated sheets with the unique identifier and name of each sheet.</p>"
}
},
"documentation":"<p>A version of a template.</p>"
},
"TemplateVersionDefinition":{
"type":"structure",
"required":["DataSetConfigurations"],
"members":{
"DataSetConfigurations":{
"shape":"DataSetConfigurationList",
"documentation":"<p>An array of dataset configurations. These configurations define the required columns for each dataset used within a template.</p>"
},
"Sheets":{
"shape":"SheetDefinitionList",
"documentation":"<p>An array of sheet definitions for a template.</p>"
},
"CalculatedFields":{
"shape":"CalculatedFields",
"documentation":"<p>An array of calculated field definitions for the template.</p>"
},
"ParameterDeclarations":{
"shape":"ParameterDeclarationList",
"documentation":"<p>An array of parameter declarations for a template.</p> <p> <i>Parameters</i> are named variables that can transfer a value for use by an action or an object.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html\">Parameters in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>. </p>"
},
"FilterGroups":{
"shape":"FilterGroupList",
"documentation":"<p>Filter definitions for a template.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/filtering-visual-data.html\">Filtering Data</a> in the <i>Amazon QuickSight User Guide</i>. </p>"
},
"ColumnConfigurations":{
"shape":"ColumnConfigurationList",
"documentation":"<p> An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template. </p>"
},
"AnalysisDefaults":{"shape":"AnalysisDefaults"}
},
"documentation":"<p>The detailed definition of a template.</p>"
},
"TemplateVersionSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template version.</p>"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template version.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this template version was created.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the template version.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the template version.</p>"
}
},
"documentation":"<p>The template version.</p>"
},
"TemplateVersionSummaryList":{
"type":"list",
"member":{"shape":"TemplateVersionSummary"},
"max":100
},
"TeradataParameters":{
"type":"structure",
"required":[
"Host",
"Port",
"Database"
],
"members":{
"Host":{
"shape":"Host",
"documentation":"<p>Host.</p>"
},
"Port":{
"shape":"Port",
"documentation":"<p>Port.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
}
},
"documentation":"<p>The parameters for Teradata.</p>"
},
"TextAreaControlDelimiter":{
"type":"string",
"max":2048,
"min":1
},
"TextAreaControlDisplayOptions":{
"type":"structure",
"members":{
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
},
"PlaceholderOptions":{
"shape":"TextControlPlaceholderOptions",
"documentation":"<p>The configuration of the placeholder options in a text area control.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"TextConditionalFormat":{
"type":"structure",
"members":{
"BackgroundColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting for the text background color.</p>"
},
"TextColor":{
"shape":"ConditionalFormattingColor",
"documentation":"<p>The conditional formatting for the text color.</p>"
},
"Icon":{
"shape":"ConditionalFormattingIcon",
"documentation":"<p>The conditional formatting for the icon.</p>"
}
},
"documentation":"<p>The conditional formatting for the text.</p>"
},
"TextControlPlaceholderOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration of the placeholder options in a text control.</p>"
}
},
"documentation":"<p>The configuration of the placeholder options in a text control.</p>"
},
"TextFieldControlDisplayOptions":{
"type":"structure",
"members":{
"TitleOptions":{
"shape":"LabelOptions",
"documentation":"<p>The options to configure the title visibility, name, and font size.</p>"
},
"PlaceholderOptions":{
"shape":"TextControlPlaceholderOptions",
"documentation":"<p>The configuration of the placeholder options in a text field control.</p>"
}
},
"documentation":"<p>The display options of a control.</p>"
},
"TextQualifier":{
"type":"string",
"enum":[
"DOUBLE_QUOTE",
"SINGLE_QUOTE"
]
},
"TextWrap":{
"type":"string",
"enum":[
"NONE",
"WRAP"
]
},
"Theme":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>The name that the user gives to the theme.</p>"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The identifier that the user gives to the theme.</p>"
},
"Version":{"shape":"ThemeVersion"},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the theme was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that the theme was last updated.</p>"
},
"Type":{
"shape":"ThemeType",
"documentation":"<p>The type of theme, based on how it was created. Valid values include: <code>QUICKSIGHT</code> and <code>CUSTOM</code>.</p>"
}
},
"documentation":"<p>Summary information about a theme.</p>"
},
"ThemeAlias":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme alias.</p>"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The display name of the theme alias.</p>"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme alias.</p>"
}
},
"documentation":"<p>An alias for a theme.</p>"
},
"ThemeAliasList":{
"type":"list",
"member":{"shape":"ThemeAlias"},
"max":100
},
"ThemeConfiguration":{
"type":"structure",
"members":{
"DataColorPalette":{
"shape":"DataColorPalette",
"documentation":"<p>Color properties that apply to chart data colors.</p>"
},
"UIColorPalette":{
"shape":"UIColorPalette",
"documentation":"<p>Color properties that apply to the UI and to charts, excluding the colors that apply to data. </p>"
},
"Sheet":{
"shape":"SheetStyle",
"documentation":"<p>Display options related to sheets.</p>"
},
"Typography":{"shape":"Typography"}
},
"documentation":"<p>The theme configuration. This configuration contains all of the display properties for a theme.</p>"
},
"ThemeError":{
"type":"structure",
"members":{
"Type":{
"shape":"ThemeErrorType",
"documentation":"<p>The type of error.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>Theme error.</p>"
},
"ThemeErrorList":{
"type":"list",
"member":{"shape":"ThemeError"},
"min":1
},
"ThemeErrorType":{
"type":"string",
"enum":["INTERNAL_FAILURE"]
},
"ThemeName":{
"type":"string",
"max":2048,
"min":1
},
"ThemeSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>the display name for the theme.</p>"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"LatestVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The latest version number for the theme. </p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last date and time that this theme was updated.</p>"
}
},
"documentation":"<p>The theme summary.</p>"
},
"ThemeSummaryList":{
"type":"list",
"member":{"shape":"ThemeSummary"},
"max":100
},
"ThemeType":{
"type":"string",
"enum":[
"QUICKSIGHT",
"CUSTOM",
"ALL"
]
},
"ThemeVersion":{
"type":"structure",
"members":{
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the theme.</p>"
},
"BaseThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme version was created.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains all the theme display properties.</p>"
},
"Errors":{
"shape":"ThemeErrorList",
"documentation":"<p>Errors associated with the theme.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the theme version.</p>"
}
},
"documentation":"<p>A version of a theme.</p>"
},
"ThemeVersionSummary":{
"type":"structure",
"members":{
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme version.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme version.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the theme version.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme version was created.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the theme version.</p>"
}
},
"documentation":"<p>The theme version.</p>"
},
"ThemeVersionSummaryList":{
"type":"list",
"member":{"shape":"ThemeVersionSummary"},
"max":100
},
"ThousandSeparatorOptions":{
"type":"structure",
"members":{
"Symbol":{
"shape":"NumericSeparatorSymbol",
"documentation":"<p>Determines the thousands separator symbol.</p>"
},
"Visibility":{
"shape":"Visibility",
"documentation":"<p>Determines the visibility of the thousands separator.</p>"
}
},
"documentation":"<p>The options that determine the thousands separator configuration.</p>"
},
"ThrottlingException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>Access is throttled.</p>",
"error":{"httpStatusCode":429},
"exception":true
},
"TileLayoutStyle":{
"type":"structure",
"members":{
"Gutter":{
"shape":"GutterStyle",
"documentation":"<p>The gutter settings that apply between tiles. </p>"
},
"Margin":{
"shape":"MarginStyle",
"documentation":"<p>The margin settings that apply around the outside edge of sheets.</p>"
}
},
"documentation":"<p>The display options for the layout of tiles on a sheet.</p>"
},
"TileStyle":{
"type":"structure",
"members":{
"Border":{
"shape":"BorderStyle",
"documentation":"<p>The border around a tile.</p>"
}
},
"documentation":"<p>Display options related to tiles on a sheet.</p>"
},
"TimeBasedForecastProperties":{
"type":"structure",
"members":{
"PeriodsForward":{
"shape":"PeriodsForward",
"documentation":"<p>The periods forward setup of a forecast computation.</p>",
"box":true
},
"PeriodsBackward":{
"shape":"PeriodsBackward",
"documentation":"<p>The periods backward setup of a forecast computation.</p>",
"box":true
},
"UpperBoundary":{
"shape":"Double",
"documentation":"<p>The upper boundary setup of a forecast computation.</p>",
"box":true
},
"LowerBoundary":{
"shape":"Double",
"documentation":"<p>The lower boundary setup of a forecast computation.</p>",
"box":true
},
"PredictionInterval":{
"shape":"PredictionInterval",
"documentation":"<p>The prediction interval setup of a forecast computation.</p>",
"box":true
},
"Seasonality":{
"shape":"Seasonality",
"documentation":"<p>The seasonality setup of a forecast computation. Choose one of the following options:</p> <ul> <li> <p> <code>NULL</code>: The input is set to <code>NULL</code>.</p> </li> <li> <p> <code>NON_NULL</code>: The input is set to a custom value.</p> </li> </ul>",
"box":true
}
},
"documentation":"<p>The forecast properties setup of a forecast in the line chart.</p>"
},
"TimeEqualityFilter":{
"type":"structure",
"required":[
"FilterId",
"Column"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"Value":{
"shape":"Timestamp",
"documentation":"<p>The value of a <code>TimeEquality</code> filter.</p> <p>This field is mutually exclusive to <code>ParameterName</code>.</p>"
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The parameter whose value should be used for the filter value.</p> <p>This field is mutually exclusive to <code>Value</code>.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
}
},
"documentation":"<p>A <code>TimeEqualityFilter</code> filters values that are equal to a given value.</p>"
},
"TimeGranularity":{
"type":"string",
"enum":[
"YEAR",
"QUARTER",
"MONTH",
"WEEK",
"DAY",
"HOUR",
"MINUTE",
"SECOND",
"MILLISECOND"
]
},
"TimeRangeDrillDownFilter":{
"type":"structure",
"required":[
"Column",
"RangeMinimum",
"RangeMaximum",
"TimeGranularity"
],
"members":{
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"RangeMinimum":{
"shape":"Timestamp",
"documentation":"<p>The minimum value for the filter value range.</p>"
},
"RangeMaximum":{
"shape":"Timestamp",
"documentation":"<p>The maximum value for the filter value range.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
}
},
"documentation":"<p>The time range drill down filter.</p>"
},
"TimeRangeFilter":{
"type":"structure",
"required":[
"FilterId",
"Column",
"NullOption"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"IncludeMinimum":{
"shape":"Boolean",
"documentation":"<p>Determines whether the minimum value in the filter value range should be included in the filtered results.</p>",
"box":true
},
"IncludeMaximum":{
"shape":"Boolean",
"documentation":"<p>Determines whether the maximum value in the filter value range should be included in the filtered results.</p>",
"box":true
},
"RangeMinimumValue":{
"shape":"TimeRangeFilterValue",
"documentation":"<p>The minimum value for the filter value range.</p>"
},
"RangeMaximumValue":{
"shape":"TimeRangeFilterValue",
"documentation":"<p>The maximum value for the filter value range.</p>"
},
"NullOption":{
"shape":"FilterNullOption",
"documentation":"<p>This option determines how null values should be treated when filtering data.</p> <ul> <li> <p> <code>ALL_VALUES</code>: Include null values in filtered results.</p> </li> <li> <p> <code>NULLS_ONLY</code>: Only include null values in filtered results.</p> </li> <li> <p> <code>NON_NULLS_ONLY</code>: Exclude null values from filtered results.</p> </li> </ul>"
},
"ExcludePeriodConfiguration":{
"shape":"ExcludePeriodConfiguration",
"documentation":"<p>The exclude period of the time range filter.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
}
},
"documentation":"<p>A <code>TimeRangeFilter</code> filters values that are between two specified values.</p>"
},
"TimeRangeFilterValue":{
"type":"structure",
"members":{
"StaticValue":{
"shape":"Timestamp",
"documentation":"<p>The static input value.</p>"
},
"RollingDate":{
"shape":"RollingDateConfiguration",
"documentation":"<p>The rolling date input value.</p>"
},
"Parameter":{
"shape":"ParameterName",
"documentation":"<p>The parameter type input value.</p>"
}
},
"documentation":"<p>The value of a time range filter.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"Timestamp":{"type":"timestamp"},
"TooltipItem":{
"type":"structure",
"members":{
"FieldTooltipItem":{
"shape":"FieldTooltipItem",
"documentation":"<p>The tooltip item for the fields.</p>"
},
"ColumnTooltipItem":{
"shape":"ColumnTooltipItem",
"documentation":"<p>The tooltip item for the columns that are not part of a field well.</p>"
}
},
"documentation":"<p>The tooltip.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"TooltipItemList":{
"type":"list",
"member":{"shape":"TooltipItem"},
"max":100
},
"TooltipOptions":{
"type":"structure",
"members":{
"TooltipVisibility":{
"shape":"Visibility",
"documentation":"<p>Determines whether or not the tooltip is visible.</p>"
},
"SelectedTooltipType":{
"shape":"SelectedTooltipType",
"documentation":"<p>The selected type for the tooltip. Choose one of the following options:</p> <ul> <li> <p> <code>BASIC</code>: A basic tooltip.</p> </li> <li> <p> <code>DETAILED</code>: A detailed tooltip.</p> </li> </ul>"
},
"FieldBasedTooltip":{
"shape":"FieldBasedTooltip",
"documentation":"<p>The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.</p>"
}
},
"documentation":"<p>The display options for the visual tooltip.</p>"
},
"TooltipTitleType":{
"type":"string",
"enum":[
"NONE",
"PRIMARY_VALUE"
]
},
"TopBottomComputationType":{
"type":"string",
"enum":[
"TOP",
"BOTTOM"
]
},
"TopBottomFilter":{
"type":"structure",
"required":[
"FilterId",
"Column",
"AggregationSortConfigurations"
],
"members":{
"FilterId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>An identifier that uniquely identifies a filter within a dashboard, analysis, or template.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that the filter is applied to.</p>"
},
"Limit":{
"shape":"Integer",
"documentation":"<p>The number of items to include in the top bottom filter results.</p>",
"box":true
},
"AggregationSortConfigurations":{
"shape":"AggregationSortConfigurationList",
"documentation":"<p>The aggregation and sort configuration of the top bottom filter.</p>"
},
"TimeGranularity":{
"shape":"TimeGranularity",
"documentation":"<p>The level of time precision that is used to aggregate <code>DateTime</code> values.</p>"
},
"ParameterName":{
"shape":"ParameterName",
"documentation":"<p>The parameter whose value should be used for the filter value.</p>"
}
},
"documentation":"<p>A <code>TopBottomFilter</code> filters values that are at the top or the bottom.</p>"
},
"TopBottomMoversComputation":{
"type":"structure",
"required":[
"ComputationId",
"Time",
"Category",
"Type"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Time":{
"shape":"DimensionField",
"documentation":"<p>The time field that is used in a computation.</p>"
},
"Category":{
"shape":"DimensionField",
"documentation":"<p>The category field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"MoverSize":{
"shape":"TopBottomMoversComputationMoverSize",
"documentation":"<p>The mover size setup of the top and bottom movers computation.</p>"
},
"SortOrder":{
"shape":"TopBottomSortOrder",
"documentation":"<p>The sort order setup of the top and bottom movers computation.</p>"
},
"Type":{
"shape":"TopBottomComputationType",
"documentation":"<p>The computation type. Choose from the following options:</p> <ul> <li> <p>TOP: Top movers computation.</p> </li> <li> <p>BOTTOM: Bottom movers computation.</p> </li> </ul>"
}
},
"documentation":"<p>The top movers and bottom movers computation setup.</p>"
},
"TopBottomMoversComputationMoverSize":{
"type":"integer",
"max":20,
"min":1
},
"TopBottomRankedComputation":{
"type":"structure",
"required":[
"ComputationId",
"Category",
"Type"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Category":{
"shape":"DimensionField",
"documentation":"<p>The category field that is used in a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
},
"ResultSize":{
"shape":"TopBottomRankedComputationResultSize",
"documentation":"<p>The result size of a top and bottom ranked computation.</p>"
},
"Type":{
"shape":"TopBottomComputationType",
"documentation":"<p>The computation type. Choose one of the following options:</p> <ul> <li> <p>TOP: A top ranked computation.</p> </li> <li> <p>BOTTOM: A bottom ranked computation.</p> </li> </ul>"
}
},
"documentation":"<p>The top ranked and bottom ranked computation configuration.</p>"
},
"TopBottomRankedComputationResultSize":{
"type":"integer",
"max":20,
"min":1
},
"TopBottomSortOrder":{
"type":"string",
"enum":[
"PERCENT_DIFFERENCE",
"ABSOLUTE_DIFFERENCE"
]
},
"TotalAggregationComputation":{
"type":"structure",
"required":[
"ComputationId",
"Value"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Value":{
"shape":"MeasureField",
"documentation":"<p>The value field that is used in a computation.</p>"
}
},
"documentation":"<p>The total aggregation computation configuration.</p>"
},
"TotalOptions":{
"type":"structure",
"members":{
"TotalsVisibility":{
"shape":"Visibility",
"documentation":"<p>The visibility configuration for the total cells.</p>"
},
"Placement":{
"shape":"TableTotalsPlacement",
"documentation":"<p>The placement (start, end) for the total cells.</p>"
},
"ScrollStatus":{
"shape":"TableTotalsScrollStatus",
"documentation":"<p>The scroll status (pinned, scrolled) for the total cells.</p>"
},
"CustomLabel":{
"shape":"String",
"documentation":"<p>The custom label string for the total cells.</p>"
},
"TotalCellStyle":{
"shape":"TableCellStyle",
"documentation":"<p>Cell styling options for the total cells.</p>"
}
},
"documentation":"<p>The total options for a table visual.</p>"
},
"TransformOperation":{
"type":"structure",
"members":{
"ProjectOperation":{
"shape":"ProjectOperation",
"documentation":"<p>An operation that projects columns. Operations that come after a projection can only refer to projected columns.</p>"
},
"FilterOperation":{
"shape":"FilterOperation",
"documentation":"<p>An operation that filters rows based on some condition.</p>"
},
"CreateColumnsOperation":{
"shape":"CreateColumnsOperation",
"documentation":"<p>An operation that creates calculated columns. Columns created in one such operation form a lexical closure.</p>"
},
"RenameColumnOperation":{
"shape":"RenameColumnOperation",
"documentation":"<p>An operation that renames a column.</p>"
},
"CastColumnTypeOperation":{
"shape":"CastColumnTypeOperation",
"documentation":"<p>A transform operation that casts a column to a different type.</p>"
},
"TagColumnOperation":{
"shape":"TagColumnOperation",
"documentation":"<p>An operation that tags a column with additional information.</p>"
},
"UntagColumnOperation":{"shape":"UntagColumnOperation"}
},
"documentation":"<p>A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"TransformOperationList":{
"type":"list",
"member":{"shape":"TransformOperation"},
"max":2048,
"min":1
},
"TreeMapAggregatedFieldWells":{
"type":"structure",
"members":{
"Groups":{
"shape":"TreeMapDimensionFieldList",
"documentation":"<p>The group by field well of a tree map. Values are grouped based on group by fields.</p>"
},
"Sizes":{
"shape":"TreeMapMeasureFieldList",
"documentation":"<p>The size field well of a tree map. Values are aggregated based on group by fields.</p>"
},
"Colors":{
"shape":"TreeMapMeasureFieldList",
"documentation":"<p>The color field well of a tree map. Values are grouped by aggregations based on group by fields.</p>"
}
},
"documentation":"<p>Aggregated field wells of a tree map.</p>"
},
"TreeMapConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"TreeMapFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"TreeMapSortConfiguration",
"documentation":"<p>The sort configuration of a tree map.</p>"
},
"GroupLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility) of the groups that are displayed in a tree map.</p>"
},
"SizeLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility) of the sizes that are displayed in a tree map.</p>"
},
"ColorLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility) for the colors displayed in a tree map.</p>"
},
"ColorScale":{
"shape":"ColorScale",
"documentation":"<p>The color options (gradient color, point of divergence) of a tree map.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend display setup of the visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The options that determine if visual data labels are displayed.</p>"
},
"Tooltip":{
"shape":"TooltipOptions",
"documentation":"<p>The tooltip display setup of the visual.</p>"
}
},
"documentation":"<p>The configuration of a tree map.</p>"
},
"TreeMapDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":1
},
"TreeMapFieldWells":{
"type":"structure",
"members":{
"TreeMapAggregatedFieldWells":{
"shape":"TreeMapAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a tree map.</p>"
}
},
"documentation":"<p>The field wells of a tree map.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"TreeMapMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"TreeMapSortConfiguration":{
"type":"structure",
"members":{
"TreeMapSort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of group by fields.</p>"
},
"TreeMapGroupItemsLimitConfiguration":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of groups that are displayed.</p>"
}
},
"documentation":"<p>The sort configuration of a tree map.</p>"
},
"TreeMapVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"TreeMapConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A tree map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html\">Using tree maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"TrendArrowOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the trend arrows.</p>"
}
},
"documentation":"<p>The options that determine the presentation of trend arrows in a KPI visual.</p>"
},
"TwitterParameters":{
"type":"structure",
"required":[
"Query",
"MaxRows"
],
"members":{
"Query":{
"shape":"Query",
"documentation":"<p>Twitter query string.</p>"
},
"MaxRows":{
"shape":"PositiveInteger",
"documentation":"<p>Maximum number of rows to query Twitter.</p>"
}
},
"documentation":"<p>The parameters for Twitter.</p>"
},
"TypeCastFormat":{
"type":"string",
"max":32
},
"Typography":{
"type":"structure",
"members":{
"FontFamilies":{
"shape":"FontList",
"documentation":"<p>Determines the list of font families.</p>"
}
},
"documentation":"<p>Determines the typography options.</p>"
},
"UIColorPalette":{
"type":"structure",
"members":{
"PrimaryForeground":{
"shape":"HexColor",
"documentation":"<p>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.</p>"
},
"PrimaryBackground":{
"shape":"HexColor",
"documentation":"<p>The background color that applies to visuals and other high emphasis UI.</p>"
},
"SecondaryForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.</p>"
},
"SecondaryBackground":{
"shape":"HexColor",
"documentation":"<p>The background color that applies to the sheet background and sheet controls.</p>"
},
"Accent":{
"shape":"HexColor",
"documentation":"<p>This color is that applies to selected states and buttons.</p>"
},
"AccentForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the accent color.</p>"
},
"Danger":{
"shape":"HexColor",
"documentation":"<p>The color that applies to error messages.</p>"
},
"DangerForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the error color.</p>"
},
"Warning":{
"shape":"HexColor",
"documentation":"<p>This color that applies to warning and informational messages.</p>"
},
"WarningForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the warning color.</p>"
},
"Success":{
"shape":"HexColor",
"documentation":"<p>The color that applies to success messages, for example the check mark for a successful download.</p>"
},
"SuccessForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the success color.</p>"
},
"Dimension":{
"shape":"HexColor",
"documentation":"<p>The color that applies to the names of fields that are identified as dimensions.</p>"
},
"DimensionForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the dimension color.</p>"
},
"Measure":{
"shape":"HexColor",
"documentation":"<p>The color that applies to the names of fields that are identified as measures.</p>"
},
"MeasureForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the measure color.</p>"
}
},
"documentation":"<p>The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i> </p>"
},
"URLOperationTemplate":{
"type":"string",
"max":2048,
"min":1
},
"URLTargetConfiguration":{
"type":"string",
"enum":[
"NEW_TAB",
"NEW_WINDOW",
"SAME_TAB"
]
},
"UnaggregatedField":{
"type":"structure",
"required":[
"FieldId",
"Column"
],
"members":{
"FieldId":{
"shape":"FieldId",
"documentation":"<p>The custom field ID.</p>"
},
"Column":{
"shape":"ColumnIdentifier",
"documentation":"<p>The column that is used in the <code>UnaggregatedField</code>.</p>"
},
"FormatConfiguration":{
"shape":"FormatConfiguration",
"documentation":"<p>The format configuration of the field.</p>"
}
},
"documentation":"<p>The unaggregated field for a table.</p>"
},
"UnaggregatedFieldList":{
"type":"list",
"member":{"shape":"UnaggregatedField"},
"max":200
},
"UnicodeIcon":{
"type":"string",
"pattern":"^[^\\u0000-\\u00FF]$"
},
"UniqueValuesComputation":{
"type":"structure",
"required":[
"ComputationId",
"Category"
],
"members":{
"ComputationId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for a computation.</p>"
},
"Name":{
"shape":"String",
"documentation":"<p>The name of a computation.</p>"
},
"Category":{
"shape":"DimensionField",
"documentation":"<p>The category field that is used in a computation.</p>"
}
},
"documentation":"<p>The unique values computation configuration.</p>"
},
"UnlimitedPixelLength":{
"type":"string",
"documentation":"String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value"
},
"UnsupportedPricingPlanException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your Amazon Web Services account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You can do this on the <b>Manage Amazon QuickSight</b> page. </p> <p>After capacity pricing is added, you can use the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_GetDashboardEmbedUrl.html\">GetDashboardEmbedUrl</a> </code> API operation with the <code>--identity-type ANONYMOUS</code> option.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"UnsupportedUserEditionException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this request.</p>"
}
},
"documentation":"<p>This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>",
"error":{"httpStatusCode":403},
"exception":true
},
"UntagColumnOperation":{
"type":"structure",
"required":[
"ColumnName",
"TagNames"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>The column that this operation acts on.</p>"
},
"TagNames":{
"shape":"ColumnTagNames",
"documentation":"<p>The column tags to remove from this column.</p>"
}
},
"documentation":"<p>A transform operation that removes tags associated with a column.</p>"
},
"UntagResourceRequest":{
"type":"structure",
"required":[
"ResourceArn",
"TagKeys"
],
"members":{
"ResourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource that you want to untag.</p>",
"location":"uri",
"locationName":"ResourceArn"
},
"TagKeys":{
"shape":"TagKeyList",
"documentation":"<p>The keys of the key-value pairs for the resource tag or tags assigned to the resource.</p>",
"location":"querystring",
"locationName":"keys"
}
}
},
"UntagResourceResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAccountCustomizationRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AccountCustomization"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to update Amazon QuickSight customizations for.</p>",
"location":"querystring",
"locationName":"namespace"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>"
}
}
},
"UpdateAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the customization that you're updating.</p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAccountSettingsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DefaultNamespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DefaultNamespace":{
"shape":"Namespace",
"documentation":"<p>The default namespace for this Amazon Web Services account. Currently, the default is <code>default</code>. 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. </p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.</p>"
},
"TerminationProtectionEnabled":{
"shape":"Boolean",
"documentation":"<p>A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A <code>True</code> value doesn't allow the account to be deleted and results in an error message if a user tries to make a <code>DeleteAccountSubscription</code> request. A <code>False</code> value will allow the account to be deleted.</p>"
}
}
},
"UpdateAccountSettingsResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAnalysisPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A structure that describes the permissions to add and the principal to add them to.</p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A structure that describes the permissions to remove and the principal to remove them from.</p>"
}
}
},
"UpdateAnalysisPermissionsResponse":{
"type":"structure",
"members":{
"AnalysisArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis that you updated.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you updated permissions for.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the analysis that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>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. </p>"
},
"SourceEntity":{
"shape":"AnalysisSourceEntity",
"documentation":"<p>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.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>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.</p>"
},
"Definition":{
"shape":"AnalysisDefinition",
"documentation":"<p>The definition of an analysis.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"UpdateAnalysisResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the analysis that you're updating.</p>"
},
"AnalysisId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the analysis.</p>"
},
"UpdateStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The update status of the last update that was made to the analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateDashboardPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>The permissions that you want to grant on this resource.</p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>The permissions that you want to revoke from this resource.</p>"
},
"GrantLinkPermissions":{
"shape":"UpdateLinkPermissionList",
"documentation":"<p>Grants link permissions to all users in a defined namespace.</p>"
},
"RevokeLinkPermissions":{
"shape":"UpdateLinkPermissionList",
"documentation":"<p>Revokes link permissions from all users in a defined namespace.</p>"
}
}
},
"UpdateDashboardPermissionsResponse":{
"type":"structure",
"members":{
"DashboardArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>Information about the permissions on the dashboard.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"LinkSharingConfiguration":{
"shape":"LinkSharingConfiguration",
"documentation":"<p>Updates the permissions of a shared link to an Amazon QuickSight dashboard.</p>"
}
}
},
"UpdateDashboardPublishedVersionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId",
"VersionNumber"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the dashboard.</p>",
"location":"uri",
"locationName":"VersionNumber"
}
}
},
"UpdateDashboardPublishedVersionResponse":{
"type":"structure",
"members":{
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"DashboardArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateDashboardRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the dashboard that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"Name":{
"shape":"DashboardName",
"documentation":"<p>The display name of the dashboard.</p>"
},
"SourceEntity":{
"shape":"DashboardSourceEntity",
"documentation":"<p>The entity that you are using as a source when you update the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_CreateTemplate.html\">CreateTemplate</a> </code> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>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.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description for the first version of the dashboard being created.</p>"
},
"DashboardPublishOptions":{
"shape":"DashboardPublishOptions",
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>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.</p>"
},
"Definition":{
"shape":"DashboardVersionDefinition",
"documentation":"<p>The definition of a dashboard.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"UpdateDashboardResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The ARN of the dashboard, including the version number.</p>"
},
"DashboardId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The creation status of the request.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateDataSetPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"GrantPermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The resource permissions that you want to grant to the dataset.</p>"
},
"RevokePermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The resource permissions that you want to revoke from the dataset.</p>"
}
}
},
"UpdateDataSetPermissionsResponse":{
"type":"structure",
"members":{
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId",
"Name",
"PhysicalTableMap",
"ImportMode"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>The display name for the dataset.</p>"
},
"PhysicalTableMap":{
"shape":"PhysicalTableMap",
"documentation":"<p>Declares the physical tables that are available in the underlying data sources.</p>"
},
"LogicalTableMap":{
"shape":"LogicalTableMap",
"documentation":"<p>Configures the combination and transformation of the data from the physical tables.</p>"
},
"ImportMode":{
"shape":"DataSetImportMode",
"documentation":"<p>Indicates whether you want to import the data into SPICE.</p>"
},
"ColumnGroups":{
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
},
"FieldFolders":{
"shape":"FieldFolderMap",
"documentation":"<p>The folder that contains fields and nested subfolders for your dataset.</p>"
},
"RowLevelPermissionDataSet":{
"shape":"RowLevelPermissionDataSet",
"documentation":"<p>The row-level security configuration for the data you want to create.</p>"
},
"RowLevelPermissionTagConfiguration":{
"shape":"RowLevelPermissionTagConfiguration",
"documentation":"<p>The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.</p>"
},
"ColumnLevelPermissionRules":{
"shape":"ColumnLevelPermissionRuleList",
"documentation":"<p>A set of one or more definitions of a <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_ColumnLevelPermissionRule.html\">ColumnLevelPermissionRule</a> </code>.</p>"
},
"DataSetUsageConfiguration":{"shape":"DataSetUsageConfiguration"}
}
},
"UpdateDataSetResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>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.</p>"
},
"IngestionArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>"
},
"IngestionId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateDataSourcePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>",
"location":"uri",
"locationName":"DataSourceId"
},
"GrantPermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions that you want to grant on the data source.</p>"
},
"RevokePermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions that you want to revoke on the data source.</p>"
}
}
},
"UpdateDataSourcePermissionsResponse":{
"type":"structure",
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account. </p>",
"location":"uri",
"locationName":"DataSourceId"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the data source.</p>"
},
"DataSourceParameters":{
"shape":"DataSourceParameters",
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying source.</p>"
},
"Credentials":{
"shape":"DataSourceCredentials",
"documentation":"<p>The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.</p>"
},
"VpcConnectionProperties":{
"shape":"VpcConnectionProperties",
"documentation":"<p>Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.</p>"
}
}
},
"UpdateDataSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.</p>"
},
"UpdateStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The update status of the data source's last update.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateFolderPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder to update.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
},
"GrantPermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The permissions that you want to grant on a resource.</p>"
},
"RevokePermissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The permissions that you want to revoke from a resource.</p>"
}
}
},
"UpdateFolderPermissionsResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the folder.</p>"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>Information about the permissions for the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateFolderRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"FolderId",
"Name"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the Amazon Web Services account that contains the folder to update.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>",
"location":"uri",
"locationName":"FolderId"
},
"Name":{
"shape":"FolderName",
"documentation":"<p>The name of the folder.</p>"
}
}
},
"UpdateFolderResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the folder.</p>"
},
"FolderId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the folder.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to update.</p>",
"location":"uri",
"locationName":"GroupName"
},
"Description":{
"shape":"GroupDescription",
"documentation":"<p>The description for the group that you want to update.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the group that you want to update.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"UpdateGroupResponse":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The name of the group.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the IAM policy assignment. </p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment, also called a rule. This name must be unique within an Amazon Web Services account.</p>",
"location":"uri",
"locationName":"AssignmentName"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The Amazon QuickSight users, groups, or both that you want to assign the policy to.</p>"
}
}
},
"UpdateIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment or rule.</p>"
},
"AssignmentId":{
"shape":"String",
"documentation":"<p>The ID of the assignment.</p>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateIpRestrictionRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the IP rules.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"IpRestrictionRuleMap":{
"shape":"IpRestrictionRuleMap",
"documentation":"<p>A map that describes the updated IP rules with CIDR ranges and descriptions.</p>"
},
"Enabled":{
"shape":"NullableBoolean",
"documentation":"<p>A value that specifies whether IP rules are turned on.</p>"
}
}
},
"UpdateIpRestrictionResponse":{
"type":"structure",
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the IP rules.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request. </p>",
"location":"statusCode"
}
}
},
"UpdateLinkPermissionList":{
"type":"list",
"member":{"shape":"ResourcePermission"},
"max":2
},
"UpdatePublicSharingSettingsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The Amazon Web Services account ID associated with your Amazon QuickSight subscription.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"PublicSharingEnabled":{
"shape":"Boolean",
"documentation":"<p>A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.</p>"
}
}
},
"UpdatePublicSharingSettingsResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateResourcePermissionList":{
"type":"list",
"member":{"shape":"ResourcePermission"},
"max":100
},
"UpdateTemplateAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId",
"AliasName",
"TemplateVersionNumber"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template alias that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>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 <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"uri",
"locationName":"AliasName"
},
"TemplateVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template.</p>"
}
}
},
"UpdateTemplateAliasResponse":{
"type":"structure",
"members":{
"TemplateAlias":{
"shape":"TemplateAlias",
"documentation":"<p>The template alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateTemplatePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be granted on the template. </p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be revoked from the template. </p>"
}
}
},
"UpdateTemplatePermissionsResponse":{
"type":"structure",
"members":{
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>"
},
"TemplateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions to be set on the template.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"SourceEntity":{
"shape":"TemplateSourceEntity",
"documentation":"<p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>The name for the template.</p>"
},
"Definition":{
"shape":"TemplateVersionDefinition",
"documentation":"<p>The definition of a template.</p> <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>"
}
}
},
"UpdateTemplateResponse":{
"type":"structure",
"members":{
"TemplateId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the template.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the template, including the version information of the first version.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The creation status of the template.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateThemeAliasRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"AliasName",
"ThemeVersionNumber"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme alias that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name of the theme alias that you want to update.</p>",
"location":"uri",
"locationName":"AliasName"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme that the alias should reference.</p>"
}
}
},
"UpdateThemeAliasResponse":{
"type":"structure",
"members":{
"ThemeAlias":{
"shape":"ThemeAlias",
"documentation":"<p>Information about the theme alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateThemePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be granted for the theme.</p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be revoked from the theme.</p>"
}
}
},
"UpdateThemePermissionsResponse":{
"type":"structure",
"members":{
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The resulting list of resource permissions for the theme.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"BaseThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the Amazon Web Services account that contains the theme that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>The name for the theme.</p>"
},
"BaseThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the theme version that you're updating Every time that you call <code>UpdateTheme</code>, you create a new version of the theme. Each version of the theme maintains a description of the version in <code>VersionDescription</code>.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
}
}
},
"UpdateThemeResponse":{
"type":"structure",
"members":{
"ThemeId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the new version of the theme.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The creation status of the theme.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
}
}
},
"UpdateUserRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace",
"Email",
"Role"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The Amazon QuickSight user name that you want to update.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>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.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"Email":{
"shape":"String",
"documentation":"<p>The email address of the user that you want to update.</p>"
},
"Role":{
"shape":"UserRole",
"documentation":"<p>The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> </ul> <p>The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.</p>"
},
"CustomPermissionsName":{
"shape":"RoleName",
"documentation":"<p>(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:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>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 <code>RegisterUser</code> API operation to assign the named set of permissions to a Amazon QuickSight user. </p> <p>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).</p> <p>This feature is available only to Amazon QuickSight Enterprise edition subscriptions.</p>"
},
"UnapplyCustomPermissions":{
"shape":"Boolean",
"documentation":"<p>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.</p>"
},
"ExternalLoginFederationProviderType":{
"shape":"String",
"documentation":"<p>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.</p> <ul> <li> <p> <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the <code>COGNITO</code> provider type, dont use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.</p> </li> <li> <p> <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider. When choosing <code>CUSTOM_OIDC</code> type, use the <code>CustomFederationProviderUrl</code> parameter to provide the custom OIDC provider URL.</p> </li> <li> <p> <code>NONE</code>: This clears all the previously saved external login information for a user. Use the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html\">DescribeUser</a> </code> API operation to check the external login information.</p> </li> </ul>"
},
"CustomFederationProviderUrl":{
"shape":"String",
"documentation":"<p>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 <code>ExternalLoginFederationProviderType</code> parameter is set to <code>CUSTOM_OIDC</code>.</p>"
},
"ExternalLoginId":{
"shape":"String",
"documentation":"<p>The identity ID for a user in the external login provider.</p>"
}
}
},
"UpdateUserResponse":{
"type":"structure",
"members":{
"User":{
"shape":"User",
"documentation":"<p>The Amazon QuickSight user.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The Amazon Web Services request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UploadSettings":{
"type":"structure",
"members":{
"Format":{
"shape":"FileFormat",
"documentation":"<p>File format.</p>"
},
"StartFromRow":{
"shape":"PositiveInteger",
"documentation":"<p>A row number to start reading data from.</p>",
"box":true
},
"ContainsHeader":{
"shape":"Boolean",
"documentation":"<p>Whether the file has a header row, or the files each have a header row.</p>",
"box":true
},
"TextQualifier":{
"shape":"TextQualifier",
"documentation":"<p>Text qualifier.</p>"
},
"Delimiter":{
"shape":"Delimiter",
"documentation":"<p>The delimiter between values in the file.</p>"
}
},
"documentation":"<p>Information about the format for a source file or files.</p>"
},
"User":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the user.</p>"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>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 <code>UserName</code> is <code>N/A</code> when the value for <code>IdentityType</code> is <code>IAM</code> and the corresponding IAM user is deleted.</p>"
},
"Email":{
"shape":"String",
"documentation":"<p>The user's email address.</p>"
},
"Role":{
"shape":"UserRole",
"documentation":"<p>The Amazon QuickSight role for the user. The user role can be one of the following:.</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon Amazon QuickSight settings.</p> </li> <li> <p> <code>RESTRICTED_READER</code>: This role isn't currently available for use.</p> </li> <li> <p> <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p> </li> </ul>"
},
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>The type of identity authentication used by the user.</p>"
},
"Active":{
"shape":"Boolean",
"documentation":"<p>The active status of user. When you create an Amazon QuickSight user thats not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.</p>"
},
"PrincipalId":{
"shape":"String",
"documentation":"<p>The principal ID of the user.</p>"
},
"CustomPermissionsName":{
"shape":"RoleName",
"documentation":"<p>The custom permissions profile associated with this user.</p>"
},
"ExternalLoginFederationProviderType":{
"shape":"String",
"documentation":"<p>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.</p> <ul> <li> <p> <code>COGNITO</code>: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.</p> </li> <li> <p> <code>CUSTOM_OIDC</code>: Custom OpenID Connect (OIDC) provider.</p> </li> </ul>"
},
"ExternalLoginFederationProviderUrl":{
"shape":"String",
"documentation":"<p>The URL of the external login provider.</p>"
},
"ExternalLoginId":{
"shape":"String",
"documentation":"<p>The identity ID for the user in the external login provider.</p>"
}
},
"documentation":"<p>A registered user of Amazon QuickSight. </p>"
},
"UserList":{
"type":"list",
"member":{"shape":"User"}
},
"UserName":{
"type":"string",
"min":1,
"pattern":"[\\u0020-\\u00FF]+"
},
"UserRole":{
"type":"string",
"enum":[
"ADMIN",
"AUTHOR",
"READER",
"RESTRICTED_AUTHOR",
"RESTRICTED_READER"
]
},
"Username":{
"type":"string",
"max":64,
"min":1
},
"ValueWhenUnsetOption":{
"type":"string",
"enum":[
"RECOMMENDED_VALUE",
"NULL"
]
},
"VersionDescription":{
"type":"string",
"max":512,
"min":1
},
"VersionNumber":{
"type":"long",
"min":1
},
"VerticalTextAlignment":{
"type":"string",
"enum":[
"TOP",
"MIDDLE",
"BOTTOM"
]
},
"Visibility":{
"type":"string",
"enum":[
"HIDDEN",
"VISIBLE"
]
},
"VisiblePanelColumns":{
"type":"long",
"max":10,
"min":1
},
"VisiblePanelRows":{
"type":"long",
"max":10,
"min":1
},
"VisibleRangeOptions":{
"type":"structure",
"members":{
"PercentRange":{
"shape":"PercentVisibleRange",
"documentation":"<p>The percent range in the visible range.</p>"
}
},
"documentation":"<p>The range options for the data zoom scroll bar.</p>"
},
"Visual":{
"type":"structure",
"members":{
"TableVisual":{
"shape":"TableVisual",
"documentation":"<p>A table visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/tabular.html\">Using tables as visuals</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"PivotTableVisual":{
"shape":"PivotTableVisual",
"documentation":"<p>A pivot table.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/pivot-table.html\">Using pivot tables</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"BarChartVisual":{
"shape":"BarChartVisual",
"documentation":"<p>A bar chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/bar-charts.html\">Using bar charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"KPIVisual":{
"shape":"KPIVisual",
"documentation":"<p>A key performance indicator (KPI).</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/kpi.html\">Using KPIs</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"PieChartVisual":{
"shape":"PieChartVisual",
"documentation":"<p>A pie or donut chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/pie-chart.html\">Using pie charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"GaugeChartVisual":{
"shape":"GaugeChartVisual",
"documentation":"<p>A gauge chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/gauge-chart.html\">Using gauge charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"LineChartVisual":{
"shape":"LineChartVisual",
"documentation":"<p>A line chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/line-charts.html\">Using line charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"HeatMapVisual":{
"shape":"HeatMapVisual",
"documentation":"<p>A heat map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/heat-map.html\">Using heat maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"TreeMapVisual":{
"shape":"TreeMapVisual",
"documentation":"<p>A tree map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/tree-map.html\">Using tree maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"GeospatialMapVisual":{
"shape":"GeospatialMapVisual",
"documentation":"<p>A geospatial map or a points on map visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/point-maps.html\">Creating point maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FilledMapVisual":{
"shape":"FilledMapVisual",
"documentation":"<p>A filled map.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/filled-maps.html\">Creating filled maps</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"FunnelChartVisual":{
"shape":"FunnelChartVisual",
"documentation":"<p>A funnel chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/funnel-visual-content.html\">Using funnel charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ScatterPlotVisual":{
"shape":"ScatterPlotVisual",
"documentation":"<p>A scatter plot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/scatter-plot.html\">Using scatter plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"ComboChartVisual":{
"shape":"ComboChartVisual",
"documentation":"<p>A combo chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/combo-charts.html\">Using combo charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"BoxPlotVisual":{
"shape":"BoxPlotVisual",
"documentation":"<p>A box plot.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/box-plots.html\">Using box plots</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"WaterfallVisual":{
"shape":"WaterfallVisual",
"documentation":"<p>A waterfall chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html\">Using waterfall charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"HistogramVisual":{
"shape":"HistogramVisual",
"documentation":"<p>A histogram.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/histogram-charts.html\">Using histograms</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"WordCloudVisual":{
"shape":"WordCloudVisual",
"documentation":"<p>A word cloud.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html\">Using word clouds</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"InsightVisual":{
"shape":"InsightVisual",
"documentation":"<p>An insight visual.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/computational-insights.html\">Working with insights</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"SankeyDiagramVisual":{
"shape":"SankeyDiagramVisual",
"documentation":"<p>A sankey diagram.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/sankey-diagram.html\">Using Sankey diagrams</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"CustomContentVisual":{
"shape":"CustomContentVisual",
"documentation":"<p>A visual that contains custom content.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/custom-visual-content.html\">Using custom visual content</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"EmptyVisual":{
"shape":"EmptyVisual",
"documentation":"<p>An empty visual.</p>"
}
},
"documentation":"<p>A visual displayed on a sheet in an analysis, dashboard, or template.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"VisualCustomAction":{
"type":"structure",
"required":[
"CustomActionId",
"Name",
"Trigger",
"ActionOperations"
],
"members":{
"CustomActionId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The ID of the <code>VisualCustomAction</code>.</p>"
},
"Name":{
"shape":"VisualCustomActionName",
"documentation":"<p>The name of the <code>VisualCustomAction</code>.</p>"
},
"Status":{
"shape":"WidgetStatus",
"documentation":"<p>The status of the <code>VisualCustomAction</code>.</p>"
},
"Trigger":{
"shape":"VisualCustomActionTrigger",
"documentation":"<p>The trigger of the <code>VisualCustomAction</code>.</p> <p>Valid values are defined as follows:</p> <ul> <li> <p> <code>DATA_POINT_CLICK</code>: Initiates a custom action by a left pointer click on a data point.</p> </li> <li> <p> <code>DATA_POINT_MENU</code>: Initiates a custom action by right pointer click from the menu.</p> </li> </ul>"
},
"ActionOperations":{
"shape":"VisualCustomActionOperationList",
"documentation":"<p>A list of <code>VisualCustomActionOperations</code>.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
}
},
"documentation":"<p>A custom action defined on a visual.</p>"
},
"VisualCustomActionList":{
"type":"list",
"member":{"shape":"VisualCustomAction"},
"max":10
},
"VisualCustomActionName":{
"type":"string",
"max":256,
"min":1
},
"VisualCustomActionOperation":{
"type":"structure",
"members":{
"FilterOperation":{
"shape":"CustomActionFilterOperation",
"documentation":"<p>The filter operation that filters data included in a visual or in an entire sheet.</p>"
},
"NavigationOperation":{
"shape":"CustomActionNavigationOperation",
"documentation":"<p>The navigation operation that navigates between different sheets in the same analysis.</p>"
},
"URLOperation":{
"shape":"CustomActionURLOperation",
"documentation":"<p>The URL operation that opens a link to another webpage.</p>"
},
"SetParametersOperation":{
"shape":"CustomActionSetParametersOperation",
"documentation":"<p>The set parameter operation that sets parameters in custom action.</p>"
}
},
"documentation":"<p>The operation that is defined by the custom action.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"VisualCustomActionOperationList":{
"type":"list",
"member":{"shape":"VisualCustomActionOperation"},
"max":2,
"min":1
},
"VisualCustomActionTrigger":{
"type":"string",
"enum":[
"DATA_POINT_CLICK",
"DATA_POINT_MENU"
]
},
"VisualList":{
"type":"list",
"member":{"shape":"Visual"},
"max":30
},
"VisualPalette":{
"type":"structure",
"members":{
"ChartColor":{
"shape":"HexColor",
"documentation":"<p>The chart color options for the visual palette.</p>"
},
"ColorMap":{
"shape":"DataPathColorList",
"documentation":"<p>The color map options for the visual palette.</p>"
}
},
"documentation":"<p>The visual display options for the visual palette.</p>"
},
"VisualSubtitleLabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the subtitle label.</p>"
},
"FormatText":{
"shape":"LongFormatText",
"documentation":"<p>The long text format of the subtitle label, such as plain text or rich text.</p>"
}
},
"documentation":"<p>The subtitle label options for a visual.</p>"
},
"VisualTitleLabelOptions":{
"type":"structure",
"members":{
"Visibility":{
"shape":"Visibility",
"documentation":"<p>The visibility of the title label.</p>"
},
"FormatText":{
"shape":"ShortFormatText",
"documentation":"<p>The short text format of the title label, such as plain text or rich text.</p>"
}
},
"documentation":"<p>The title label options for a visual.</p>"
},
"VpcConnectionProperties":{
"type":"structure",
"required":["VpcConnectionArn"],
"members":{
"VpcConnectionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the VPC connection.</p>"
}
},
"documentation":"<p>VPC connection properties.</p>"
},
"Warehouse":{
"type":"string",
"max":128
},
"WaterfallChartAggregatedFieldWells":{
"type":"structure",
"members":{
"Categories":{
"shape":"DimensionFieldList",
"documentation":"<p>The category field wells of a waterfall visual.</p>"
},
"Values":{
"shape":"MeasureFieldList",
"documentation":"<p>The value field wells of a waterfall visual.</p>"
},
"Breakdowns":{
"shape":"DimensionFieldList",
"documentation":"<p>The breakdown field wells of a waterfall visual.</p>"
}
},
"documentation":"<p>The field well configuration of a waterfall visual.</p>"
},
"WaterfallChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"WaterfallChartFieldWells",
"documentation":"<p>The field well configuration of a waterfall visual.</p>"
},
"SortConfiguration":{
"shape":"WaterfallChartSortConfiguration",
"documentation":"<p>The sort configuration of a waterfall visual.</p>"
},
"WaterfallChartOptions":{
"shape":"WaterfallChartOptions",
"documentation":"<p>The options that determine the presentation of a waterfall visual.</p>"
},
"CategoryAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the category axis label.</p>"
},
"CategoryAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the category axis.</p>"
},
"PrimaryYAxisLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The options that determine the presentation of the y-axis label.</p>"
},
"PrimaryYAxisDisplayOptions":{
"shape":"AxisDisplayOptions",
"documentation":"<p>The options that determine the presentation of the y-axis.</p>"
},
"Legend":{
"shape":"LegendOptions",
"documentation":"<p>The legend configuration of a waterfall visual.</p>"
},
"DataLabels":{
"shape":"DataLabelOptions",
"documentation":"<p>The data label configuration of a waterfall visual.</p>"
},
"VisualPalette":{
"shape":"VisualPalette",
"documentation":"<p>The visual palette configuration of a waterfall visual.</p>"
}
},
"documentation":"<p>The configuration for a waterfall visual.</p>"
},
"WaterfallChartFieldWells":{
"type":"structure",
"members":{
"WaterfallChartAggregatedFieldWells":{
"shape":"WaterfallChartAggregatedFieldWells",
"documentation":"<p>The field well configuration of a waterfall visual.</p>"
}
},
"documentation":"<p>The field well configuration of a waterfall visual.</p>"
},
"WaterfallChartOptions":{
"type":"structure",
"members":{
"TotalBarLabel":{
"shape":"String",
"documentation":"<p>This option determines the total bar label of a waterfall visual.</p>"
}
},
"documentation":"<p>The options that determine the presentation of a waterfall visual.</p>"
},
"WaterfallChartSortConfiguration":{
"type":"structure",
"members":{
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of the category fields.</p>"
},
"BreakdownItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of bar groups that are displayed.</p>"
}
},
"documentation":"<p>The sort configuration of a waterfall visual.</p>"
},
"WaterfallVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"WaterfallChartConfiguration",
"documentation":"<p>The configuration for a waterfall visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A waterfall chart.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/waterfall-chart.html\">Using waterfall charts</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"WhatIfPointScenario":{
"type":"structure",
"required":[
"Date",
"Value"
],
"members":{
"Date":{
"shape":"Timestamp",
"documentation":"<p>The date that you need the forecast results for.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The target value that you want to meet for the provided date.</p>"
}
},
"documentation":"<p>Provides the forecast to meet the target for a particular date.</p>"
},
"WhatIfRangeScenario":{
"type":"structure",
"required":[
"StartDate",
"EndDate",
"Value"
],
"members":{
"StartDate":{
"shape":"Timestamp",
"documentation":"<p>The start date in the date range that you need the forecast results for.</p>"
},
"EndDate":{
"shape":"Timestamp",
"documentation":"<p>The end date in the date range that you need the forecast results for.</p>"
},
"Value":{
"shape":"Double",
"documentation":"<p>The target value that you want to meet for the provided date range.</p>"
}
},
"documentation":"<p>Provides the forecast to meet the target for a particular date range.</p>"
},
"WidgetStatus":{
"type":"string",
"enum":[
"ENABLED",
"DISABLED"
]
},
"WordCloudAggregatedFieldWells":{
"type":"structure",
"members":{
"GroupBy":{
"shape":"WordCloudDimensionFieldList",
"documentation":"<p>The group by field well of a word cloud. Values are grouped by group by fields.</p>"
},
"Size":{
"shape":"WordCloudMeasureFieldList",
"documentation":"<p>The size field well of a word cloud. Values are aggregated based on group by fields.</p>"
}
},
"documentation":"<p>The aggregated field wells of a word cloud.</p>"
},
"WordCloudChartConfiguration":{
"type":"structure",
"members":{
"FieldWells":{
"shape":"WordCloudFieldWells",
"documentation":"<p>The field wells of the visual.</p>"
},
"SortConfiguration":{
"shape":"WordCloudSortConfiguration",
"documentation":"<p>The sort configuration of a word cloud visual.</p>"
},
"CategoryLabelOptions":{
"shape":"ChartAxisLabelOptions",
"documentation":"<p>The label options (label text, label visibility, and sort icon visibility) for the word cloud category.</p>"
},
"WordCloudOptions":{
"shape":"WordCloudOptions",
"documentation":"<p>The options for a word cloud visual.</p>"
}
},
"documentation":"<p>The configuration of a word cloud visual.</p>"
},
"WordCloudCloudLayout":{
"type":"string",
"enum":[
"FLUID",
"NORMAL"
]
},
"WordCloudDimensionFieldList":{
"type":"list",
"member":{"shape":"DimensionField"},
"max":10
},
"WordCloudFieldWells":{
"type":"structure",
"members":{
"WordCloudAggregatedFieldWells":{
"shape":"WordCloudAggregatedFieldWells",
"documentation":"<p>The aggregated field wells of a word cloud.</p>"
}
},
"documentation":"<p>The field wells of a word cloud visual.</p> <p>This is a union type structure. For this structure to be valid, only one of the attributes can be defined.</p>"
},
"WordCloudMaximumStringLength":{
"type":"integer",
"max":100,
"min":1
},
"WordCloudMeasureFieldList":{
"type":"list",
"member":{"shape":"MeasureField"},
"max":1
},
"WordCloudOptions":{
"type":"structure",
"members":{
"WordOrientation":{
"shape":"WordCloudWordOrientation",
"documentation":"<p>The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.</p>"
},
"WordScaling":{
"shape":"WordCloudWordScaling",
"documentation":"<p>The word scaling options (emphasize, normal) for the words in a word cloud.</p>"
},
"CloudLayout":{
"shape":"WordCloudCloudLayout",
"documentation":"<p>The cloud layout options (fluid, normal) of a word cloud.</p>"
},
"WordCasing":{
"shape":"WordCloudWordCasing",
"documentation":"<p>The word casing options (lower_case, existing_case) for the words in a word cloud.</p>"
},
"WordPadding":{
"shape":"WordCloudWordPadding",
"documentation":"<p>The word padding options (none, small, medium, large) for the words in a word cloud.</p>"
},
"MaximumStringLength":{
"shape":"WordCloudMaximumStringLength",
"documentation":"<p>The length limit of each word from 1-100.</p>"
}
},
"documentation":"<p>The word cloud options for a word cloud visual.</p>"
},
"WordCloudSortConfiguration":{
"type":"structure",
"members":{
"CategoryItemsLimit":{
"shape":"ItemsLimitConfiguration",
"documentation":"<p>The limit on the number of groups that are displayed in a word cloud.</p>"
},
"CategorySort":{
"shape":"FieldSortOptionsList",
"documentation":"<p>The sort configuration of group by fields.</p>"
}
},
"documentation":"<p>The sort configuration of a word cloud visual.</p>"
},
"WordCloudVisual":{
"type":"structure",
"required":["VisualId"],
"members":{
"VisualId":{
"shape":"ShortRestrictiveResourceId",
"documentation":"<p>The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..</p>"
},
"Title":{
"shape":"VisualTitleLabelOptions",
"documentation":"<p>The title that is displayed on the visual.</p>"
},
"Subtitle":{
"shape":"VisualSubtitleLabelOptions",
"documentation":"<p>The subtitle that is displayed on the visual.</p>"
},
"ChartConfiguration":{
"shape":"WordCloudChartConfiguration",
"documentation":"<p>The configuration settings of the visual.</p>"
},
"Actions":{
"shape":"VisualCustomActionList",
"documentation":"<p>The list of custom actions that are configured for a visual.</p>"
},
"ColumnHierarchies":{
"shape":"ColumnHierarchyList",
"documentation":"<p>The column hierarchy that is used during drill-downs and drill-ups.</p>"
}
},
"documentation":"<p>A word cloud.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/word-cloud.html\">Using word clouds</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
},
"WordCloudWordCasing":{
"type":"string",
"enum":[
"LOWER_CASE",
"EXISTING_CASE"
]
},
"WordCloudWordOrientation":{
"type":"string",
"enum":[
"HORIZONTAL",
"HORIZONTAL_AND_VERTICAL"
]
},
"WordCloudWordPadding":{
"type":"string",
"enum":[
"NONE",
"SMALL",
"MEDIUM",
"LARGE"
]
},
"WordCloudWordScaling":{
"type":"string",
"enum":[
"EMPHASIZE",
"NORMAL"
]
},
"WorkGroup":{
"type":"string",
"max":128,
"min":1
},
"boolean":{"type":"boolean"}
},
"documentation":"<fullname>Amazon QuickSight API Reference</fullname> <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services 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. </p>"
}