diff --git a/clients/client-quicksight/src/models/models_2.ts b/clients/client-quicksight/src/models/models_2.ts index 4514a30bc10e..900575950150 100644 --- a/clients/client-quicksight/src/models/models_2.ts +++ b/clients/client-quicksight/src/models/models_2.ts @@ -8936,6 +8936,22 @@ export const CalculatedColumnFilterSensitiveLog = (obj: CalculatedColumn): any = ...(obj.Expression && { Expression: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const ColumnDescriptionFilterSensitiveLog = (obj: ColumnDescription): any => ({ + ...obj, + ...(obj.Text && { Text: SENSITIVE_STRING }), +}); + +/** + * @internal + */ +export const ColumnTagFilterSensitiveLog = (obj: ColumnTag): any => ({ + ...obj, + ...(obj.ColumnDescription && { ColumnDescription: ColumnDescriptionFilterSensitiveLog(obj.ColumnDescription) }), +}); + /** * @internal */ @@ -9035,6 +9051,14 @@ export const FilterOperationFilterSensitiveLog = (obj: FilterOperation): any => ...(obj.ConditionExpression && { ConditionExpression: SENSITIVE_STRING }), }); +/** + * @internal + */ +export const TagColumnOperationFilterSensitiveLog = (obj: TagColumnOperation): any => ({ + ...obj, + ...(obj.Tags && { Tags: obj.Tags.map((item) => ColumnTagFilterSensitiveLog(item)) }), +}); + /** * @internal */ @@ -9046,7 +9070,8 @@ export const TransformOperationFilterSensitiveLog = (obj: TransformOperation): a return { CreateColumnsOperation: CreateColumnsOperationFilterSensitiveLog(obj.CreateColumnsOperation) }; if (obj.RenameColumnOperation !== undefined) return { RenameColumnOperation: obj.RenameColumnOperation }; if (obj.CastColumnTypeOperation !== undefined) return { CastColumnTypeOperation: obj.CastColumnTypeOperation }; - if (obj.TagColumnOperation !== undefined) return { TagColumnOperation: obj.TagColumnOperation }; + if (obj.TagColumnOperation !== undefined) + return { TagColumnOperation: TagColumnOperationFilterSensitiveLog(obj.TagColumnOperation) }; if (obj.UntagColumnOperation !== undefined) return { UntagColumnOperation: obj.UntagColumnOperation }; if (obj.OverrideDatasetParameterOperation !== undefined) return { OverrideDatasetParameterOperation: obj.OverrideDatasetParameterOperation }; diff --git a/clients/client-quicksight/src/models/models_3.ts b/clients/client-quicksight/src/models/models_3.ts index 8a04dd22eb01..509f291f16cd 100644 --- a/clients/client-quicksight/src/models/models_3.ts +++ b/clients/client-quicksight/src/models/models_3.ts @@ -9468,6 +9468,14 @@ export const CreateTopicRequestFilterSensitiveLog = (obj: CreateTopicRequest): a ...obj, }); +/** + * @internal + */ +export const OutputColumnFilterSensitiveLog = (obj: OutputColumn): any => ({ + ...obj, + ...(obj.Description && { Description: SENSITIVE_STRING }), +}); + /** * @internal */ @@ -9485,6 +9493,7 @@ export const DataSetFilterSensitiveLog = (obj: DataSet): any => ({ {} ), }), + ...(obj.OutputColumns && { OutputColumns: obj.OutputColumns.map((item) => OutputColumnFilterSensitiveLog(item)) }), ...(obj.RowLevelPermissionTagConfiguration && { RowLevelPermissionTagConfiguration: RowLevelPermissionTagConfigurationFilterSensitiveLog( obj.RowLevelPermissionTagConfiguration diff --git a/codegen/sdk-codegen/aws-models/quicksight.json b/codegen/sdk-codegen/aws-models/quicksight.json index 98db4f282c85..cd8abf695716 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.json +++ b/codegen/sdk-codegen/aws-models/quicksight.json @@ -1,56662 +1,56673 @@ { - "smithy": "2.0", - "metadata": { - "suppressions": [ - { - "id": "HttpMethodSemantics", - "namespace": "*" - }, - { - "id": "HttpResponseCodeSemantics", - "namespace": "*" - }, - { - "id": "PaginatedTrait", - "namespace": "*" - }, - { - "id": "HttpHeaderTrait", - "namespace": "*" - }, - { - "id": "HttpUriConflict", - "namespace": "*" - }, - { - "id": "Service", - "namespace": "*" - } - ] - }, - "shapes": { - "com.amazonaws.quicksight#AccessDeniedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You don't have access to this item. The provided credentials couldn't be\n\t\t\tvalidated. You might not be authorized to carry out the request. Make sure that your\n\t\t\taccount is authorized to use the Amazon QuickSight service, that your policies have the\n\t\t\tcorrect permissions, and that you are using the correct credentials.

", - "smithy.api#error": "client", - "smithy.api#httpError": 401 - } - }, - "com.amazonaws.quicksight#AccountCustomization": { - "type": "structure", - "members": { - "DefaultTheme": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The default theme for this Amazon QuickSight subscription.

" - } - }, - "DefaultEmailCustomizationTemplate": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The default email customization template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

" - } - }, - "com.amazonaws.quicksight#AccountInfo": { - "type": "structure", - "members": { - "AccountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The account name that you provided for the Amazon QuickSight subscription in your\n 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\n users sign in.

" - } - }, - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of your Amazon QuickSight account.

" - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

" - } - }, - "AuthenticationType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The way that your Amazon QuickSight account is authenticated.

" - } - }, - "AccountSubscriptionStatus": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The status of your account subscription.

" - } - }, - "IAMIdentityCenterInstanceArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n " - } - }, - "com.amazonaws.quicksight#AccountName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 62 - }, - "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" - } - }, - "com.amazonaws.quicksight#AccountSettings": { - "type": "structure", - "members": { - "AccountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" - } - }, - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" - } - }, - "DefaultNamespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The default Amazon QuickSight namespace for your Amazon Web Services account.

" - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The main notification email for your Amazon QuickSight subscription.

" - } - }, - "PublicSharingEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings associated with your Amazon Web Services account.

" - } - }, - "com.amazonaws.quicksight#ActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#ActiveIAMPolicyAssignment": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

A name for the IAM policy assignment.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The active Identity and Access Management (IAM) policy assignment.

" - } - }, - "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignment" - } - }, - "com.amazonaws.quicksight#AdHocFilteringOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

Availability status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An ad hoc (one-time) filtering option.

" - } - }, - "com.amazonaws.quicksight#AdditionalDashboardIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#AggFunction": { - "type": "structure", - "members": { - "Aggregation": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The aggregation of an Agg function.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggFunctionParamMap", - "traits": { - "smithy.api#documentation": "

The aggregation parameters for an Agg function.

" - } - }, - "Period": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The period of an Agg function.

" - } - }, - "PeriodField": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The period field for an Agg function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an Agg function.

" - } - }, - "com.amazonaws.quicksight#AggFunctionParamKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#AggFunctionParamMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#AggFunctionParamKey" - }, - "value": { - "target": "com.amazonaws.quicksight#AggFunctionParamValue" - } - }, - "com.amazonaws.quicksight#AggFunctionParamValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#AggType": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "PTD_SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_SUM" - } - }, - "PTD_MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_MIN" - } - }, - "PTD_MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_MAX" - } - }, - "PTD_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_COUNT" - } - }, - "PTD_DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_DISTINCT_COUNT" - } - }, - "PTD_AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PTD_AVERAGE" - } - }, - "COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#AggregationFunction": { - "type": "structure", - "members": { - "NumericalAggregationFunction": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for numerical values.

" - } - }, - "CategoricalAggregationFunction": { - "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for categorical values.

\n " - } - }, - "DateAggregationFunction": { - "target": "com.amazonaws.quicksight#DateAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for date values.

\n " - } - }, - "AttributeAggregationFunction": { - "target": "com.amazonaws.quicksight#AttributeAggregationFunction", - "traits": { - "smithy.api#documentation": "

Aggregation for attributes.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation function aggregates values from a dimension or measure.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AggregationFunctionParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LimitedString" - }, - "value": { - "target": "com.amazonaws.quicksight#LimitedString" - } - }, - "com.amazonaws.quicksight#AggregationPartitionBy": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The field Name for an AggregationPartitionBy.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The TimeGranularity for an AggregationPartitionBy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an AggregationPartitionBy.

" - } - }, - "com.amazonaws.quicksight#AggregationPartitionByList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AggregationPartitionBy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AggregationSortConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that determines the sort order of aggregated values.

", - "smithy.api#required": {} - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction of values.

\n ", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The function that aggregates the values in Column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration options to sort aggregated values.

" - } - }, - "com.amazonaws.quicksight#AggregationSortConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AggregationSortConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AliasName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" - } - }, - "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AmazonElasticsearchParameters": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.quicksight#Domain", - "traits": { - "smithy.api#documentation": "

The OpenSearch domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "com.amazonaws.quicksight#AmazonOpenSearchParameters": { - "type": "structure", - "members": { - "Domain": { - "target": "com.amazonaws.quicksight#Domain", - "traits": { - "smithy.api#documentation": "

The OpenSearch domain.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "com.amazonaws.quicksight#Analysis": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the analysis.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AnalysisErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the analysis.

" - } - }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", - "traits": { - "smithy.api#documentation": "

The ARNs of the datasets of the analysis.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the analysis.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was last updated.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata structure for an analysis in Amazon QuickSight

" - } - }, - "com.amazonaws.quicksight#AnalysisDefaults": { - "type": "structure", - "members": { - "DefaultNewSheetConfiguration": { - "target": "com.amazonaws.quicksight#DefaultNewSheetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for default new sheet settings.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for default analysis settings.

" - } - }, - "com.amazonaws.quicksight#AnalysisDefinition": { - "type": "structure", - "members": { - "DataSetIdentifierDeclarations": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead\n of dataset ARNs throughout analysis sub-structures.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about\n a sheet within this analysis.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the analysis.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of parameter declarations for an analysis.

\n

Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

Filter definitions for an analysis.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

\n An array of analysis-level column configurations. Column configurations can be used to set default\n formatting for a column to be used throughout an analysis.\n

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for an analysis.

" - } - }, - "QueryExecutionOptions": { - "target": "com.amazonaws.quicksight#QueryExecutionOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#AnalysisErrorType", - "traits": { - "smithy.api#documentation": "

The type of the analysis error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The message associated with the analysis error.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

Lists the violated entities that caused the analysis error

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Analysis error.

" - } - }, - "com.amazonaws.quicksight#AnalysisErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#AnalysisErrorType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "PARAMETER_VALUE_INCOMPATIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" - } - }, - "PARAMETER_TYPE_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" - } - }, - "PARAMETER_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_NOT_FOUND" - } - }, - "COLUMN_TYPE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" - } - }, - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" - } - }, - "COLUMN_REPLACEMENT_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" - } - } - } - }, - "com.amazonaws.quicksight#AnalysisFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_USER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "ANALYSIS_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYSIS_NAME" - } - } - } - }, - "com.amazonaws.quicksight#AnalysisName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#AnalysisSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"ANALYSIS_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value ANALYSIS_NAME.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example \"Value\". An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for one or more analyses.

" - } - }, - "com.amazonaws.quicksight#AnalysisSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#AnalysisSourceEntity": { - "type": "structure", - "members": { - "SourceTemplate": { - "target": "com.amazonaws.quicksight#AnalysisSourceTemplate", - "traits": { - "smithy.api#documentation": "

The source template for the source entity of the analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source entity of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSourceTemplate": { - "type": "structure", - "members": { - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

The dataset references of the source template of an analysis.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source template of an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis. This ID displays in the URL.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The name of the analysis. This name is displayed in the Amazon QuickSight console.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The last known status for the analysis.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the analysis was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary metadata that describes an analysis.

" - } - }, - "com.amazonaws.quicksight#AnalysisSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnalysisSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#Anchor": { - "type": "structure", - "members": { - "AnchorType": { - "target": "com.amazonaws.quicksight#AnchorType", - "traits": { - "smithy.api#documentation": "

The AnchorType for the Anchor.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The TimeGranularity of the Anchor.

" - } - }, - "Offset": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The offset of the Anchor.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of the Anchor.

" - } - }, - "com.amazonaws.quicksight#AnchorDateConfiguration": { - "type": "structure", - "members": { - "AnchorOption": { - "target": "com.amazonaws.quicksight#AnchorOption", - "traits": { - "smithy.api#documentation": "

The options for the date configuration. Choose one of the options below:

\n " - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is used for the anchor date configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The date configuration of the filter.

" - } - }, - "com.amazonaws.quicksight#AnchorOption": { - "type": "enum", - "members": { - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } - }, - "com.amazonaws.quicksight#AnchorType": { - "type": "enum", - "members": { - "TODAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TODAY" - } - } - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - }, - "EnabledFeatures": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures", - "traits": { - "smithy.api#documentation": "

A list of all enabled features of a specified anonymous dashboard.

" - } - }, - "DisabledFeatures": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures", - "traits": { - "smithy.api#documentation": "

A list of all disabled features of a specified anonymous dashboard.

" - } - }, - "FeatureConfigurations": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations", - "traits": { - "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the dashboard that you want to embed.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature": { - "type": "enum", - "members": { - "SHARED_VIEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED_VIEW" - } - } - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature" - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature": { - "type": "enum", - "members": { - "SHARED_VIEW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED_VIEW" - } - } - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature" - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations": { - "type": "structure", - "members": { - "SharedView": { - "target": "com.amazonaws.quicksight#SharedViewConfigurations", - "traits": { - "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardVisualId": { - "target": "com.amazonaws.quicksight#DashboardVisualId", - "traits": { - "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" - } - }, - "DashboardVisual": { - "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" - } - }, - "QSearchBar": { - "target": "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The Q search bar that you want to use for anonymous user embedding.

" - } - }, - "GenerativeQnA": { - "target": "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The Generative Q&A experience that you want to use for anonymous user embedding.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience 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 Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings that you want to use for the Generative Q&A experience.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the legacy 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 legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings that you want to use with the Q search bar.

" - } - }, - "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult": { - "type": "structure", - "members": { - "FileGroups": { - "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroupList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.\n

" - } - }, - "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult" - } - }, - "com.amazonaws.quicksight#AnswerId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" - } - }, - "com.amazonaws.quicksight#AnswerIds": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AnswerId" - } - }, - "com.amazonaws.quicksight#ArcAxisConfiguration": { - "type": "structure", - "members": { - "Range": { - "target": "com.amazonaws.quicksight#ArcAxisDisplayRange", - "traits": { - "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" - } - }, - "ReserveRange": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The reserved range of the arc axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcAxisDisplayRange": { - "type": "structure", - "members": { - "Min": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The minimum value of the arc axis range.

" - } - }, - "Max": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum value of the arc axis range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcConfiguration": { - "type": "structure", - "members": { - "ArcAngle": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The option that determines the arc angle of a GaugeChartVisual.

" - } - }, - "ArcThickness": { - "target": "com.amazonaws.quicksight#ArcThicknessOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcOptions": { - "type": "structure", - "members": { - "ArcThickness": { - "target": "com.amazonaws.quicksight#ArcThickness", - "traits": { - "smithy.api#documentation": "

The arc thickness of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#ArcThickness": { - "type": "enum", - "members": { - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - }, - "WHOLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WHOLE" - } - } - } - }, - "com.amazonaws.quicksight#ArcThicknessOptions": { - "type": "enum", - "members": { - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - } - } - }, - "com.amazonaws.quicksight#Arn": { - "type": "string" - }, - "com.amazonaws.quicksight#ArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - } - }, - "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration": { - "type": "structure", - "members": { - "ResourceIdOverrideConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

" - } - }, - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList", - "traits": { - "smithy.api#documentation": "

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional collection of CloudFormation property configurations that control how the export job is generated.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportFormat": { - "type": "enum", - "members": { - "CLOUDFORMATION_JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLOUDFORMATION_JSON" - } - }, - "QUICKSIGHT_JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_JSON" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Analysis resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific DataSet resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific DataSource resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "DISABLE_SSL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DisableSsl" - } - }, - "SECRET_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SecretArn" - } - }, - "USERNAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Username" - } - }, - "PASSWORD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Password" - } - }, - "DOMAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Domain" - } - }, - "WORK_GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WorkGroup" - } - }, - "HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Host" - } - }, - "PORT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Port" - } - }, - "DATABASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Database" - } - }, - "DATA_SET_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DataSetName" - } - }, - "CATALOG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Catalog" - } - }, - "INSTANCE_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "InstanceId" - } - }, - "CLUSTER_ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ClusterId" - } - }, - "MANIFEST_FILE_LOCATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ManifestFileLocation" - } - }, - "WAREHOUSE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Warehouse" - } - }, - "ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RoleArn" - } - }, - "PRODUCT_TYPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ProductType" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobError": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific error type of the error that occurred.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred during an Asset Bundle export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobError" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride": { - "type": "enum", - "members": { - "START_AFTER_DATE_TIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartAfterDateTime" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration": { - "type": "structure", - "members": { - "PrefixForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobStatus": { - "type": "enum", - "members": { - "QUEUED_FOR_IMMEDIATE_EXECUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFUL" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobSummary": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the export job.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the export job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the export job was created.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the export job.

" - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The format for the export job.

" - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of permissions associated with each resource ARN.

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The flag that determines the inclusion of tags associated with each resource ARN.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the export job that includes details of the job's configuration and its current status.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobSummary" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific Theme resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

", - "smithy.api#required": {} - } - }, - "Properties": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList", - "traits": { - "smithy.api#documentation": "

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride": { - "type": "enum", - "members": { - "NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "Name" - } - }, - "DNS_RESOLVERS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DnsResolvers" - } - }, - "ROLE_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RoleArn" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy": { - "type": "structure", - "members": { - "StrictModeForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to export resources under strict or lenient mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobWarning": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused a warning.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the warning.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle export job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleExportJobWarningList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobWarning" - } - }, - "com.amazonaws.quicksight#AssetBundleImportBodyBlob": { - "type": "blob", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20971520 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#AssetBundleImportFailureAction": { - "type": "enum", - "members": { - "DO_NOTHING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOTHING" - } - }, - "ROLLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROLLBACK" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you ant to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single analysis that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions": { - "type": "structure", - "members": { - "AnalysisIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the analyses that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of analysis IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags": { - "type": "structure", - "members": { - "AnalysisIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the analyses that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of analysis IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you want to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single dashboard that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions": { - "type": "structure", - "members": { - "DashboardIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the dashboards that you want to apply overrides to.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the link sharing configurations that you want to apply overrides to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dashboard IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags": { - "type": "structure", - "members": { - "DashboardIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the dashboards that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dashboard IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single dataset that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions": { - "type": "structure", - "members": { - "DataSetIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the datasets that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dataset IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags": { - "type": "structure", - "members": { - "DataSetIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the datasets that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dataset IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.quicksight#DbUsername", - "traits": { - "smithy.api#documentation": "

The username for the data source connection.

", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.quicksight#Password", - "traits": { - "smithy.api#documentation": "

The password for the data source connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A username and password credential pair to use to import a data source resource.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials": { - "type": "structure", - "members": { - "CredentialPair": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair", - "traits": { - "smithy.api#documentation": "

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The login credentials to use to import a data source resource.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters": { - "type": "structure", - "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the data source.

" - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters" - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties" - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties" - }, - "Credentials": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials", - "traits": { - "smithy.api#documentation": "

An optional structure that provides the credentials to be used to create the imported data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single data source that is being imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions": { - "type": "structure", - "members": { - "DataSourceIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the data source that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of data source IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags": { - "type": "structure", - "members": { - "DataSourceIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the data source that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of data source IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobError": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The specific error type or the error that occurred.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes an error that occurred within an Asset Bundle import execution.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobError" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters": { - "type": "structure", - "members": { - "ResourceIdOverrideConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration", - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides to be applied within the import job.

" - } - }, - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList", - "traits": { - "smithy.api#documentation": "

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions": { - "type": "structure", - "members": { - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList", - "traits": { - "smithy.api#documentation": "

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags": { - "type": "structure", - "members": { - "VPCConnections": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" - } - }, - "DataSources": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

" - } - }, - "Themes": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

" - } - }, - "Analyses": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

" - } - }, - "Dashboards": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList", - "traits": { - "smithy.api#documentation": "

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy": { - "type": "structure", - "members": { - "StrictModeForAllResources": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

", - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

", - "smithy.api#required": {} - } - }, - "StartAfterDateTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

An override for the StartAfterDateTime of a RefreshSchedule. Make\n sure that the StartAfterDateTime is set to a time that takes\n place in the future.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration": { - "type": "structure", - "members": { - "PrefixForAllResources": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobStatus": { - "type": "enum", - "members": { - "QUEUED_FOR_IMMEDIATE_EXECUTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" - } - }, - "IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IN_PROGRESS" - } - }, - "SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUCCESSFUL" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "FAILED_ROLLBACK_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_IN_PROGRESS" - } - }, - "FAILED_ROLLBACK_COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_COMPLETED" - } - }, - "FAILED_ROLLBACK_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED_ROLLBACK_ERROR" - } - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobSummary": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", - "traits": { - "smithy.api#documentation": "

The current status of the import job.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the import job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the import job was created.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the import job that includes details of the requested job's configuration and its current status.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobSummary" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the theme.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single theme that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions": { - "type": "structure", - "members": { - "ThemeIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of permissions for the themes that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of theme IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags": { - "type": "structure", - "members": { - "ThemeIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the themes that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of theme IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC Connection to apply overrides to.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A new name for the VPC connection.

" - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of new subnet IDs for the VPC connection you are importing. This field is\n required if you are importing the VPC connection from another Amazon Web Services account or Region.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A new security group ID for the VPC connection you are importing. This field is required\n if you are importing the VPC connection from another Amazon Web Services account or Region.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

An optional override of DNS resolvers to be used by the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

An optional override of the role ARN to be used by the VPC connection.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The override parameters for a single VPC connection that is imported.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags": { - "type": "structure", - "members": { - "VPCConnectionIds": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", - "traits": { - "smithy.api#documentation": "

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of tags for the VPC connections that you want to apply overrides to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobWarning": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the resource that the warning occurred for.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A description of the warning that occurred during an Asset Bundle import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportJobWarningList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobWarning" - } - }, - "com.amazonaws.quicksight#AssetBundleImportSource": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", - "traits": { - "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#S3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

" - } - }, - "com.amazonaws.quicksight#AssetBundleImportSourceDescription": { - "type": "structure", - "members": { - "Body": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#S3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 URI that you provided at the start of the import job.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

" - } - }, - "com.amazonaws.quicksight#AssetBundlePrincipalList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Principal" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#AssetBundleResourceArns": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", - "traits": { - "smithy.api#documentation": "

A list of link sharing permissions for the dashboards that you want to apply overrides to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

" - } - }, - "com.amazonaws.quicksight#AssetBundleResourcePermissions": { - "type": "structure", - "members": { - "Principals": { - "target": "com.amazonaws.quicksight#AssetBundlePrincipalList", - "traits": { - "smithy.api#documentation": "

A list of principals to grant permissions on.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#ActionList", - "traits": { - "smithy.api#documentation": "

A list of IAM actions to grant permissions on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

" - } - }, - "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^\\*|[\\w\\-]{1,2048}$" - } - }, - "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#AssetOptions": { - "type": "structure", - "members": { - "Timezone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Determines the timezone for the analysis.

" - } - }, - "WeekStart": { - "target": "com.amazonaws.quicksight#DayOfTheWeek", - "traits": { - "smithy.api#documentation": "

Determines the week start day for an analysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An array of analysis level configurations.

" - } - }, - "com.amazonaws.quicksight#AssignmentStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DRAFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DRAFT" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#AthenaParameters": { - "type": "structure", - "members": { - "WorkGroup": { - "target": "com.amazonaws.quicksight#WorkGroup", - "traits": { - "smithy.api#documentation": "

The workgroup that Amazon Athena uses.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Athena.

" - } - }, - "com.amazonaws.quicksight#AttributeAggregationFunction": { - "type": "structure", - "members": { - "SimpleAttributeAggregation": { - "target": "com.amazonaws.quicksight#SimpleAttributeAggregationFunction", - "traits": { - "smithy.api#documentation": "

The built-in aggregation functions for attributes.

\n " - } - }, - "ValueForMultipleValues": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregation for attributes.

" - } - }, - "com.amazonaws.quicksight#AuroraParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Aurora.

" - } - }, - "com.amazonaws.quicksight#AuroraPostgreSqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port that Amazon Aurora PostgreSQL is listening on.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

The Amazon Aurora PostgreSQL database to connect to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

" - } - }, - "com.amazonaws.quicksight#AuthenticationMethodOption": { - "type": "enum", - "members": { - "IAM_AND_QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_AND_QUICKSIGHT" - } - }, - "IAM_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ONLY" - } - }, - "ACTIVE_DIRECTORY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTIVE_DIRECTORY" - } - }, - "IAM_IDENTITY_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_IDENTITY_CENTER" - } - } - } - }, - "com.amazonaws.quicksight#AuthorSpecifiedAggregation": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - } - } - }, - "com.amazonaws.quicksight#AuthorSpecifiedAggregations": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregation" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsByService": { - "type": "structure", - "members": { - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service.

" - } - }, - "AuthorizedTargets": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsList", - "traits": { - "smithy.api#documentation": "

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The authorized targets that are associated with a service.

" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsByServices": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsByService" - } - }, - "com.amazonaws.quicksight#AuthorizedTargetsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#AwsAccountId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 12, - "max": 12 - }, - "smithy.api#pattern": "^[0-9]{12}$" - } - }, - "com.amazonaws.quicksight#AwsAndAccountId": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(aws|[0-9]{12})$" - } - }, - "com.amazonaws.quicksight#AwsIotAnalyticsParameters": { - "type": "structure", - "members": { - "DataSetName": { - "target": "com.amazonaws.quicksight#DataSetName", - "traits": { - "smithy.api#documentation": "

Dataset name.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for IoT Analytics.

" - } - }, - "com.amazonaws.quicksight#AxisBinding": { - "type": "enum", - "members": { - "PRIMARY_YAXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_YAXIS" - } - }, - "SECONDARY_YAXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECONDARY_YAXIS" - } - } - } - }, - "com.amazonaws.quicksight#AxisDataOptions": { - "type": "structure", - "members": { - "NumericAxisOptions": { - "target": "com.amazonaws.quicksight#NumericAxisOptions", - "traits": { - "smithy.api#documentation": "

The options for an axis with a numeric field.

" - } - }, - "DateAxisOptions": { - "target": "com.amazonaws.quicksight#DateAxisOptions", - "traits": { - "smithy.api#documentation": "

The options for an axis with a date field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data options for an axis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayDataDrivenRange": { - "type": "structure", - "members": {}, - "traits": { - "smithy.api#documentation": "

The options that are saved for future extension.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayMinMaxRange": { - "type": "structure", - "members": { - "Minimum": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The minimum setup for an axis display range.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum setup for an axis display range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum and maximum setup for an axis display range.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayOptions": { - "type": "structure", - "members": { - "TickLabelOptions": { - "target": "com.amazonaws.quicksight#AxisTickLabelOptions", - "traits": { - "smithy.api#documentation": "

The tick label options of an axis.

" - } - }, - "AxisLineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the axis line is visible.

" - } - }, - "GridLineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the grid line is visible.

" - } - }, - "DataOptions": { - "target": "com.amazonaws.quicksight#AxisDataOptions", - "traits": { - "smithy.api#documentation": "

The data options for an axis.

" - } - }, - "ScrollbarOptions": { - "target": "com.amazonaws.quicksight#ScrollBarOptions", - "traits": { - "smithy.api#documentation": "

The scroll bar options for an axis.

" - } - }, - "AxisOffset": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The offset value that determines the starting placement of the axis within a visual's bounds.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the axis label.

" - } - }, - "com.amazonaws.quicksight#AxisDisplayRange": { - "type": "structure", - "members": { - "MinMax": { - "target": "com.amazonaws.quicksight#AxisDisplayMinMaxRange", - "traits": { - "smithy.api#documentation": "

The minimum and maximum setup of an axis display range.

" - } - }, - "DataDriven": { - "target": "com.amazonaws.quicksight#AxisDisplayDataDrivenRange", - "traits": { - "smithy.api#documentation": "

The data-driven setup of an axis display range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range setup of a numeric axis display range.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisLabelOptions": { - "type": "structure", - "members": { - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the axis label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The text for the axis label.

" - } - }, - "ApplyTo": { - "target": "com.amazonaws.quicksight#AxisLabelReferenceOptions", - "traits": { - "smithy.api#documentation": "

The options that indicate which field the label belongs to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options for a chart axis. You must specify the field that the label is targeted to.

" - } - }, - "com.amazonaws.quicksight#AxisLabelOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#AxisLabelOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#AxisLabelReferenceOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field that the axis label is targeted to.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the axis label is targeted to.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The reference that specifies where the axis label is applied to.

" - } - }, - "com.amazonaws.quicksight#AxisLinearScale": { - "type": "structure", - "members": { - "StepCount": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The step count setup of a linear axis.

" - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The step size setup of a linear axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The liner axis scale setup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisLogarithmicScale": { - "type": "structure", - "members": { - "Base": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The base setup of a logarithmic axis scale.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The logarithmic axis scale setup.

" - } - }, - "com.amazonaws.quicksight#AxisScale": { - "type": "structure", - "members": { - "Linear": { - "target": "com.amazonaws.quicksight#AxisLinearScale", - "traits": { - "smithy.api#documentation": "

The linear axis scale setup.

" - } - }, - "Logarithmic": { - "target": "com.amazonaws.quicksight#AxisLogarithmicScale", - "traits": { - "smithy.api#documentation": "

The logarithmic axis scale setup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scale setup\n options for a numeric axis display.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#AxisTickLabelOptions": { - "type": "structure", - "members": { - "LabelOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

Determines whether or not the axis ticks are visible.

" - } - }, - "RotationAngle": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The rotation angle of the axis tick labels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tick label options of an axis.

" - } - }, - "com.amazonaws.quicksight#BarChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category (y-axis) field well of a bar chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a bar chart. Values are aggregated by\n category.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color (group/color) field well of a bar chart.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a bar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" - } - }, - "com.amazonaws.quicksight#BarChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#BarChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#BarChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a BarChartVisual.

" - } - }, - "Orientation": { - "target": "com.amazonaws.quicksight#BarChartOrientation", - "traits": { - "smithy.api#documentation": "

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

\n " - } - }, - "BarsArrangement": { - "target": "com.amazonaws.quicksight#BarsArrangement", - "traits": { - "smithy.api#documentation": "

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for bar chart category.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart.

" - } - }, - "ValueAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for a bar chart value.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a BarChartVisual.

" - } - }, - "com.amazonaws.quicksight#BarChartFieldWells": { - "type": "structure", - "members": { - "BarChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#BarChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a BarChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#BarChartOrientation": { - "type": "enum", - "members": { - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - }, - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - } - } - }, - "com.amazonaws.quicksight#BarChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories displayed in a bar chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of color fields in a bar chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of values displayed in a bar chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

sort-configuration-description

" - } - }, - "com.amazonaws.quicksight#BarChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#BarChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A bar chart.

\n

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

\n \n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#BarsArrangement": { - "type": "enum", - "members": { - "CLUSTERED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTERED" - } - }, - "STACKED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED" - } - }, - "STACKED_PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED_PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#BaseMapStyleType": { - "type": "enum", - "members": { - "LIGHT_GRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LIGHT_GRAY" - } - }, - "DARK_GRAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DARK_GRAY" - } - }, - "STREET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STREET" - } - }, - "IMAGERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGERY" - } - } - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates new reviewed answers for a Q Topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Answers": { - "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of the Answers to be created.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "SucceededAnswers": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are successfully created.

" - } - }, - "InvalidAnswers": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are invalid and not created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes reviewed answers for Q Topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnswerIds": { - "target": "com.amazonaws.quicksight#AnswerIds", - "traits": { - "smithy.api#documentation": "

The Answer IDs of the Answers to be deleted.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "SucceededAnswers": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are successfully deleted.

" - } - }, - "InvalidAnswers": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of Answers that are invalid and not deleted.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#BigQueryParameters": { - "type": "structure", - "members": { - "ProjectId": { - "target": "com.amazonaws.quicksight#ProjectId", - "traits": { - "smithy.api#documentation": "

The Google Cloud Platform project ID where your datasource was created.

", - "smithy.api#required": {} - } - }, - "DataSetRegion": { - "target": "com.amazonaws.quicksight#DataSetRegion", - "traits": { - "smithy.api#documentation": "

The storage location where you create a Google BigQuery data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" - } - }, - "com.amazonaws.quicksight#BinCountLimit": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#BinCountOptions": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#BinCountValue", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" - } - }, - "com.amazonaws.quicksight#BinCountValue": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#BinWidthOptions": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#BinWidthValue", - "traits": { - "smithy.api#documentation": "

The options that determine the bin width value.

" - } - }, - "BinCountLimit": { - "target": "com.amazonaws.quicksight#BinCountLimit", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count limit.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" - } - }, - "com.amazonaws.quicksight#BinWidthValue": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#BodySectionConfiguration": { - "type": "structure", - "members": { - "SectionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a body section.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#BodySectionContent", - "traits": { - "smithy.api#documentation": "

The configuration of content in a body section.

", - "smithy.api#required": {} - } - }, - "Style": { - "target": "com.amazonaws.quicksight#SectionStyle", - "traits": { - "smithy.api#documentation": "

The style options of a body section.

" - } - }, - "PageBreakConfiguration": { - "target": "com.amazonaws.quicksight#SectionPageBreakConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a page break for a section.

" - } - }, - "RepeatConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionRepeatConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a body section.

" - } - }, - "com.amazonaws.quicksight#BodySectionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#BodySectionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 28 - } - } - }, - "com.amazonaws.quicksight#BodySectionContent": { - "type": "structure", - "members": { - "Layout": { - "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The layout configuration of a body section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of content in a body section.

" - } - }, - "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", - "traits": { - "smithy.api#documentation": "

Number of values to use from the column for repetition.

" - } - }, - "SortByMetrics": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", - "traits": { - "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

" - } - }, - "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnSort" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", - "traits": { - "smithy.api#documentation": "

Number of values to use from the column for repetition.

" - } - }, - "SortByMetrics": { - "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", - "traits": { - "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatConfiguration": { - "type": "structure", - "members": { - "DimensionConfigurations": { - "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList", - "traits": { - "smithy.api#documentation": "

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

" - } - }, - "PageBreakConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration", - "traits": { - "smithy.api#documentation": "

Page break configuration to apply for each repeating instance.

" - } - }, - "NonRepeatingVisuals": { - "target": "com.amazonaws.quicksight#NonRepeatingVisualsList", - "traits": { - "smithy.api#documentation": "

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration": { - "type": "structure", - "members": { - "DynamicCategoryDimensionConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

" - } - }, - "DynamicNumericDimensionConfiguration": { - "target": "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration", - "traits": { - "smithy.api#documentation": "

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

" - } - }, - "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration": { - "type": "structure", - "members": { - "After": { - "target": "com.amazonaws.quicksight#SectionAfterPageBreak" - } - }, - "traits": { - "smithy.api#documentation": "

The page break configuration to apply for each repeating instance.

" - } - }, - "com.amazonaws.quicksight#BookmarksConfigurations": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that determines whether a user\n can bookmark an embedded dashboard.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The bookmarks configuration of an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#Boolean": { - "type": "boolean", - "traits": { - "smithy.api#default": false - } - }, - "com.amazonaws.quicksight#BooleanObject": { - "type": "boolean" - }, - "com.amazonaws.quicksight#BorderStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The option to enable display of borders for visuals.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for tile borders for visuals.

" - } - }, - "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#BoxPlotDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a box plot chart. Values are grouped based on group by fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#BoxPlotMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field well of a box plot chart. Values are aggregated based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for a box plot.

" - } - }, - "com.amazonaws.quicksight#BoxPlotChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#BoxPlotFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#BoxPlotSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" - } - }, - "BoxPlotOptions": { - "target": "com.amazonaws.quicksight#BoxPlotOptions", - "traits": { - "smithy.api#documentation": "

The box plot chart options for a box plot visual

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) of a box plot value.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions" - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a BoxPlotVisual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#BoxPlotFieldWells": { - "type": "structure", - "members": { - "BoxPlotAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a BoxPlotVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#BoxPlotFillStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "TRANSPARENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRANSPARENT" - } - } - } - }, - "com.amazonaws.quicksight#BoxPlotMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#BoxPlotOptions": { - "type": "structure", - "members": { - "StyleOptions": { - "target": "com.amazonaws.quicksight#BoxPlotStyleOptions", - "traits": { - "smithy.api#documentation": "

The style options of the box plot.

" - } - }, - "OutlierVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the outlier in a box plot.

" - } - }, - "AllDataPointsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of all data points of the box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options of a box plot visual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of a group by fields.

" - } - }, - "PaginationConfiguration": { - "target": "com.amazonaws.quicksight#PaginationConfiguration", - "traits": { - "smithy.api#documentation": "

The pagination configuration of a table visual or box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" - } - }, - "com.amazonaws.quicksight#BoxPlotStyleOptions": { - "type": "structure", - "members": { - "FillStyle": { - "target": "com.amazonaws.quicksight#BoxPlotFillStyle", - "traits": { - "smithy.api#documentation": "

The fill styles (solid, transparent) of the box plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The style options of the box plot.

" - } - }, - "com.amazonaws.quicksight#BoxPlotVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#BoxPlotChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CIDR": { - "type": "string", - "traits": { - "smithy.api#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]))$" - } - }, - "com.amazonaws.quicksight#CalculatedColumn": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

Column name.

", - "smithy.api#required": {} - } - }, - "ColumnId": { - "target": "com.amazonaws.quicksight#ColumnId", - "traits": { - "smithy.api#documentation": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

An expression that defines the calculated column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A calculated column for a dataset.

" - } - }, - "com.amazonaws.quicksight#CalculatedColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CalculatedColumn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#CalculatedField": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in this calculated field.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the calculated field.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#CalculatedFieldExpression", - "traits": { - "smithy.api#documentation": "

The expression of the calculated field.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The calculated field of an analysis.

" - } - }, - "com.amazonaws.quicksight#CalculatedFieldExpression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32000 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#CalculatedFieldReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Identifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 250 - } - } - }, - "com.amazonaws.quicksight#CalculatedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CalculatedField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#CalculatedMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression in the table calculation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The table calculation measure field for pivot tables.

" - } - }, - "com.amazonaws.quicksight#CancelIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CancelIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CancelIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Cancels an ongoing ingestion of data into SPICE.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CancelIngestionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CancelIngestionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CascadingControlConfiguration": { - "type": "structure", - "members": { - "SourceControls": { - "target": "com.amazonaws.quicksight#CascadingControlSourceList", - "traits": { - "smithy.api#documentation": "

A list of source controls that determine the values that are used in the current control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "com.amazonaws.quicksight#CascadingControlSource": { - "type": "structure", - "members": { - "SourceSheetControlId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The source sheet control ID of a CascadingControlSource.

" - } - }, - "ColumnToMatch": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column identifier that determines which column to look up for the source sheet control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source controls that are used in a CascadingControlConfiguration.

" - } - }, - "com.amazonaws.quicksight#CascadingControlSourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CascadingControlSource" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#CastColumnTypeOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

Column name.

", - "smithy.api#required": {} - } - }, - "NewColumnType": { - "target": "com.amazonaws.quicksight#ColumnDataType", - "traits": { - "smithy.api#documentation": "

New column data type.

", - "smithy.api#required": {} - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" - } - }, - "Format": { - "target": "com.amazonaws.quicksight#TypeCastFormat", - "traits": { - "smithy.api#documentation": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" - } - }, - "com.amazonaws.quicksight#Catalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#CategoricalAggregationFunction": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - } - } - }, - "com.amazonaws.quicksight#CategoricalDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the CategoricalDimensionField.

", - "smithy.api#required": {} - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with categorical type columns..

" - } - }, - "com.amazonaws.quicksight#CategoricalMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the CategoricalMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with categorical type columns.

" - } - }, - "com.amazonaws.quicksight#CategoryDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

A list of the string inputs that are the values of the category drill down filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The category drill down filter.

" - } - }, - "com.amazonaws.quicksight#CategoryFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a CategoryFilter.

", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CategoryFilterConfiguration": { - "type": "structure", - "members": { - "FilterListConfiguration": { - "target": "com.amazonaws.quicksight#FilterListConfiguration", - "traits": { - "smithy.api#documentation": "

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

" - } - }, - "CustomFilterListConfiguration": { - "target": "com.amazonaws.quicksight#CustomFilterListConfiguration", - "traits": { - "smithy.api#documentation": "

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

" - } - }, - "CustomFilterConfiguration": { - "target": "com.amazonaws.quicksight#CustomFilterConfiguration", - "traits": { - "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a CategoryFilter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CategoryFilterFunction": { - "type": "enum", - "members": { - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterMatchOperator": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "DOES_NOT_EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_EQUAL" - } - }, - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "DOES_NOT_CONTAIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_CONTAIN" - } - }, - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "ENDS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDS_WITH" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterSelectAllOptions": { - "type": "enum", - "members": { - "FILTER_ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#CategoryFilterType": { - "type": "enum", - "members": { - "CUSTOM_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_FILTER" - } - }, - "CUSTOM_FILTER_LIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM_FILTER_LIST" - } - }, - "FILTER_LIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_LIST" - } - } - } - }, - "com.amazonaws.quicksight#CategoryInnerFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", - "traits": { - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" - } - }, - "com.amazonaws.quicksight#CategoryValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#CategoryValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CategoryValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100000 - } - } - }, - "com.amazonaws.quicksight#CellValueSynonym": { - "type": "structure", - "members": { - "CellValue": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The cell value.

" - } - }, - "Synonyms": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

Other names or aliases for the cell value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents the cell value synonym.

" - } - }, - "com.amazonaws.quicksight#CellValueSynonyms": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CellValueSynonym" - } - }, - "com.amazonaws.quicksight#ChartAxisLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of an axis label on a chart. Choose one of the following options:

\n " - } - }, - "SortIconVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the sort icon on a chart's axis label.

" - } - }, - "AxisLabelOptions": { - "target": "com.amazonaws.quicksight#AxisLabelOptionsList", - "traits": { - "smithy.api#documentation": "

The label options for a chart axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options for an axis on a chart.

" - } - }, - "com.amazonaws.quicksight#ClusterId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ClusterMarker": { - "type": "structure", - "members": { - "SimpleClusterMarker": { - "target": "com.amazonaws.quicksight#SimpleClusterMarker", - "traits": { - "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker\n configuration.

" - } - }, - "com.amazonaws.quicksight#ClusterMarkerConfiguration": { - "type": "structure", - "members": { - "ClusterMarker": { - "target": "com.amazonaws.quicksight#ClusterMarker", - "traits": { - "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cluster marker configuration of the geospatial map selected point style.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstant": { - "type": "structure", - "members": { - "ValueList": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of values for the collective constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a collective constant.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstantEntry": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The ConstantType of a CollectiveConstantEntry.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The value of a CollectiveConstantEntry.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a CollectiveConstantEntry.

" - } - }, - "com.amazonaws.quicksight#CollectiveConstantEntryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CollectiveConstantEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ColorFillType": { - "type": "enum", - "members": { - "DISCRETE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISCRETE" - } - }, - "GRADIENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRADIENT" - } - } - } - }, - "com.amazonaws.quicksight#ColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HexColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ColorScale": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#ColorScaleColorList", - "traits": { - "smithy.api#documentation": "

Determines the list of colors that are applied to the visual.

", - "smithy.api#required": {} - } - }, - "ColorFillType": { - "target": "com.amazonaws.quicksight#ColorFillType", - "traits": { - "smithy.api#documentation": "

Determines the color fill type.

", - "smithy.api#required": {} - } - }, - "NullValueColor": { - "target": "com.amazonaws.quicksight#DataColor", - "traits": { - "smithy.api#documentation": "

Determines the color that is applied to null values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color scale that is applied to the visual.

" - } - }, - "com.amazonaws.quicksight#ColorScaleColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataColor" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#ColorsConfiguration": { - "type": "structure", - "members": { - "CustomColors": { - "target": "com.amazonaws.quicksight#CustomColorsList", - "traits": { - "smithy.api#documentation": "

A list of up to 50 custom colors.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configurations for a column.

" - } - }, - "com.amazonaws.quicksight#ColumnConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column.

", - "smithy.api#required": {} - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#FormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of a column.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#ColumnRole", - "traits": { - "smithy.api#documentation": "

The role of the column.

" - } - }, - "ColorsConfiguration": { - "target": "com.amazonaws.quicksight#ColorsConfiguration", - "traits": { - "smithy.api#documentation": "

The color configurations of the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The general configuration of a column.

" - } - }, - "com.amazonaws.quicksight#ColumnConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ColumnDataRole": { - "type": "enum", - "members": { - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDataSubType": { - "type": "enum", - "members": { - "FLOAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLOAT" - } - }, - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGER" - } - }, - "DECIMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECIMAL" - } - }, - "DATETIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATETIME" - } - } - } - }, - "com.amazonaws.quicksight#ColumnDescription": { - "type": "structure", - "members": { - "Text": { - "target": "com.amazonaws.quicksight#ColumnDescriptiveText", - "traits": { - "smithy.api#documentation": "

The text of a description for a column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata that contains a description for a column.

" - } - }, - "com.amazonaws.quicksight#ColumnDescriptiveText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnGroup": { - "type": "structure", - "members": { - "GeoSpatialColumnGroup": { - "target": "com.amazonaws.quicksight#GeoSpatialColumnGroup", - "traits": { - "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupColumnSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column group's column schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure describing the name, data type, and geographic role of the columns.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupColumnSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroupColumnSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 8 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ColumnGroupSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column group schema.

" - } - }, - "ColumnGroupColumnSchemaList": { - "target": "com.amazonaws.quicksight#ColumnGroupColumnSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of schemas for column group columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The column group schema.

" - } - }, - "com.amazonaws.quicksight#ColumnGroupSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnGroupSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnHierarchy": { - "type": "structure", - "members": { - "ExplicitHierarchy": { - "target": "com.amazonaws.quicksight#ExplicitHierarchy", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "DateTimeHierarchy": { - "target": "com.amazonaws.quicksight#DateTimeHierarchy", - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" - } - }, - "PredefinedHierarchy": { - "target": "com.amazonaws.quicksight#PredefinedHierarchy", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of the fields for a visual element.

" - } - }, - "com.amazonaws.quicksight#ColumnHierarchyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnHierarchy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#ColumnId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ColumnIdentifier": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that the column belongs to.

", - "smithy.api#required": {} - } - }, - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A column of a data set.

" - } - }, - "com.amazonaws.quicksight#ColumnLevelPermissionRule": { - "type": "structure", - "members": { - "Principals": { - "target": "com.amazonaws.quicksight#PrincipalList", - "traits": { - "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" - } - }, - "ColumnNames": { - "target": "com.amazonaws.quicksight#ColumnNameList", - "traits": { - "smithy.api#documentation": "

An array of column names.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

" - } - }, - "com.amazonaws.quicksight#ColumnLevelPermissionRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRule" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnName" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#ColumnName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#ColumnNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ColumnOrderingType": { - "type": "enum", - "members": { - "GREATER_IS_BETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GREATER_IS_BETTER" - } - }, - "LESSER_IS_BETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LESSER_IS_BETTER" - } - }, - "SPECIFIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPECIFIED" - } - } - } - }, - "com.amazonaws.quicksight#ColumnRole": { - "type": "enum", - "members": { - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#ColumnSchema": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the column schema.

" - } - }, - "DataType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The data type of the column schema.

" - } - }, - "GeographicRole": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The geographic role of the column schema.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The column schema.

" - } - }, - "com.amazonaws.quicksight#ColumnSchemaList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnSchema" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#ColumnSort": { - "type": "structure", - "members": { - "SortBy": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#required": {} - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function that is defined in the column sort.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" - } - }, - "com.amazonaws.quicksight#ColumnTag": { - "type": "structure", - "members": { - "ColumnGeographicRole": { - "target": "com.amazonaws.quicksight#GeoSpatialDataRole", - "traits": { - "smithy.api#documentation": "

A geospatial role for a column.

" - } - }, - "ColumnDescription": { - "target": "com.amazonaws.quicksight#ColumnDescription", - "traits": { - "smithy.api#documentation": "

A description for a column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" - } - }, - "com.amazonaws.quicksight#ColumnTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnTag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#ColumnTagName": { - "type": "enum", - "members": { - "COLUMN_GEOGRAPHIC_ROLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE" - } - }, - "COLUMN_DESCRIPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_DESCRIPTION" - } - } - } - }, - "com.amazonaws.quicksight#ColumnTagNames": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnTagName" - } - }, - "com.amazonaws.quicksight#ColumnTooltipItem": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The target column of the tooltip item.

", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The label of the tooltip item.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the tooltip item.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the column tooltip item.

" - } - }, - "TooltipTarget": { - "target": "com.amazonaws.quicksight#TooltipTarget", - "traits": { - "smithy.api#documentation": "

Determines the target of the column tooltip item in a combo chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" - } - }, - "com.amazonaws.quicksight#ComboChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated category field wells of a combo chart.

" - } - }, - "BarValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated BarValues field well of a combo chart.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated colors field well of a combo chart.

" - } - }, - "LineValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated LineValues field well of a combo chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a combo chart.

" - } - }, - "com.amazonaws.quicksight#ComboChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ComboChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#ComboChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" - } - }, - "BarsArrangement": { - "target": "com.amazonaws.quicksight#BarsArrangement", - "traits": { - "smithy.api#documentation": "

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

\n " - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The category axis of a combo chart.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

" - } - }, - "SecondaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

" - } - }, - "SecondaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

" - } - }, - "SingleAxisOptions": { - "target": "com.amazonaws.quicksight#SingleAxisOptions" - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "BarDataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a bar in a combo chart.

" - } - }, - "LineDataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a line in a combo chart.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference line setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a ComboChartVisual.

" - } - }, - "com.amazonaws.quicksight#ComboChartFieldWells": { - "type": "structure", - "members": { - "ComboChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ComboChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComboChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category field well in a combo chart.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The item limit configuration for the category field well of a combo chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the color field well in a combo chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The item limit configuration of the color field well in a combo chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" - } - }, - "com.amazonaws.quicksight#ComboChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ComboChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A combo chart.

\n

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ComparativeOrder": { - "type": "structure", - "members": { - "UseOrdering": { - "target": "com.amazonaws.quicksight#ColumnOrderingType", - "traits": { - "smithy.api#documentation": "

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

" - } - }, - "SpecifedOrder": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The list of columns to be used in the ordering.

" - } - }, - "TreatUndefinedSpecifiedValues": { - "target": "com.amazonaws.quicksight#UndefinedSpecifiedValueType", - "traits": { - "smithy.api#documentation": "

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a comparative order.

" - } - }, - "com.amazonaws.quicksight#ComparisonConfiguration": { - "type": "structure", - "members": { - "ComparisonMethod": { - "target": "com.amazonaws.quicksight#ComparisonMethod", - "traits": { - "smithy.api#documentation": "

The method of the comparison. Choose from the following options:

\n " - } - }, - "ComparisonFormat": { - "target": "com.amazonaws.quicksight#ComparisonFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format of the comparison.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The comparison display configuration of a KPI or gauge chart.

" - } - }, - "com.amazonaws.quicksight#ComparisonFormatConfiguration": { - "type": "structure", - "members": { - "NumberDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The number display format.

" - } - }, - "PercentageDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The percentage display format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The format of the comparison.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComparisonMethod": { - "type": "enum", - "members": { - "DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFFERENCE" - } - }, - "PERCENT_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_DIFFERENCE" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#ComparisonMethodType": { - "type": "enum", - "members": { - "DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFF" - } - }, - "PERC_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERC_DIFF" - } - }, - "DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIFF_AS_PERC" - } - }, - "POP_CURRENT_DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_CURRENT_DIFF_AS_PERC" - } - }, - "POP_CURRENT_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_CURRENT_DIFF" - } - }, - "POP_OVERTIME_DIFF_AS_PERC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_OVERTIME_DIFF_AS_PERC" - } - }, - "POP_OVERTIME_DIFF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POP_OVERTIME_DIFF" - } - }, - "PERCENT_OF_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_OF_TOTAL" - } - }, - "RUNNING_SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING_SUM" - } - }, - "MOVING_AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MOVING_AVERAGE" - } - } - } - }, - "com.amazonaws.quicksight#Computation": { - "type": "structure", - "members": { - "TopBottomRanked": { - "target": "com.amazonaws.quicksight#TopBottomRankedComputation", - "traits": { - "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" - } - }, - "TopBottomMovers": { - "target": "com.amazonaws.quicksight#TopBottomMoversComputation", - "traits": { - "smithy.api#documentation": "

The top movers and bottom movers computation configuration.

" - } - }, - "TotalAggregation": { - "target": "com.amazonaws.quicksight#TotalAggregationComputation", - "traits": { - "smithy.api#documentation": "

The total aggregation computation configuration.

" - } - }, - "MaximumMinimum": { - "target": "com.amazonaws.quicksight#MaximumMinimumComputation", - "traits": { - "smithy.api#documentation": "

The maximum and minimum computation configuration.

" - } - }, - "MetricComparison": { - "target": "com.amazonaws.quicksight#MetricComparisonComputation", - "traits": { - "smithy.api#documentation": "

The metric comparison computation configuration.

" - } - }, - "PeriodOverPeriod": { - "target": "com.amazonaws.quicksight#PeriodOverPeriodComputation", - "traits": { - "smithy.api#documentation": "

The period over period computation configuration.

" - } - }, - "PeriodToDate": { - "target": "com.amazonaws.quicksight#PeriodToDateComputation", - "traits": { - "smithy.api#documentation": "

The period to DataSetIdentifier computation configuration.

" - } - }, - "GrowthRate": { - "target": "com.amazonaws.quicksight#GrowthRateComputation", - "traits": { - "smithy.api#documentation": "

The growth rate computation configuration.

" - } - }, - "UniqueValues": { - "target": "com.amazonaws.quicksight#UniqueValuesComputation", - "traits": { - "smithy.api#documentation": "

The unique values computation configuration.

" - } - }, - "Forecast": { - "target": "com.amazonaws.quicksight#ForecastComputation", - "traits": { - "smithy.api#documentation": "

The forecast computation configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The computation union that is used in an insight visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ComputationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Computation" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ConcurrentUpdatingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String" - } - }, - "traits": { - "smithy.api#documentation": "

A resource is already in a state that indicates an operation is happening that must complete\n\t\t\tbefore a new update can be applied.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.quicksight#ConditionalFormattingColor": { - "type": "structure", - "members": { - "Solid": { - "target": "com.amazonaws.quicksight#ConditionalFormattingSolidColor", - "traits": { - "smithy.api#documentation": "

Formatting configuration for solid color.

" - } - }, - "Gradient": { - "target": "com.amazonaws.quicksight#ConditionalFormattingGradientColor", - "traits": { - "smithy.api#documentation": "

Formatting configuration for gradient color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for the color.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the condition of the icon set.

", - "smithy.api#required": {} - } - }, - "IconOptions": { - "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions", - "traits": { - "smithy.api#documentation": "

Custom icon options for an icon set.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the icon.

" - } - }, - "DisplayConfiguration": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration", - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the custom condition for an icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions": { - "type": "structure", - "members": { - "Icon": { - "target": "com.amazonaws.quicksight#Icon", - "traits": { - "smithy.api#documentation": "

Determines the type of icon.

" - } - }, - "UnicodeIcon": { - "target": "com.amazonaws.quicksight#UnicodeIcon", - "traits": { - "smithy.api#documentation": "

Determines the Unicode icon type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Custom icon options for an icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingGradientColor": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for gradient color.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#GradientColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for gradient color.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIcon": { - "type": "structure", - "members": { - "IconSet": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconSet", - "traits": { - "smithy.api#documentation": "

Formatting configuration for icon set.

" - } - }, - "CustomCondition": { - "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition", - "traits": { - "smithy.api#documentation": "

Determines the custom condition for an icon set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for the icon.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration": { - "type": "structure", - "members": { - "IconDisplayOption": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption", - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the icon display configuration.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption": { - "type": "enum", - "members": { - "ICON_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ICON_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconSet": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for the icon set.

", - "smithy.api#required": {} - } - }, - "IconSetType": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIconSetType", - "traits": { - "smithy.api#documentation": "

Determines the icon set type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for icon set.

" - } - }, - "com.amazonaws.quicksight#ConditionalFormattingIconSetType": { - "type": "enum", - "members": { - "PLUS_MINUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLUS_MINUS" - } - }, - "CHECK_X": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECK_X" - } - }, - "THREE_COLOR_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_COLOR_ARROW" - } - }, - "THREE_GRAY_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_GRAY_ARROW" - } - }, - "CARET_UP_MINUS_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_UP_MINUS_DOWN" - } - }, - "THREE_SHAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_SHAPE" - } - }, - "THREE_CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_CIRCLE" - } - }, - "FLAGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLAGS" - } - }, - "BARS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BARS" - } - }, - "FOUR_COLOR_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOUR_COLOR_ARROW" - } - }, - "FOUR_GRAY_ARROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOUR_GRAY_ARROW" - } - } - } - }, - "com.amazonaws.quicksight#ConditionalFormattingSolidColor": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression that determines the formatting configuration for solid color.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for solid color.

" - } - }, - "com.amazonaws.quicksight#ConflictException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#ConstantType": { - "type": "enum", - "members": { - "SINGULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGULAR" - } - }, - "RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANGE" - } - }, - "COLLECTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLECTIVE" - } - } - } - }, - "com.amazonaws.quicksight#ConstantValueString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#ContextMenuOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The context menu options for a visual's interactions.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDefault": { - "type": "structure", - "members": { - "MeasureFieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The measure field that is used in the contribution analysis.

", - "smithy.api#required": {} - } - }, - "ContributorDimensions": { - "target": "com.amazonaws.quicksight#ContributorDimensionList", - "traits": { - "smithy.api#documentation": "

The dimensions columns that are used in the contribution analysis,\n usually a list of ColumnIdentifiers.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The contribution analysis visual display for a line, pie, or bar chart.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDefaultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefault" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisDirection": { - "type": "enum", - "members": { - "INCREASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREASE" - } - }, - "DECREASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECREASE" - } - }, - "NEUTRAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEUTRAL" - } - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisFactor": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The field name of the ContributionAnalysisFactor.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the ContributionAnalysisFactor.

" - } - }, - "com.amazonaws.quicksight#ContributionAnalysisFactorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ContributionAnalysisFactor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisSortType": { - "type": "enum", - "members": { - "ABSOLUTE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" - } - }, - "CONTRIBUTION_PERCENTAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTRIBUTION_PERCENTAGE" - } - }, - "DEVIATION_FROM_EXPECTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEVIATION_FROM_EXPECTED" - } - }, - "PERCENTAGE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_DIFFERENCE" - } - } - } - }, - "com.amazonaws.quicksight#ContributionAnalysisTimeRanges": { - "type": "structure", - "members": { - "StartRange": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption", - "traits": { - "smithy.api#documentation": "

The start range for the ContributionAnalysisTimeRanges.

" - } - }, - "EndRange": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption", - "traits": { - "smithy.api#documentation": "

The end range for the ContributionAnalysisTimeRanges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the ContributionAnalysisTimeRanges.

" - } - }, - "com.amazonaws.quicksight#ContributorDimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.quicksight#CopySourceArn": { - "type": "string", - "traits": { - "smithy.api#pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$" - } - }, - "com.amazonaws.quicksight#CreateAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize Amazon QuickSight by removing Amazon QuickSight\n sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to add customizations to.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A list of the tags that you want to attach to this resource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the customization you're creating.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

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 Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for Amazon QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

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\n Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

You can't set default resource access on the new account from the Amazon QuickSight\n API. Instead, add default resource access from the Amazon QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the Amazon QuickSight\n User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAccountSubscriptionRequest": { - "type": "structure", - "members": { - "Edition": { - "target": "com.amazonaws.quicksight#Edition", - "traits": { - "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n " - } - }, - "AuthenticationMethod": { - "target": "com.amazonaws.quicksight#AuthenticationMethodOption", - "traits": { - "smithy.api#documentation": "

The method that you want to use to authenticate your Amazon QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AccountName": { - "target": "com.amazonaws.quicksight#AccountName", - "traits": { - "smithy.api#documentation": "

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\n AccountName value after the Amazon QuickSight account is\n created.

", - "smithy.api#required": {} - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

", - "smithy.api#required": {} - } - }, - "ActiveDirectoryName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" - } - }, - "Realm": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" - } - }, - "DirectoryId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the Active Directory that is associated with your Amazon QuickSight account.

" - } - }, - "AdminGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AuthorGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "ReaderGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AdminProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "AuthorProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "ReaderProGroup": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" - } - }, - "FirstName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The first name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "LastName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The last name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "EmailAddress": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" - } - }, - "ContactNumber": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A 10-digit phone number for the author of the Amazon QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new Amazon QuickSight account.

" - } - }, - "IAMIdentityCenterInstanceArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAccountSubscriptionResponse": { - "type": "structure", - "members": { - "SignupResponse": { - "target": "com.amazonaws.quicksight#SignupResponse", - "traits": { - "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you are creating an analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions structure to grant permissions by\n providing a list of Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).

\n

To specify no permissions, omit Permissions.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", - "traits": { - "smithy.api#documentation": "

A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the Amazon QuickSight console, make sure that you have access to it.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateAnalysisResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateColumnsOperation": { - "type": "structure", - "members": { - "Columns": { - "target": "com.amazonaws.quicksight#CalculatedColumnList", - "traits": { - "smithy.api#documentation": "

Calculated columns to create.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

" - } - }, - "com.amazonaws.quicksight#CreateDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to create the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n

To specify no permissions, omit the permissions list.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#DashboardSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of a shareable link to the dashboard.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDashboardResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard, including the version number of the first version that is\n created.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the dashboard creation request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the dataset.

", - "smithy.api#required": {} - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", - "smithy.api#required": {} - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", - "smithy.api#required": {} - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the data that you want to create.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameter declarations of the dataset.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "IngestionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a data source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sources", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.

\n

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

", - "smithy.api#required": {} - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" - } - }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", - "traits": { - "smithy.api#documentation": "

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

" - } - }, - "FolderArns": { - "target": "com.amazonaws.quicksight#FolderArnList", - "traits": { - "smithy.api#documentation": "

When you create the data source, Amazon QuickSight adds the data source to these folders.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of creating the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an empty shared folder.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateFolderMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateFolderMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateFolderMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateFolderMembershipRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the asset that you want to add to the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The member type of the asset that you want to add to a folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateFolderMembershipResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "FolderMember": { - "target": "com.amazonaws.quicksight#FolderMember", - "traits": { - "smithy.api#documentation": "

Information about the member in the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account where you want to create the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The name of the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder. By default, folderType is SHARED.

" - } - }, - "ParentFolderArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the parent folder.

\n

\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions of a folder.

\n

To specify no permissions, omit Permissions.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Tags for the folder.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the newly created folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The folder ID for the newly created folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The request ID for the newly created folder.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the CreateGroup 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 Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds an Amazon QuickSight user to an Amazon QuickSight group.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to add to the group membership.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to add the user to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want the user to be a part of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateGroupMembershipResponse": { - "type": "structure", - "members": { - "GroupMember": { - "target": "com.amazonaws.quicksight#GroupMember", - "traits": { - "smithy.api#documentation": "

The group member.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

A name for the group that you want to create.

", - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

A description for the group that you want to create.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want the group to be a part of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The request object for this operation.

", - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The response object for this operation.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an assignment with one specified IAM policy, identified by its\n\t\t\tAmazon Resource Name (ARN). This policy assignment is attached to the specified groups\n\t\t\tor users of Amazon QuickSight. Assignment names are unique per Amazon Web Services\n\t\t\taccount. To avoid overwriting rules in other namespaces, use assignment names that are\n\t\t\tunique.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname\n\t\t\tmust be unique within the\n\t\t\tAmazon Web Services account.

", - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n ", - "smithy.api#required": {} - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.\n\t\t\tThe\n\t\t\tname must be unique within the Amazon Web Services account.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID for the assignment.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.

\n

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateIngestionRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionType": { - "target": "com.amazonaws.quicksight#IngestionType", - "traits": { - "smithy.api#documentation": "

The type of ingestion that you want to create.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateIngestionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

" - } - }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", - "traits": { - "smithy.api#documentation": "

The ingestion status.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web Services Support.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name that you want to use to describe the new namespace.

", - "smithy.api#required": {} - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

The tags that you want to associate with the namespace that you're creating.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateNamespaceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the Amazon QuickSight namespace you created.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name of the new namespace that you created.

" - } - }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.

" - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateRoleMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateRoleMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateRoleMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateRoleMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to add to the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that the role belongs to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to add a group to.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateRoleMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in Amazon QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a template alias for a template.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

Information about the template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

A display name for the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#TemplateSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription field.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTemplateResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template, including the version information of\n\t\t\tthe first version.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The template creation status.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a theme.

\n

A theme is set of configuration options for color and layout.\n\t\t\tThemes apply to analyses and dashboards. For more information, see Using\n\t\t\tThemes in Amazon QuickSight in the Amazon QuickSight User Guide.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a theme alias for a theme.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme alias.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to store the new theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in\n\t\t\teach Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

A display name for the theme.

", - "smithy.api#required": {} - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin an analysis.

", - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the first version of the theme that you're creating. Every time\n\t\t\t\tUpdateTheme is called, a new version is created. Each version of the\n\t\t\ttheme has a description of the version in the VersionDescription\n\t\t\tfield.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

", - "smithy.api#required": {} - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A valid grouping of resource permissions to apply to the new theme.\n\t\t\t

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateThemeResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The theme creation status.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new Q topic.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a topic refresh schedule.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic\n you're creating a refresh schedule for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a topic in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of a topic to create.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" - } - }, - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CreateTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the CreateTopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Dataset arn for the CreateTopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Question": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The Question to be created.

", - "smithy.api#required": {} - } - }, - "Mir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The Mir for the CreateTopicReviewedAnswer.

" - } - }, - "PrimaryVisual": { - "target": "com.amazonaws.quicksight#TopicVisual", - "traits": { - "smithy.api#documentation": "

The PrimaryVisual for the CreateTopicReviewedAnswer.

" - } - }, - "Template": { - "target": "com.amazonaws.quicksight#TopicTemplate", - "traits": { - "smithy.api#documentation": "

The template for the CreateTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a CreateTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#CreateTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswer" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#CreateVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#CreateVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#CreateVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates a new VPC connection.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/vpc-connections", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#CreateVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to create a new VPC\n\t\t\tconnection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

The IAM role to associate with the VPC connection.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags assigned to the VPC\n\t\t\tconnection.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#CreateVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", - "traits": { - "smithy.api#documentation": "

The ID for the VPC connection that\n\t\t\tyou're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services\n\t\t\taccount.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the creation of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#CredentialPair": { - "type": "structure", - "members": { - "Username": { - "target": "com.amazonaws.quicksight#DbUsername", - "traits": { - "smithy.api#documentation": "

User name.

", - "smithy.api#required": {} - } - }, - "Password": { - "target": "com.amazonaws.quicksight#Password", - "traits": { - "smithy.api#documentation": "

Password.

", - "smithy.api#required": {} - } - }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The combination of user name and password that are used as credentials.

" - } - }, - "com.amazonaws.quicksight#CrossDatasetTypes": { - "type": "enum", - "members": { - "ALL_DATASETS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_DATASETS" - } - }, - "SINGLE_DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_DATASET" - } - } - } - }, - "com.amazonaws.quicksight#CurrencyCode": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[A-Z]{3}$" - } - }, - "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the currency format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the currency format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "Symbol": { - "target": "com.amazonaws.quicksight#CurrencyCode", - "traits": { - "smithy.api#documentation": "

Determines the symbol for the currency format.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NumberScale": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

Determines the number scale value for the currency format.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the currency display format configuration.

" - } - }, - "com.amazonaws.quicksight#CustomActionColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#CustomActionFilterOperation": { - "type": "structure", - "members": { - "SelectedFieldsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the fields to be filtered.

", - "smithy.api#required": {} - } - }, - "TargetVisualsConfiguration": { - "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the target visuals to be filtered.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" - } - }, - "com.amazonaws.quicksight#CustomActionNavigationOperation": { - "type": "structure", - "members": { - "LocalNavigationConfiguration": { - "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that chooses the navigation target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CustomActionSetParametersOperation": { - "type": "structure", - "members": { - "ParameterValueConfigurations": { - "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", - "traits": { - "smithy.api#documentation": "

The parameter that determines the value configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" - } - }, - "com.amazonaws.quicksight#CustomActionURLOperation": { - "type": "structure", - "members": { - "URLTemplate": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", - "traits": { - "smithy.api#documentation": "

THe URL link of the CustomActionURLOperation.

", - "smithy.api#required": {} - } - }, - "URLTarget": { - "target": "com.amazonaws.quicksight#URLTargetConfiguration", - "traits": { - "smithy.api#documentation": "

The target of the CustomActionURLOperation.

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" - } - }, - "com.amazonaws.quicksight#CustomColor": { - "type": "structure", - "members": { - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The data value that the color is applied to.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that is applied to the data value.

", - "smithy.api#required": {} - } - }, - "SpecialValue": { - "target": "com.amazonaws.quicksight#SpecialValue", - "traits": { - "smithy.api#documentation": "

The value of a special data value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color that's applied to a particular data value in a column.

" - } - }, - "com.amazonaws.quicksight#CustomColorsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#CustomColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#CustomContentConfiguration": { - "type": "structure", - "members": { - "ContentUrl": { - "target": "com.amazonaws.quicksight#URLOperationTemplate", - "traits": { - "smithy.api#documentation": "

The input URL that links to the custom content that you want in the custom visual.

" - } - }, - "ContentType": { - "target": "com.amazonaws.quicksight#CustomContentType", - "traits": { - "smithy.api#documentation": "

The content type of the custom content visual. You can use this to have the visual render as an image.

" - } - }, - "ImageScaling": { - "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" - } - }, - "com.amazonaws.quicksight#CustomContentImageScalingConfiguration": { - "type": "enum", - "members": { - "FIT_TO_HEIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_HEIGHT" - } - }, - "FIT_TO_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_WIDTH" - } - }, - "DO_NOT_SCALE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOT_SCALE" - } - }, - "SCALE_TO_VISUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCALE_TO_VISUAL" - } - } - } - }, - "com.amazonaws.quicksight#CustomContentType": { - "type": "enum", - "members": { - "IMAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IMAGE" - } - }, - "OTHER_EMBEDDED_CONTENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER_EMBEDDED_CONTENT" - } - } - } - }, - "com.amazonaws.quicksight#CustomContentVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#CustomContentConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#CustomFilterConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValue": { - "target": "com.amazonaws.quicksight#CategoryValue", - "traits": { - "smithy.api#documentation": "

The category value for the filter.

\n

This field is mutually exclusive to ParameterName.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to CategoryValue.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" - } - }, - "com.amazonaws.quicksight#CustomFilterListConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

The list of category values for the filter.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of custom filter values.

" - } - }, - "com.amazonaws.quicksight#CustomLabel": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#CustomNarrativeOptions": { - "type": "structure", - "members": { - "Narrative": { - "target": "com.amazonaws.quicksight#NarrativeString", - "traits": { - "smithy.api#documentation": "

The string input of custom narrative.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom narrative options.

" - } - }, - "com.amazonaws.quicksight#CustomParameterValues": { - "type": "structure", - "members": { - "StringValues": { - "target": "com.amazonaws.quicksight#StringDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of string-type parameter values.

" - } - }, - "IntegerValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of integer-type parameter values.

" - } - }, - "DecimalValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of decimal-type parameter values.

" - } - }, - "DateTimeValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", - "traits": { - "smithy.api#documentation": "

A list of datetime-type parameter values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The customized parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#CustomSql": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#CustomSqlName", - "traits": { - "smithy.api#documentation": "

A display name for the SQL query result.

", - "smithy.api#required": {} - } - }, - "SqlQuery": { - "target": "com.amazonaws.quicksight#SqlQuery", - "traits": { - "smithy.api#documentation": "

The SQL query.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

The column schema from the SQL query result set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" - } - }, - "com.amazonaws.quicksight#CustomSqlName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#CustomValuesConfiguration": { - "type": "structure", - "members": { - "IncludeNullValue": { - "target": "com.amazonaws.quicksight#BooleanObject", - "traits": { - "smithy.api#documentation": "

Includes the null value in custom action parameter values.

" - } - }, - "CustomValues": { - "target": "com.amazonaws.quicksight#CustomParameterValues", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

" - } - }, - "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#Dashboard": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

Dashboard ID.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

A display name for the dashboard.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#DashboardVersion", - "traits": { - "smithy.api#documentation": "

Version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard was created.

" - } - }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was published.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was updated.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard.

" - } - }, - "com.amazonaws.quicksight#DashboardBehavior": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#DashboardError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#DashboardErrorType", - "traits": { - "smithy.api#documentation": "

Type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Message.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

Lists the violated entities that caused the dashboard error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard error.

" - } - }, - "com.amazonaws.quicksight#DashboardErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#DashboardErrorType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "PARAMETER_VALUE_INCOMPATIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" - } - }, - "PARAMETER_TYPE_INVALID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" - } - }, - "PARAMETER_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_NOT_FOUND" - } - }, - "COLUMN_TYPE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" - } - }, - "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" - } - }, - "COLUMN_REPLACEMENT_MISSING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" - } - } - } - }, - "com.amazonaws.quicksight#DashboardFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_USER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DASHBOARD_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHBOARD_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DashboardName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#DashboardPublishOptions": { - "type": "structure", - "members": { - "AdHocFilteringOption": { - "target": "com.amazonaws.quicksight#AdHocFilteringOption", - "traits": { - "smithy.api#documentation": "

Ad hoc (one-time) filtering option.

" - } - }, - "ExportToCSVOption": { - "target": "com.amazonaws.quicksight#ExportToCSVOption", - "traits": { - "smithy.api#documentation": "

Export to .csv option.

" - } - }, - "SheetControlsOption": { - "target": "com.amazonaws.quicksight#SheetControlsOption", - "traits": { - "smithy.api#documentation": "

Sheet controls option.

" - } - }, - "VisualPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardVisualPublishOptions", - "traits": { - "smithy.api#deprecated": { - "message": "VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields." - }, - "smithy.api#documentation": "

The visual publish options of a visual in a dashboard.

" - } - }, - "SheetLayoutElementMaximizationOption": { - "target": "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption", - "traits": { - "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" - } - }, - "VisualMenuOption": { - "target": "com.amazonaws.quicksight#VisualMenuOption", - "traits": { - "smithy.api#documentation": "

The menu options of a visual in a dashboard.

" - } - }, - "VisualAxisSortOption": { - "target": "com.amazonaws.quicksight#VisualAxisSortOption", - "traits": { - "smithy.api#documentation": "

The axis sort options of a dashboard.

" - } - }, - "ExportWithHiddenFieldsOption": { - "target": "com.amazonaws.quicksight#ExportWithHiddenFieldsOption", - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are exported with a dashboard.

" - } - }, - "DataPointDrillUpDownOption": { - "target": "com.amazonaws.quicksight#DataPointDrillUpDownOption", - "traits": { - "smithy.api#documentation": "

The drill-down options of data points in a dashboard.

" - } - }, - "DataPointMenuLabelOption": { - "target": "com.amazonaws.quicksight#DataPointMenuLabelOption", - "traits": { - "smithy.api#documentation": "

The data point menu label options of a dashboard.

" - } - }, - "DataPointTooltipOption": { - "target": "com.amazonaws.quicksight#DataPointTooltipOption", - "traits": { - "smithy.api#documentation": "

The data point tool tip options of a dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard publish options.

" - } - }, - "com.amazonaws.quicksight#DashboardSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"DASHBOARD_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DASHBOARD_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for dashboards.

" - } - }, - "com.amazonaws.quicksight#DashboardSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DashboardSourceEntity": { - "type": "structure", - "members": { - "SourceTemplate": { - "target": "com.amazonaws.quicksight#DashboardSourceTemplate", - "traits": { - "smithy.api#documentation": "

Source template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard source entity.

" - } - }, - "com.amazonaws.quicksight#DashboardSourceTemplate": { - "type": "structure", - "members": { - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

Dataset references.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard source template.

" - } - }, - "com.amazonaws.quicksight#DashboardSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

Dashboard ID.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

A display name for the dashboard.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was updated.

" - } - }, - "PublishedVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Published version number.

" - } - }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dashboard was published.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard summary.

" - } - }, - "com.amazonaws.quicksight#DashboardSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DashboardUIState": { - "type": "enum", - "members": { - "EXPANDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPANDED" - } - }, - "COLLAPSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLAPSED" - } - } - } - }, - "com.amazonaws.quicksight#DashboardVersion": { - "type": "structure", - "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard version was created.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this dashboard version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Version number for this version of the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Source entity ARN.

" - } - }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

Description.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme associated with a version of the dashboard.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard version.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionDefinition": { - "type": "structure", - "members": { - "DataSetIdentifierDeclarations": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of dataset identifier declarations. With\n this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for a dashboard.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the dashboard.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

The filter definitions for a dashboard.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of dashboard-level column configurations. Column configurations\n are used to set the default formatting for a column that\n is used throughout a dashboard.

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for a dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The contents of a dashboard.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dashboard version was created.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Version number.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Source entity ARN.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

Description.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dashboard version summary.

" - } - }, - "com.amazonaws.quicksight#DashboardVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DashboardVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DashboardVisualId": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", - "smithy.api#required": {} - } - }, - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n \n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" - } - }, - "com.amazonaws.quicksight#DashboardVisualPublishOptions": { - "type": "structure", - "members": { - "ExportHiddenFieldsOption": { - "target": "com.amazonaws.quicksight#ExportHiddenFieldsOption", - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" - } - }, - "com.amazonaws.quicksight#DataAggregation": { - "type": "structure", - "members": { - "DatasetRowDateGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultDateColumnName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The column name for the default date.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a data aggregation.

" - } - }, - "com.amazonaws.quicksight#DataBarsOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for the data bars options.

", - "smithy.api#required": {} - } - }, - "PositiveColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the positive data bar.

" - } - }, - "NegativeColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the negative data bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for data bars.

" - } - }, - "com.amazonaws.quicksight#DataColor": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that is applied to the data value.

" - } - }, - "DataValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The data value that the color is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the color that is applied to a particular data value.

" - } - }, - "com.amazonaws.quicksight#DataColorPalette": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#ColorList", - "traits": { - "smithy.api#documentation": "

The hexadecimal codes for the colors.

" - } - }, - "MinMaxGradient": { - "target": "com.amazonaws.quicksight#ColorList", - "traits": { - "smithy.api#documentation": "

The minimum and maximum hexadecimal codes that describe a color gradient.

" - } - }, - "EmptyFillColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

" - } - }, - "com.amazonaws.quicksight#DataFieldSeriesItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that you are setting the axis binding to.

", - "smithy.api#required": {} - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The field value of the field that you are setting the axis binding to.

" - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis that you are binding the field to.

", - "smithy.api#required": {} - } - }, - "Settings": { - "target": "com.amazonaws.quicksight#LineChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data field series item configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#DataLabelContent": { - "type": "enum", - "members": { - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - }, - "VALUE_AND_PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENT" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the data labels.

" - } - }, - "CategoryLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the category field labels.

" - } - }, - "MeasureLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the measure field labels.

" - } - }, - "DataLabelTypes": { - "target": "com.amazonaws.quicksight#DataLabelTypes", - "traits": { - "smithy.api#documentation": "

The option that determines the data label type.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#DataLabelPosition", - "traits": { - "smithy.api#documentation": "

Determines the position of the data labels.

" - } - }, - "LabelContent": { - "target": "com.amazonaws.quicksight#DataLabelContent", - "traits": { - "smithy.api#documentation": "

Determines the content of the data labels.

" - } - }, - "LabelFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

Determines the font configuration of the data labels.

" - } - }, - "LabelColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the data labels.

" - } - }, - "Overlap": { - "target": "com.amazonaws.quicksight#DataLabelOverlap", - "traits": { - "smithy.api#documentation": "

Determines whether overlap is enabled or disabled for the data labels.

" - } - }, - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the total.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "com.amazonaws.quicksight#DataLabelOverlap": { - "type": "enum", - "members": { - "DISABLE_OVERLAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLE_OVERLAP" - } - }, - "ENABLE_OVERLAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLE_OVERLAP" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelPosition": { - "type": "enum", - "members": { - "INSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSIDE" - } - }, - "OUTSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTSIDE" - } - }, - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#DataLabelType": { - "type": "structure", - "members": { - "FieldLabelType": { - "target": "com.amazonaws.quicksight#FieldLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the entire field.

" - } - }, - "DataPathLabelType": { - "target": "com.amazonaws.quicksight#DataPathLabelType", - "traits": { - "smithy.api#documentation": "

The option that specifies individual data values for labels.

" - } - }, - "RangeEndsLabelType": { - "target": "com.amazonaws.quicksight#RangeEndsLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for range end value in a visual.

" - } - }, - "MinimumLabelType": { - "target": "com.amazonaws.quicksight#MinimumLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the minimum value in a visual.

" - } - }, - "MaximumLabelType": { - "target": "com.amazonaws.quicksight#MaximumLabelType", - "traits": { - "smithy.api#documentation": "

Determines the label configuration for the maximum value in a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the data label type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DataLabelTypes": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataLabelType" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DataPathColor": { - "type": "structure", - "members": { - "Element": { - "target": "com.amazonaws.quicksight#DataPathValue", - "traits": { - "smithy.api#documentation": "

The element that the color needs to be applied to.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that needs to be applied to the element.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity of the field that the color needs to be applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color map that determines the color options for a particular element.

" - } - }, - "com.amazonaws.quicksight#DataPathColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataPathColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5000 - } - } - }, - "com.amazonaws.quicksight#DataPathLabelType": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that the data label needs to be applied to.

" - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The actual value of the field that is labeled.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the data label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that specifies individual data values for labels.

" - } - }, - "com.amazonaws.quicksight#DataPathSort": { - "type": "structure", - "members": { - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

Determines the sort direction.

", - "smithy.api#required": {} - } - }, - "SortPaths": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The list of data paths that need to be sorted.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Allows data paths to be sorted by a specific data value.

" - } - }, - "com.amazonaws.quicksight#DataPathType": { - "type": "structure", - "members": { - "PivotTableDataPathType": { - "target": "com.amazonaws.quicksight#PivotTableDataPathType", - "traits": { - "smithy.api#documentation": "

The type of data path value utilized in a pivot table. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of the data path value.

" - } - }, - "com.amazonaws.quicksight#DataPathValue": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field that needs to be sorted.

" - } - }, - "FieldValue": { - "target": "com.amazonaws.quicksight#FieldValue", - "traits": { - "smithy.api#documentation": "

The actual value of the field that needs to be sorted.

" - } - }, - "DataPathType": { - "target": "com.amazonaws.quicksight#DataPathType", - "traits": { - "smithy.api#documentation": "

The type configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data path that needs to be sorted.

" - } - }, - "com.amazonaws.quicksight#DataPathValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataPathValue" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#DataPointDrillUpDownOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the drill down options of data points.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The drill down options for data points in a dashbaord.

" - } - }, - "com.amazonaws.quicksight#DataPointMenuLabelOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the data point menu options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data point menu options of a dashboard.

" - } - }, - "com.amazonaws.quicksight#DataPointTooltipOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the data point tool tip options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data point tooltip options.

" - } - }, - "com.amazonaws.quicksight#DataSet": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the dataset.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dataset was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dataset was updated.

" - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

" - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical\n tables.

" - } - }, - "OutputColumns": { - "target": "com.amazonaws.quicksight#OutputColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" - } - }, - "ConsumedSpiceCapacityInBytes": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

" - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the dataset.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The element you can use to define tags for row-level security.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration", - "traits": { - "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" - } - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that are declared in a dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset.

" - } - }, - "com.amazonaws.quicksight#DataSetArnsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DataSetConfiguration": { - "type": "structure", - "members": { - "Placeholder": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Placeholder.

" - } - }, - "DataSetSchema": { - "target": "com.amazonaws.quicksight#DataSetSchema", - "traits": { - "smithy.api#documentation": "

Dataset schema.

" - } - }, - "ColumnGroupSchemaList": { - "target": "com.amazonaws.quicksight#ColumnGroupSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of column group schemas.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset configuration.

" - } - }, - "com.amazonaws.quicksight#DataSetConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 30 - } - } - }, - "com.amazonaws.quicksight#DataSetFilterAttribute": { - "type": "enum", - "members": { - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DATASET_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DataSetIdentifier": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#DataSetIdentifierDeclaration": { - "type": "structure", - "members": { - "Identifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The identifier of the data set, typically the data set's name.

", - "smithy.api#required": {} - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data set.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A data set.

" - } - }, - "com.amazonaws.quicksight#DataSetIdentifierDeclarationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetIdentifierDeclaration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DataSetImportMode": { - "type": "enum", - "members": { - "SPICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPICE" - } - }, - "DIRECT_QUERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUERY" - } - } - } - }, - "com.amazonaws.quicksight#DataSetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DataSetReference": { - "type": "structure", - "members": { - "DataSetPlaceholder": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Dataset placeholder.

", - "smithy.api#required": {} - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

Dataset Amazon Resource Name (ARN).

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset reference.

" - } - }, - "com.amazonaws.quicksight#DataSetReferenceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetReference" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#DataSetRefreshProperties": { - "type": "structure", - "members": { - "RefreshConfiguration": { - "target": "com.amazonaws.quicksight#RefreshConfiguration", - "traits": { - "smithy.api#documentation": "

The refresh configuration for a dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh properties of a dataset.

" - } - }, - "com.amazonaws.quicksight#DataSetRegion": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#DataSetSchema": { - "type": "structure", - "members": { - "ColumnSchemaList": { - "target": "com.amazonaws.quicksight#ColumnSchemaList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of column schemas.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset schema.

" - } - }, - "com.amazonaws.quicksight#DataSetSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose datasets you want to search in the \"Value\" field. For example, \"Name\":\"QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east- 1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the datasets you are searching for. For example, \"Name\":\"DATASET_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASET_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DataSetFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for datasets.

" - } - }, - "com.amazonaws.quicksight#DataSetSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DataSetSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the dataset.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this dataset was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this dataset was updated.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the dataset.

" - } - }, - "RowLevelPermissionTagConfigurationApplied": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Whether or not the row level permission tags are applied.

" - } - }, - "ColumnLevelPermissionRulesApplied": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A value that indicates if the dataset has column level permission configured.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Dataset summary.

" - } - }, - "com.amazonaws.quicksight#DataSetSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSetSummary" - } - }, - "com.amazonaws.quicksight#DataSetUsageConfiguration": { - "type": "structure", - "members": { - "DisableUseAsDirectQuerySource": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

" - } - }, - "DisableUseAsImportedSource": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" - } - }, - "com.amazonaws.quicksight#DataSource": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each\n Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source. This type indicates which database engine the data source\n connects to.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this data source was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this data source was updated.

" - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.

" - } - }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n Amazon QuickSight to use a VPC connection when connecting to your underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying source.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfo", - "traits": { - "smithy.api#documentation": "

Error information from the last update or the creation of the data source.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure of a data source.

" - } - }, - "com.amazonaws.quicksight#DataSourceCredentials": { - "type": "structure", - "members": { - "CredentialPair": { - "target": "com.amazonaws.quicksight#CredentialPair", - "traits": { - "smithy.api#documentation": "

Credential pair. For more information, see\n \n CredentialPair\n .

" - } - }, - "CopySourceArn": { - "target": "com.amazonaws.quicksight#CopySourceArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

" - } - }, - "SecretArn": { - "target": "com.amazonaws.quicksight#SecretArn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#DataSourceErrorInfo": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfoType", - "traits": { - "smithy.api#documentation": "

Error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error information for the data source creation or update.

" - } - }, - "com.amazonaws.quicksight#DataSourceErrorInfoType": { - "type": "enum", - "members": { - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - }, - "COPY_SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COPY_SOURCE_NOT_FOUND" - } - }, - "TIMEOUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMEOUT" - } - }, - "ENGINE_VERSION_NOT_SUPPORTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENGINE_VERSION_NOT_SUPPORTED" - } - }, - "UNKNOWN_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN_HOST" - } - }, - "GENERIC_SQL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GENERIC_SQL_FAILURE" - } - }, - "CONFLICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONFLICT" - } - }, - "UNKNOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNKNOWN" - } - } - } - }, - "com.amazonaws.quicksight#DataSourceFilterAttribute": { - "type": "enum", - "members": { - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DATASOURCE_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASOURCE_NAME" - } - } - } - }, - "com.amazonaws.quicksight#DataSourceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSource" - } - }, - "com.amazonaws.quicksight#DataSourceParameters": { - "type": "union", - "members": { - "AmazonElasticsearchParameters": { - "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "AthenaParameters": { - "target": "com.amazonaws.quicksight#AthenaParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Athena.

" - } - }, - "AuroraParameters": { - "target": "com.amazonaws.quicksight#AuroraParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Aurora MySQL.

" - } - }, - "AuroraPostgreSqlParameters": { - "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Aurora.

" - } - }, - "AwsIotAnalyticsParameters": { - "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", - "traits": { - "smithy.api#documentation": "

The parameters for IoT Analytics.

" - } - }, - "JiraParameters": { - "target": "com.amazonaws.quicksight#JiraParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Jira.

" - } - }, - "MariaDbParameters": { - "target": "com.amazonaws.quicksight#MariaDbParameters", - "traits": { - "smithy.api#documentation": "

The parameters for MariaDB.

" - } - }, - "MySqlParameters": { - "target": "com.amazonaws.quicksight#MySqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for MySQL.

" - } - }, - "OracleParameters": { - "target": "com.amazonaws.quicksight#OracleParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Oracle.

" - } - }, - "PostgreSqlParameters": { - "target": "com.amazonaws.quicksight#PostgreSqlParameters", - "traits": { - "smithy.api#documentation": "

The parameters for PostgreSQL.

" - } - }, - "PrestoParameters": { - "target": "com.amazonaws.quicksight#PrestoParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Presto.

" - } - }, - "RdsParameters": { - "target": "com.amazonaws.quicksight#RdsParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon RDS.

" - } - }, - "RedshiftParameters": { - "target": "com.amazonaws.quicksight#RedshiftParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Redshift.

" - } - }, - "S3Parameters": { - "target": "com.amazonaws.quicksight#S3Parameters", - "traits": { - "smithy.api#documentation": "

The parameters for S3.

" - } - }, - "ServiceNowParameters": { - "target": "com.amazonaws.quicksight#ServiceNowParameters", - "traits": { - "smithy.api#documentation": "

The parameters for ServiceNow.

" - } - }, - "SnowflakeParameters": { - "target": "com.amazonaws.quicksight#SnowflakeParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Snowflake.

" - } - }, - "SparkParameters": { - "target": "com.amazonaws.quicksight#SparkParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Spark.

" - } - }, - "SqlServerParameters": { - "target": "com.amazonaws.quicksight#SqlServerParameters", - "traits": { - "smithy.api#documentation": "

The parameters for SQL Server.

" - } - }, - "TeradataParameters": { - "target": "com.amazonaws.quicksight#TeradataParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Teradata.

" - } - }, - "TwitterParameters": { - "target": "com.amazonaws.quicksight#TwitterParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Twitter.

" - } - }, - "AmazonOpenSearchParameters": { - "target": "com.amazonaws.quicksight#AmazonOpenSearchParameters", - "traits": { - "smithy.api#documentation": "

The parameters for OpenSearch.

" - } - }, - "ExasolParameters": { - "target": "com.amazonaws.quicksight#ExasolParameters", - "traits": { - "smithy.api#documentation": "

The parameters for Exasol.

" - } - }, - "DatabricksParameters": { - "target": "com.amazonaws.quicksight#DatabricksParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" - } - }, - "StarburstParameters": { - "target": "com.amazonaws.quicksight#StarburstParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" - } - }, - "TrinoParameters": { - "target": "com.amazonaws.quicksight#TrinoParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" - } - }, - "BigQueryParameters": { - "target": "com.amazonaws.quicksight#BigQueryParameters", - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#DataSourceParametersList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceParameters" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DataSourceSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose data sources you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the data sources you are searching for. For example, \"Name\":\"DATASOURCE_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASOURCE_NAME.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DataSourceFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"DIRECT_QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that you apply when searching for data sources.

" - } - }, - "com.amazonaws.quicksight#DataSourceSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DataSourceSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The arn of the datasource.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The unique ID of the data source.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the data source.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", - "traits": { - "smithy.api#documentation": "

The type of the data source.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A DataSourceSummary object that returns a summary of a data source.

" - } - }, - "com.amazonaws.quicksight#DataSourceSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DataSourceSummary" - } - }, - "com.amazonaws.quicksight#DataSourceType": { - "type": "enum", - "members": { - "ADOBE_ANALYTICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADOBE_ANALYTICS" - } - }, - "AMAZON_ELASTICSEARCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_ELASTICSEARCH" - } - }, - "ATHENA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATHENA" - } - }, - "AURORA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AURORA" - } - }, - "AURORA_POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AURORA_POSTGRESQL" - } - }, - "AWS_IOT_ANALYTICS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AWS_IOT_ANALYTICS" - } - }, - "GITHUB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GITHUB" - } - }, - "JIRA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIRA" - } - }, - "MARIADB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MARIADB" - } - }, - "MYSQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MYSQL" - } - }, - "ORACLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ORACLE" - } - }, - "POSTGRESQL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTGRESQL" - } - }, - "PRESTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRESTO" - } - }, - "REDSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDSHIFT" - } - }, - "S3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3" - } - }, - "SALESFORCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SALESFORCE" - } - }, - "SERVICENOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SERVICENOW" - } - }, - "SNOWFLAKE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SNOWFLAKE" - } - }, - "SPARK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPARK" - } - }, - "SQLSERVER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQLSERVER" - } - }, - "TERADATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TERADATA" - } - }, - "TWITTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TWITTER" - } - }, - "TIMESTREAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TIMESTREAM" - } - }, - "AMAZON_OPENSEARCH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AMAZON_OPENSEARCH" - } - }, - "EXASOL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXASOL" - } - }, - "DATABRICKS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATABRICKS" - } - }, - "STARBURST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARBURST" - } - }, - "TRINO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRINO" - } - }, - "BIGQUERY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIGQUERY" - } - } - } - }, - "com.amazonaws.quicksight#Database": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DatabaseGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DatabaseGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatabaseGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#DatabaseUser": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DatabricksParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Databricks data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Databricks data source.

", - "smithy.api#required": {} - } - }, - "SqlEndpointPath": { - "target": "com.amazonaws.quicksight#SqlEndpointPath", - "traits": { - "smithy.api#documentation": "

The HTTP path of the Databricks data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" - } - }, - "com.amazonaws.quicksight#DatasetMetadata": { - "type": "structure", - "members": { - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", - "smithy.api#required": {} - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "DatasetDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the dataset.

" - } - }, - "DataAggregation": { - "target": "com.amazonaws.quicksight#DataAggregation", - "traits": { - "smithy.api#documentation": "

The definition of a data aggregation.

" - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#TopicFilters", - "traits": { - "smithy.api#documentation": "

The list of filter definitions.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#TopicColumns", - "traits": { - "smithy.api#documentation": "

The list of column definitions.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#TopicCalculatedFields", - "traits": { - "smithy.api#documentation": "

The list of calculated field definitions.

" - } - }, - "NamedEntities": { - "target": "com.amazonaws.quicksight#TopicNamedEntities", - "traits": { - "smithy.api#documentation": "

The list of named entities definitions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a dataset.

" - } - }, - "com.amazonaws.quicksight#DatasetParameter": { - "type": "structure", - "members": { - "StringDatasetParameter": { - "target": "com.amazonaws.quicksight#StringDatasetParameter", - "traits": { - "smithy.api#documentation": "

A string parameter that is created in the dataset.

" - } - }, - "DecimalDatasetParameter": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameter", - "traits": { - "smithy.api#documentation": "

A decimal parameter that is created in the dataset.

" - } - }, - "IntegerDatasetParameter": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameter", - "traits": { - "smithy.api#documentation": "

An integer parameter that is created in the dataset.

" - } - }, - "DateTimeDatasetParameter": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameter", - "traits": { - "smithy.api#documentation": "

A date time parameter that is created in the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

" - } - }, - "com.amazonaws.quicksight#DatasetParameterId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-]+$" - } - }, - "com.amazonaws.quicksight#DatasetParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatasetParameter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DatasetParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.quicksight#DatasetParameterValueType": { - "type": "enum", - "members": { - "MULTI_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_VALUED" - } - }, - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

" - } - }, - "com.amazonaws.quicksight#Datasets": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DatasetMetadata" - } - }, - "com.amazonaws.quicksight#DateAggregationFunction": { - "type": "enum", - "members": { - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - } - } - }, - "com.amazonaws.quicksight#DateAxisOptions": { - "type": "structure", - "members": { - "MissingDateVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not missing dates are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine how a date axis is displayed.

" - } - }, - "com.amazonaws.quicksight#DateDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the DateDimensionField.

", - "smithy.api#required": {} - } - }, - "DateGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The date granularity of the DateDimensionField. Choose one of the following options:

\n " - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with date type columns.

" - } - }, - "com.amazonaws.quicksight#DateMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the DateMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#DateAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with date type columns.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the date time parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity of the date time parameter.

" - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given date time parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A date time parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue": { - "type": "timestamp", - "traits": { - "smithy.api#documentation": "

The default value for the date time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a date time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DateTimeDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#DateTimeDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DataTimeDefaultValues.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the DateTimeParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#DateTimeFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#DateTimeFormatConfiguration": { - "type": "structure", - "members": { - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Determines the DateTime format.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "NumericFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The formatting configuration for numeric DateTime fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" - } - }, - "com.amazonaws.quicksight#DateTimeHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the DateTime hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the\n DateTime hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for the date-time parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveTimestampList", - "traits": { - "smithy.api#documentation": "

The values for the date-time parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A date-time parameter.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameterDeclaration": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DateTimeDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" - } - }, - "com.amazonaws.quicksight#DateTimeParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DateTimeParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Customize how dates are formatted in controls.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - }, - "HelperTextVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The helper text visibility of the DateTimePickerControlDisplayOptions.

" - } - }, - "DateIconVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The date icon visibility of the DateTimePickerControlDisplayOptions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp", - "traits": { - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#DayOfMonth": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 17 - }, - "smithy.api#pattern": "^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$" - } - }, - "com.amazonaws.quicksight#DayOfTheWeek": { - "type": "enum", - "members": { - "SUNDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUNDAY" - } - }, - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } - }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } - }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } - }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } - }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } - }, - "SATURDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SATURDAY" - } - } - } - }, - "com.amazonaws.quicksight#DayOfWeek": { - "type": "enum", - "members": { - "SUNDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUNDAY" - } - }, - "MONDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONDAY" - } - }, - "TUESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TUESDAY" - } - }, - "WEDNESDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEDNESDAY" - } - }, - "THURSDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THURSDAY" - } - }, - "FRIDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRIDAY" - } - }, - "SATURDAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SATURDAY" - } - } - } - }, - "com.amazonaws.quicksight#DbUsername": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the decimal parameter created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the decimal parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given decimal parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A decimal parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The default value for the decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#DecimalDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveDoubleObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#DecimalDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the DecimalParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#DecimalParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for the decimal parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveDoubleList", - "traits": { - "smithy.api#documentation": "

The values for the decimal parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A decimal parameter.

" - } - }, - "com.amazonaws.quicksight#DecimalParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#DecimalDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" - } - }, - "com.amazonaws.quicksight#DecimalParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DecimalParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#DecimalPlaces": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#DecimalPlacesConfiguration": { - "type": "structure", - "members": { - "DecimalPlaces": { - "target": "com.amazonaws.quicksight#DecimalPlaces", - "traits": { - "smithy.api#documentation": "

The values of the decimal places.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveDouble", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#DefaultAggregation": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - } - } - }, - "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", - "traits": { - "smithy.api#documentation": "

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

\n " - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterControlConfiguration": { - "type": "structure", - "members": { - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

", - "smithy.api#required": {} - } - }, - "ControlOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterControlOptions", - "traits": { - "smithy.api#documentation": "

The control option for the DefaultFilterControlConfiguration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The default configuration for all dependent controls of the filter.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterControlOptions": { - "type": "structure", - "members": { - "DefaultDateTimePickerOptions": { - "target": "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" - } - }, - "DefaultListOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterListControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" - } - }, - "DefaultDropdownOptions": { - "target": "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" - } - }, - "DefaultTextFieldOptions": { - "target": "com.amazonaws.quicksight#DefaultTextFieldControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" - } - }, - "DefaultTextAreaOptions": { - "target": "com.amazonaws.quicksight#DefaultTextAreaControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" - } - }, - "DefaultSliderOptions": { - "target": "com.amazonaws.quicksight#DefaultSliderControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" - } - }, - "DefaultRelativeDateTimeOptions": { - "target": "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions", - "traits": { - "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that corresponds to the control type of the filter.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultFilterListControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the DefaultFilterListControlOptions. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultFormatting": { - "type": "structure", - "members": { - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format. Valid values for this structure are AUTO,\n PERCENT, CURRENCY, NUMBER, DATE, and\n STRING.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions", - "traits": { - "smithy.api#documentation": "

The additional options for display formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a default formatting definition.

" - } - }, - "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a free-form layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultGridLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a grid layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration": { - "type": "structure", - "members": { - "Grid": { - "target": "com.amazonaws.quicksight#DefaultGridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" - } - }, - "FreeForm": { - "target": "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultNewSheetConfiguration": { - "type": "structure", - "members": { - "InteractiveLayoutConfiguration": { - "target": "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" - } - }, - "PaginatedLayoutConfiguration": { - "target": "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" - } - }, - "SheetContentType": { - "target": "com.amazonaws.quicksight#SheetContentType", - "traits": { - "smithy.api#documentation": "

The option that determines the sheet content type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for default new sheet settings.

" - } - }, - "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration": { - "type": "structure", - "members": { - "SectionBased": { - "target": "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration": { - "type": "structure", - "members": { - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

Determines the screen canvas size options for a section-based layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" - } - }, - "com.amazonaws.quicksight#DefaultSliderControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlSliderType", - "traits": { - "smithy.api#documentation": "

The type of the DefaultSliderControlOptions. Choose one of the following options:

\n " - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultTextAreaControlOptions": { - "type": "structure", - "members": { - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" - } - }, - "com.amazonaws.quicksight#DefaultTextFieldControlOptions": { - "type": "structure", - "members": { - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're deleting the customizations from.

", - "smithy.api#httpQuery": "namespace" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DeleteAccountSubscription 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 True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, Amazon QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to delete an analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RecoveryWindowInDays": { - "target": "com.amazonaws.quicksight#RecoveryWindowInDays", - "traits": { - "smithy.api#documentation": "

A value that specifies the number of days that Amazon QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", - "smithy.api#httpQuery": "recovery-window-in-days" - } - }, - "ForceDeleteWithoutRecovery": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

This option defaults to the value NoForceDeleteWithoutRecovery. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery option.\n You can't restore an analysis after it's deleted.

", - "smithy.api#httpQuery": "force-delete-without-recovery" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteAnalysisResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted analysis.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the deleted analysis.

" - } - }, - "DeletionTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the analysis is scheduled to be deleted.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a dashboard.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDashboardResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Secure Socket Layer (SSL) properties that apply for the resource.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the dataset refresh properties of the dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the data source permanently. This operation breaks \n\t\t\tall the datasets that reference the deleted data source.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source that you deleted.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an empty folder.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteFolderMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteFolderMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteFolderMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteFolderMembershipRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Folder ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the asset that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The member type of the asset that you want to delete from a folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderMembershipResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name of the deleted folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to remove a user from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteGroupResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes an existing IAM policy assignment.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID where you want to delete the IAM\n\t\t\tpolicy assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteNamespaceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a refresh schedule from a dataset.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes custom permissions from the role.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to remove permissions from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteRoleMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteRoleMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a group from a role.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteRoleMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The role that you want to remove permissions from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteRoleMembershipResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a template.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the item that the specified template alias points to. If you provide a specific\n\t\t\talias, you delete the version of the template that the alias points to.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the item to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template that the specified alias is for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the template alias. To delete a specific alias, you delete the version that the\n\t\t\talias points to. You can specify the alias name, or specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template associated with the deletion.

" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the template alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template you want to delete.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template.\n\t

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTemplateResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the template.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a theme.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the version of the theme that the specified theme alias points to. \n\t\t\tIf you provide a specific alias, you delete the version of the theme \n\t\t\tthat the alias points to.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme that the specified alias is for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The unique name for the theme alias to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeAliasResponse": { - "type": "structure", - "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name for the theme alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme associated with the deletion.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're deleting.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version of the theme that you want to delete.

\n

\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme to delete all versions of the theme.

", - "smithy.api#httpQuery": "version-number" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteThemeResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the theme.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic refresh schedule.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes the Amazon QuickSight user that is associated with the identity of the\n\t\t\tIAM user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalId": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a user identified by its principal ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest": { - "type": "structure", - "members": { - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

", - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to delete.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteUserResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DeleteVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DeleteVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DeleteVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a VPC connection.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DeleteVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to delete a VPC\n\t\t\tconnection.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DeleteVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

" - } - }, - "DeletionStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The deletion status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Delimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations\n for.

", - "smithy.api#httpQuery": "namespace" - } - }, - "Resolved": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of Amazon QuickSight customizations is returned. You can add this flag to your command to use\n the same view that Amazon QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", - "smithy.api#httpQuery": "resolved" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you're describing.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that you're describing.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the settings that were used when your Amazon QuickSight subscription was first\n created in this Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/settings", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the settings that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { - "type": "structure", - "members": { - "AccountSettings": { - "target": "com.amazonaws.quicksight#AccountSettings", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the Amazon QuickSight subscription.

\n

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the Amazon QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscription": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", - "smithy.api#http": { - "method": "GET", - "uri": "/account/{AwsAccountId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse": { - "type": "structure", - "members": { - "AccountInfo": { - "target": "com.amazonaws.quicksight#AccountInfo", - "traits": { - "smithy.api#documentation": "

A structure that contains the following elements:

\n " - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary of the metadata for an analysis.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of an analysis.

\n \n

If you do not need to know details about the content of an Analysis, for instance if you\n are trying to check the status of a recently created or updated Analysis, use the\n \n DescribeAnalysis\n instead.\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the\n Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis described.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the analysis.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AnalysisErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the analysis.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the analysis.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the analysis.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides the read and write permissions for an analysis.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n describing. You must be using the Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { - "type": "structure", - "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing.

" - } - }, - "AnalysisArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis whose permissions you're\n describing.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the \n Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAnalysisResponse": { - "type": "structure", - "members": { - "Analysis": { - "target": "com.amazonaws.quicksight#Analysis", - "traits": { - "smithy.api#documentation": "

A metadata structure that contains summary information for the analysis that you're\n describing.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing export job.

\n

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

\n

Job descriptions are available for 14 days after the job starts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the export job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

" - } - }, - "DownloadUrl": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

The URL to download the exported asset bundle data from.

\n

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

\n

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

\n

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the export job was created.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export job was executed in.

" - } - }, - "ResourceArns": { - "target": "com.amazonaws.quicksight#AssetBundleResourceArns", - "traits": { - "smithy.api#documentation": "

A list of resource ARNs that exported with the job.

" - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include dependencies flag.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

" - } - }, - "CloudFormationOverridePropertyConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", - "traits": { - "smithy.api#documentation": "

The CloudFormation override property configuration for the export job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include permissions flag.

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The include tags flag.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", - "traits": { - "smithy.api#documentation": "

The validation strategy that is used to export the analysis or dashboard.

" - } - }, - "Warnings": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobWarningList", - "traits": { - "smithy.api#documentation": "

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

\n

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing import job.

\n

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse": { - "type": "structure", - "members": { - "JobStatus": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

\n " - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" - } - }, - "RollbackErrors": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", - "traits": { - "smithy.api#documentation": "

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the import job was created.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

" - } - }, - "AssetBundleImportSource": { - "target": "com.amazonaws.quicksight#AssetBundleImportSourceDescription", - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that is imported by the job.

" - } - }, - "OverrideParameters": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", - "traits": { - "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - }, - "OverridePermissions": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", - "traits": { - "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideTags": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", - "traits": { - "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

" - } - }, - "Warnings": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobWarningList", - "traits": { - "smithy.api#documentation": "

An array of warning records that describe all permitted errors that are encountered during the import job.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary for a dashboard.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of a dashboard.

\n \n

If you do not need to know details about the content of a dashboard, for instance if you\n are trying to check the status of a recently created or updated dashboard, use the\n \n DescribeDashboard\n instead.\n

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias name.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard described.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this dashboard version.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the dashboard version.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard:

\n " - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes read and write permissions for a dashboard.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're describing\n permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions for the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shareable link that grants access to\n the dashboard. Your users can use the link to view and interact with the dashboard, if\n the dashboard has been shared with them. For more information about sharing dashboards,\n see Sharing Dashboards.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias name.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardResponse": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#Dashboard", - "traits": { - "smithy.api#documentation": "

Information about the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of this request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing snapshot job.

\n

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.\n

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

" - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "UserConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted", - "traits": { - "smithy.api#documentation": "

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

" - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotConfiguration", - "traits": { - "smithy.api#documentation": "

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "JobStatus": { - "target": "com.amazonaws.quicksight#SnapshotJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

\n " - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time that the snapshot job was created.\n

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

\n The time that the snapshot job status was last updated.\n

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the result of an existing snapshot job that has finished running.

\n

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

\n

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "JobStatus": { - "target": "com.amazonaws.quicksight#SnapshotJobStatus", - "traits": { - "smithy.api#documentation": "

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that a snapshot job was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that a snapshot job status was last updated.

" - } - }, - "Result": { - "target": "com.amazonaws.quicksight#SnapshotJobResult", - "traits": { - "smithy.api#documentation": "

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#SnapshotJobErrorInfo", - "traits": { - "smithy.api#documentation": "

Displays information for the error that caused a job to fail.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the dataset.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSetResponse": { - "type": "structure", - "members": { - "DataSet": { - "target": "com.amazonaws.quicksight#DataSet", - "traits": { - "smithy.api#documentation": "

Information on the dataset.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a data source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the resource permissions for a data source.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeDataSourceResponse": { - "type": "structure", - "members": { - "DataSource": { - "target": "com.amazonaws.quicksight#DataSource", - "traits": { - "smithy.api#documentation": "

The information on the data source.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes permissions for a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Permissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", - "smithy.api#httpQuery": "namespace" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions on the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Permissions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", - "smithy.api#httpQuery": "namespace" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions for the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Folder": { - "target": "com.amazonaws.quicksight#Folder", - "traits": { - "smithy.api#documentation": "

Information about the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeGroupMembership": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeGroupMembershipRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeGroupMembershipResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the DescribeGroupMembership operation to determine if a user is a\n\t\t\tmember of the specified group. If the user exists and is a member of the specified\n\t\t\tgroup, an associated GroupMember object is returned.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeGroupMembershipRequest": { - "type": "structure", - "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The user name of the user that you want to search for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to search.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the group you are searching within.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupMembershipResponse": { - "type": "structure", - "members": { - "GroupMember": { - "target": "com.amazonaws.quicksight#GroupMember" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "IAMPolicyAssignment": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignment", - "traits": { - "smithy.api#documentation": "

Information describing the IAM policy assignment.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIngestion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIngestionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIngestionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a SPICE ingestion.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIngestionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

An ID for the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIngestionResponse": { - "type": "structure", - "members": { - "Ingestion": { - "target": "com.amazonaws.quicksight#Ingestion", - "traits": { - "smithy.api#documentation": "

Information about the ingestion.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeIpRestriction": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary and status of IP rules.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/ip-restriction", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" - } - }, - "IpRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map that describes the IP rules with CIDR range and description.

" - } - }, - "VpcIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC IDs and their rule descriptions.

" - } - }, - "VpcEndpointIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their rule descriptions.

" - } - }, - "Enabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.\n\t\t\t

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeKeyRegistrationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeKeyRegistrationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes all customer managed key registrations in a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/key-registration", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistrationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultKeyOnly": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Determines whether the request returns the default key only.

", - "smithy.api#httpQuery": "default-key-only" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeKeyRegistrationResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

" - } - }, - "KeyRegistration": { - "target": "com.amazonaws.quicksight#KeyRegistration", - "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeNamespace": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the current namespace.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeNamespaceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeNamespaceResponse": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2", - "traits": { - "smithy.api#documentation": "

The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a summary of a refresh schedule.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { - "type": "structure", - "members": { - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes all custom permissions that are mapped to a role.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of the role whose permissions you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the custom permission that is described.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a template's metadata.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the template alias for a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're\n\t\t\tdescribing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

Information about the template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinition": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Provides a detailed description of the definition of a template.

\n \n

If you do not need to know details about the content of a template, for instance if you\n\t\t\t\tare trying to check the status of a recently created or updated template, use the\n\t\t\t\t\n DescribeTemplate\n instead.\n\t\t\t

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/definition", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template. You must be using the\n\t\t\t Amazon Web Services account that the template is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\t describe the version that the alias points to. You can specify the latest version of the\n\t\t\t template by providing the keyword $LATEST in the AliasName\n\t\t\t parameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The descriptive name of the template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template described.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#TemplateErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the template version.

" - } - }, - "ResourceStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

Status associated with the template.

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme of the template.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of the template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes read and write permissions on a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "TemplateArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

(Optional) The number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the template is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTemplateResponse": { - "type": "structure", - "members": { - "Template": { - "target": "com.amazonaws.quicksight#Template", - "traits": { - "smithy.api#documentation": "

The template structure for the object you want to describe.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the alias for a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're\n\t\t\tdescribing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the theme alias that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeThemePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeThemePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeThemePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the read and write permissions for a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeThemePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme that you want to describe permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions set on the theme.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAndAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the theme is described.

", - "smithy.api#httpQuery": "version-number" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

", - "smithy.api#httpQuery": "alias-name" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeThemeResponse": { - "type": "structure", - "members": { - "Theme": { - "target": "com.amazonaws.quicksight#Theme", - "traits": { - "smithy.api#documentation": "

The information about the theme that you are describing.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the permissions of a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want\n described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicPermissionsResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that are configured to the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefresh": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes the status of a topic refresh.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh you want\n to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RefreshId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the refresh, which is performed when the topic is created or updated.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshResponse": { - "type": "structure", - "members": { - "RefreshDetails": { - "target": "com.amazonaws.quicksight#TopicRefreshDetails", - "traits": { - "smithy.api#documentation": "

Details of the refresh, which is performed when the topic is created or updated.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Deletes a topic refresh schedule.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeTopicResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of a topic.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns information about a user, given the user name.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user that you want to describe.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The user name.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DescribeVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#DescribeVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#DescribeVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Describes a VPC connection.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#DescribeVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#DescribeVPCConnectionResponse": { - "type": "structure", - "members": { - "VPCConnection": { - "target": "com.amazonaws.quicksight#VPCConnection", - "traits": { - "smithy.api#documentation": "

A response object that provides information for the specified VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { - "type": "structure", - "members": { - "CustomValuesConfiguration": { - "target": "com.amazonaws.quicksight#CustomValuesConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

" - } - }, - "SelectAllValueOptions": { - "target": "com.amazonaws.quicksight#SelectAllValueOptions", - "traits": { - "smithy.api#documentation": "

The configuration that selects all options.

" - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The source parameter name of the destination parameter.

" - } - }, - "SourceField": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The source field ID of the destination parameter.

" - } - }, - "SourceColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of destination parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DimensionField": { - "type": "structure", - "members": { - "NumericalDimensionField": { - "target": "com.amazonaws.quicksight#NumericalDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with numerical type columns.

" - } - }, - "CategoricalDimensionField": { - "target": "com.amazonaws.quicksight#CategoricalDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with categorical type columns.

" - } - }, - "DateDimensionField": { - "target": "com.amazonaws.quicksight#DateDimensionField", - "traits": { - "smithy.api#documentation": "

The dimension type field with date type columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field.

" - } - }, - "com.amazonaws.quicksight#DimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#DisplayFormat": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "PERCENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT" - } - }, - "CURRENCY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURRENCY" - } - }, - "NUMBER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMBER" - } - }, - "DATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE" - } - }, - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - } - } - }, - "com.amazonaws.quicksight#DisplayFormatOptions": { - "type": "structure", - "members": { - "UseBlankCellFormat": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to use blank cell format.

" - } - }, - "BlankCellFormat": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the blank cell format.

" - } - }, - "DateFormat": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the DateTime format.

" - } - }, - "DecimalSeparator": { - "target": "com.amazonaws.quicksight#TopicNumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the decimal separator.

" - } - }, - "GroupingSeparator": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

Determines the grouping separator.

" - } - }, - "UseGrouping": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to use grouping.

" - } - }, - "FractionDigits": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Determines the number of fraction digits.

" - } - }, - "Prefix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The prefix value for a display format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The suffix value for a display format.

" - } - }, - "UnitScaler": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

The unit scaler. Valid values for this structure are: NONE,\n AUTO, THOUSANDS, MILLIONS,\n BILLIONS,\n and TRILLIONS.

" - } - }, - "NegativeFormat": { - "target": "com.amazonaws.quicksight#NegativeFormat", - "traits": { - "smithy.api#documentation": "

The negative format.

" - } - }, - "CurrencySymbol": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The currency symbol, such as USD.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents additional options for display formatting.

" - } - }, - "com.amazonaws.quicksight#DnsResolverList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IPv4Address" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#Domain": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#DomainNotWhitelistedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The domain specified isn't on the allow list. All domains for embedded dashboards must be\n\t\t\tadded to the approved list by an Amazon QuickSight admin.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#DonutCenterOptions": { - "type": "structure", - "members": { - "LabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" - } - }, - "com.amazonaws.quicksight#DonutOptions": { - "type": "structure", - "members": { - "ArcOptions": { - "target": "com.amazonaws.quicksight#ArcOptions", - "traits": { - "smithy.api#documentation": "

The option for define the arc of the chart shape. Valid values are as follows:

\n " - } - }, - "DonutCenterOptions": { - "target": "com.amazonaws.quicksight#DonutCenterOptions", - "traits": { - "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for configuring a donut chart or pie chart.

" - } - }, - "com.amazonaws.quicksight#Double": { - "type": "double", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#DrillDownFilter": { - "type": "structure", - "members": { - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#NumericEqualityDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The numeric equality type drill down filter. This filter is used for number type columns.

" - } - }, - "CategoryFilter": { - "target": "com.amazonaws.quicksight#CategoryDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The category type drill down filter. This filter is used for string type columns.

" - } - }, - "TimeRangeFilter": { - "target": "com.amazonaws.quicksight#TimeRangeDrillDownFilter", - "traits": { - "smithy.api#documentation": "

The time range drill down filter. This filter is used for date time columns.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The drill down filter for the column hierarchies.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#DrillDownFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DrillDownFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#DropDownControlDisplayOptions": { - "type": "structure", - "members": { - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a\n dropdown control.

" - } - }, - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#DynamicDefaultValue": { - "type": "structure", - "members": { - "UserNameColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the username.

" - } - }, - "GroupNameColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the group name.

" - } - }, - "DefaultValueColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that contains the default value of each user or group.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Defines different defaults to the users or groups based on mapping.

" - } - }, - "com.amazonaws.quicksight#Edition": { - "type": "enum", - "members": { - "STANDARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STANDARD" - } - }, - "ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE" - } - }, - "ENTERPRISE_AND_Q": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE_AND_Q" - } - } - } - }, - "com.amazonaws.quicksight#EmbeddingIdentityType": { - "type": "enum", - "members": { - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - }, - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "ANONYMOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANONYMOUS" - } - } - } - }, - "com.amazonaws.quicksight#EmbeddingUrl": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#EmptyVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in the empty visual. Every visual requires a dataset to render.

", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An empty visual.

\n

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 EmptyVisual until a visual type is selected.

" - } - }, - "com.amazonaws.quicksight#Entity": { - "type": "structure", - "members": { - "Path": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object, structure, or sub-structure of an analysis, template, or dashboard.

" - } - }, - "com.amazonaws.quicksight#EntityList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Entity" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#EntryPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#EntryPoint": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#ErrorInfo": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#IngestionErrorType", - "traits": { - "smithy.api#documentation": "

Error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Error information for the SPICE ingestion of a dataset.

" - } - }, - "com.amazonaws.quicksight#ExasolParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The hostname or IP address of the Exasol data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Exasol data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The required parameters for connecting to an Exasol data source.

" - } - }, - "com.amazonaws.quicksight#ExceptionResourceType": { - "type": "enum", - "members": { - "USER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "USER" - } - }, - "GROUP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GROUP" - } - }, - "NAMESPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMESPACE" - } - }, - "ACCOUNT_SETTINGS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_SETTINGS" - } - }, - "IAMPOLICY_ASSIGNMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAMPOLICY_ASSIGNMENT" - } - }, - "DATA_SOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE" - } - }, - "DATA_SET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET" - } - }, - "VPC_CONNECTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VPC_CONNECTION" - } - }, - "INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION" - } - } - } - }, - "com.amazonaws.quicksight#ExcludePeriodConfiguration": { - "type": "structure", - "members": { - "Amount": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The amount or number of the exclude period.

", - "smithy.api#required": {} - } - }, - "Granularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The granularity or unit (day, month, year) of the exclude period.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the exclude period. Choose from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The exclude period of TimeRangeFilter or RelativeDatesFilter.

" - } - }, - "com.amazonaws.quicksight#ExplicitHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the explicit hierarchy.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#ExplicitHierarchyColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns that define the explicit hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the explicit hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "com.amazonaws.quicksight#ExplicitHierarchyColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ExportHiddenFieldsOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the export hidden fields options of a dashbaord.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" - } - }, - "com.amazonaws.quicksight#ExportToCSVOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

Availability status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Export to .csv option.

" - } - }, - "com.amazonaws.quicksight#ExportWithHiddenFieldsOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the export with hidden fields options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines whether or not hidden fields are visible on exported dashbaords.

" - } - }, - "com.amazonaws.quicksight#Expression": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#FailedKeyRegistrationEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntry" - } - }, - "com.amazonaws.quicksight#FailedKeyRegistrationEntry": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that failed to update.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

", - "smithy.api#required": {} - } - }, - "StatusCode": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of a FailedKeyRegistrationEntry error.

", - "smithy.api#required": {} - } - }, - "SenderFault": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web Services Support.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

" - } - }, - "com.amazonaws.quicksight#FieldBasedTooltip": { - "type": "structure", - "members": { - "AggregationVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of Show aggregations.

" - } - }, - "TooltipTitleType": { - "target": "com.amazonaws.quicksight#TooltipTitleType", - "traits": { - "smithy.api#documentation": "

The type for the >tooltip title. Choose one of the following options:

\n " - } - }, - "TooltipFields": { - "target": "com.amazonaws.quicksight#TooltipItemList", - "traits": { - "smithy.api#documentation": "

The fields configuration in the\n tooltip.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The setup for the detailed tooltip.

" - } - }, - "com.amazonaws.quicksight#FieldFolder": { - "type": "structure", - "members": { - "description": { - "target": "com.amazonaws.quicksight#FieldFolderDescription", - "traits": { - "smithy.api#documentation": "

The description for a field folder.

" - } - }, - "columns": { - "target": "com.amazonaws.quicksight#FolderColumnList", - "traits": { - "smithy.api#documentation": "

A folder has a list of columns. A column can only be in one folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A FieldFolder element is a folder that contains fields and nested subfolders.

" - } - }, - "com.amazonaws.quicksight#FieldFolderDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#FieldFolderMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#FieldFolderPath" - }, - "value": { - "target": "com.amazonaws.quicksight#FieldFolder" - } - }, - "com.amazonaws.quicksight#FieldFolderPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#FieldId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#FieldLabelType": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

Indicates the field that is targeted by the field\n label.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the field label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field label type.

" - } - }, - "com.amazonaws.quicksight#FieldOrderList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FieldSeriesItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the field for which you are setting the axis binding.

", - "smithy.api#required": {} - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis that you are binding the field to.

", - "smithy.api#required": {} - } - }, - "Settings": { - "target": "com.amazonaws.quicksight#LineChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field series item configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#FieldSort": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The sort configuration target field.

", - "smithy.api#required": {} - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#SortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction. Choose one of the following\n options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a field in a\n field well.

" - } - }, - "com.amazonaws.quicksight#FieldSortOptions": { - "type": "structure", - "members": { - "FieldSort": { - "target": "com.amazonaws.quicksight#FieldSort", - "traits": { - "smithy.api#documentation": "

The sort configuration for a field in a field well.

" - } - }, - "ColumnSort": { - "target": "com.amazonaws.quicksight#ColumnSort", - "traits": { - "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field sort options in a chart configuration.

" - } - }, - "com.amazonaws.quicksight#FieldSortOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FieldTooltipItem": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The unique ID of the field that is targeted by the tooltip.

", - "smithy.api#required": {} - } - }, - "Label": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The label of the tooltip item.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the tooltip item.

" - } - }, - "TooltipTarget": { - "target": "com.amazonaws.quicksight#TooltipTarget", - "traits": { - "smithy.api#documentation": "

Determines the target of the field tooltip item in a combo chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip item for the fields.

" - } - }, - "com.amazonaws.quicksight#FieldValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2048 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#FileFormat": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - }, - "TSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TSV" - } - }, - "CLF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLF" - } - }, - "ELF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ELF" - } - }, - "XLSX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "XLSX" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.quicksight#FilledMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Geospatial": { - "target": "com.amazonaws.quicksight#FilledMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated location field well of the filled map. Values are grouped by location fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#FilledMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated color field well of a filled map. Values are aggregated based on location fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well of the filled map.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormattingOption": { - "type": "structure", - "members": { - "Shape": { - "target": "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FilledMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#FilledMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#FilledMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "WindowOptions": { - "target": "com.amazonaws.quicksight#GeospatialWindowOptions", - "traits": { - "smithy.api#documentation": "

The window options of the filled map visual.

" - } - }, - "MapStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", - "traits": { - "smithy.api#documentation": "

The map style options of the filled map visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FilledMapFieldWells": { - "type": "structure", - "members": { - "FilledMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#FilledMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well of the filled map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a FilledMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilledMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the filled map shape.

", - "smithy.api#required": {} - } - }, - "Format": { - "target": "com.amazonaws.quicksight#ShapeConditionalFormat", - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the background color of a filled map's shape.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

" - } - }, - "com.amazonaws.quicksight#FilledMapSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the location fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" - } - }, - "com.amazonaws.quicksight#FilledMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#FilledMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#FilledMapConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#Filter": { - "type": "structure", - "members": { - "CategoryFilter": { - "target": "com.amazonaws.quicksight#CategoryFilter", - "traits": { - "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" - } - }, - "NumericRangeFilter": { - "target": "com.amazonaws.quicksight#NumericRangeFilter", - "traits": { - "smithy.api#documentation": "

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

" - } - }, - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#NumericEqualityFilter", - "traits": { - "smithy.api#documentation": "

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

" - } - }, - "TimeEqualityFilter": { - "target": "com.amazonaws.quicksight#TimeEqualityFilter", - "traits": { - "smithy.api#documentation": "

A TimeEqualityFilter filters date-time values that equal or do not equal\n a given date/time value.

" - } - }, - "TimeRangeFilter": { - "target": "com.amazonaws.quicksight#TimeRangeFilter", - "traits": { - "smithy.api#documentation": "

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

" - } - }, - "RelativeDatesFilter": { - "target": "com.amazonaws.quicksight#RelativeDatesFilter", - "traits": { - "smithy.api#documentation": "

A RelativeDatesFilter filters date values that are relative to a given date.

" - } - }, - "TopBottomFilter": { - "target": "com.amazonaws.quicksight#TopBottomFilter", - "traits": { - "smithy.api#documentation": "

A TopBottomFilter filters data to the top or bottom values for a given column.

" - } - }, - "NestedFilter": { - "target": "com.amazonaws.quicksight#NestedFilter", - "traits": { - "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

With a Filter, you can remove portions of data from a particular visual or view.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterAggMetrics": { - "type": "structure", - "members": { - "MetricOperand": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The metric operand of the FilterAggMetrics.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The function for the FilterAggMetrics.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for FilterAggMetrics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the FilterAggMetrics.

" - } - }, - "com.amazonaws.quicksight#FilterAggMetricsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterAggMetrics" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FilterClass": { - "type": "enum", - "members": { - "ENFORCED_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENFORCED_VALUE_FILTER" - } - }, - "CONDITIONAL_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONDITIONAL_VALUE_FILTER" - } - }, - "NAMED_VALUE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMED_VALUE_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#FilterControl": { - "type": "structure", - "members": { - "DateTimePicker": { - "target": "com.amazonaws.quicksight#FilterDateTimePickerControl", - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" - } - }, - "List": { - "target": "com.amazonaws.quicksight#FilterListControl", - "traits": { - "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" - } - }, - "Dropdown": { - "target": "com.amazonaws.quicksight#FilterDropDownControl", - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "TextField": { - "target": "com.amazonaws.quicksight#FilterTextFieldControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "TextArea": { - "target": "com.amazonaws.quicksight#FilterTextAreaControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "Slider": { - "target": "com.amazonaws.quicksight#FilterSliderControl", - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "RelativeDateTime": { - "target": "com.amazonaws.quicksight#FilterRelativeDateTimeControl", - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" - } - }, - "CrossSheet": { - "target": "com.amazonaws.quicksight#FilterCrossSheetControl", - "traits": { - "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The control of a filter that is used to interact with a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterControlList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterControl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FilterCrossSheetControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterCrossSheetControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterCrossSheetControl.

", - "smithy.api#required": {} - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" - } - }, - "com.amazonaws.quicksight#FilterDateTimePickerControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" - } - }, - "com.amazonaws.quicksight#FilterDropDownControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterDropDownControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of the FilterDropDownControl.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "com.amazonaws.quicksight#FilterGroup": { - "type": "structure", - "members": { - "FilterGroupId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

", - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#FilterList", - "traits": { - "smithy.api#documentation": "

The list of filters that are present in a FilterGroup.

", - "smithy.api#required": {} - } - }, - "ScopeConfiguration": { - "target": "com.amazonaws.quicksight#FilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that specifies what scope to apply to a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the FilterGroup.

" - } - }, - "CrossDataset": { - "target": "com.amazonaws.quicksight#CrossDatasetTypes", - "traits": { - "smithy.api#documentation": "

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A grouping of individual filters. Filter groups are applied to the same group of visuals.

\n

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#FilterGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FilterGroup" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#FilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Filter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#FilterListConfiguration": { - "type": "structure", - "members": { - "MatchOperator": { - "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "CategoryValues": { - "target": "com.amazonaws.quicksight#CategoryValueList", - "traits": { - "smithy.api#documentation": "

The list of category values for the filter.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of filter configurations.

" - } - }, - "com.amazonaws.quicksight#FilterListControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterListControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of the FilterListControl. Choose one of the following options:

\n " - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#FilterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" - } - }, - "com.amazonaws.quicksight#FilterNullOption": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - }, - "NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULLS_ONLY" - } - }, - "NON_NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_NULLS_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#FilterOperation": { - "type": "structure", - "members": { - "ConditionExpression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" - } - }, - "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration": { - "type": "structure", - "members": { - "SelectedFields": { - "target": "com.amazonaws.quicksight#SelectedFieldList", - "traits": { - "smithy.api#documentation": "

Chooses the fields that are filtered in CustomActionFilterOperation.

" - } - }, - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#SelectedFieldOptions", - "traits": { - "smithy.api#documentation": "

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

\n

Valid values are defined as follows:

\n " - } - }, - "SelectedColumns": { - "target": "com.amazonaws.quicksight#CustomActionColumnList", - "traits": { - "smithy.api#documentation": "

The selected columns of a dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of selected fields in theCustomActionFilterOperation.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration": { - "type": "structure", - "members": { - "SameSheetTargetVisualConfiguration": { - "target": "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterOperator": { - "type": "enum", - "members": { - "StringEquals": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StringEquals" - } - }, - "StringLike": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StringLike" - } - } - } - }, - "com.amazonaws.quicksight#FilterRelativeDateTimeControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" - } - }, - "com.amazonaws.quicksight#FilterScopeConfiguration": { - "type": "structure", - "members": { - "SelectedSheets": { - "target": "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for applying a filter to specific sheets.

" - } - }, - "AllSheets": { - "target": "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scope configuration for a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FilterSelectableValues": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#ParameterSelectableValueList", - "traits": { - "smithy.api#documentation": "

The values that are used in the FilterSelectableValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "com.amazonaws.quicksight#FilterSliderControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterSliderControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlSliderType", - "traits": { - "smithy.api#documentation": "

The type of the FilterSliderControl. Choose one of the following options:

\n " - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "com.amazonaws.quicksight#FilterTextAreaControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "com.amazonaws.quicksight#FilterTextFieldControl": { - "type": "structure", - "members": { - "FilterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "SourceFilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The source filter ID of the FilterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "com.amazonaws.quicksight#FilterVisualScope": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - }, - "SELECTED_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTED_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#FilteredVisualsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#Folder": { - "type": "structure", - "members": { - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

A display name for the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder it is.

" - } - }, - "FolderPath": { - "target": "com.amazonaws.quicksight#Path", - "traits": { - "smithy.api#documentation": "

An array of ancestor ARN strings for the folder.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was last updated.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

The sharing scope of the folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A folder in Amazon QuickSight.

" - } - }, - "com.amazonaws.quicksight#FolderArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FolderColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5000 - } - } - }, - "com.amazonaws.quicksight#FolderFilterAttribute": { - "type": "enum", - "members": { - "PARENT_FOLDER_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARENT_FOLDER_ARN" - } - }, - "DIRECT_QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" - } - }, - "DIRECT_QUICKSIGHT_SOLE_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" - } - }, - "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "QUICKSIGHT_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_OWNER" - } - }, - "QUICKSIGHT_VIEWER_OR_OWNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" - } - }, - "FOLDER_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FOLDER_NAME" - } - } - } - }, - "com.amazonaws.quicksight#FolderMember": { - "type": "structure", - "members": { - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of an asset in the folder.

" - } - }, - "MemberType": { - "target": "com.amazonaws.quicksight#MemberType", - "traits": { - "smithy.api#documentation": "

The type of asset that it is.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

" - } - }, - "com.amazonaws.quicksight#FolderMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MemberIdArnPair" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#FolderSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#FilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"FOLDER_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value FOLDER_NAME.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of a value that you want to use in the filter. For example, \"Name\": \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter to use to search an Amazon QuickSight folder.

" - } - }, - "com.amazonaws.quicksight#FolderSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FolderSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The display name of the folder.

" - } - }, - "FolderType": { - "target": "com.amazonaws.quicksight#FolderType", - "traits": { - "smithy.api#documentation": "

The type of folder.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the folder was last updated.

" - } - }, - "SharingModel": { - "target": "com.amazonaws.quicksight#SharingModel", - "traits": { - "smithy.api#documentation": "

The sharing scope of the folder.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of information about an existing Amazon QuickSight folder.

" - } - }, - "com.amazonaws.quicksight#FolderSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FolderSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#FolderType": { - "type": "enum", - "members": { - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - }, - "RESTRICTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED" - } - } - } - }, - "com.amazonaws.quicksight#Font": { - "type": "structure", - "members": { - "FontFamily": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Determines the font family settings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the font settings.

" - } - }, - "com.amazonaws.quicksight#FontConfiguration": { - "type": "structure", - "members": { - "FontSize": { - "target": "com.amazonaws.quicksight#FontSize", - "traits": { - "smithy.api#documentation": "

The option that determines the text display size.

" - } - }, - "FontDecoration": { - "target": "com.amazonaws.quicksight#FontDecoration", - "traits": { - "smithy.api#documentation": "

Determines the appearance of decorative lines on the text.

" - } - }, - "FontColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color of the text.

" - } - }, - "FontWeight": { - "target": "com.amazonaws.quicksight#FontWeight", - "traits": { - "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" - } - }, - "FontStyle": { - "target": "com.amazonaws.quicksight#FontStyle", - "traits": { - "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures the display properties of the given text.

" - } - }, - "com.amazonaws.quicksight#FontDecoration": { - "type": "enum", - "members": { - "UNDERLINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNDERLINE" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.quicksight#FontList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Font" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#FontSize": { - "type": "structure", - "members": { - "Relative": { - "target": "com.amazonaws.quicksight#RelativeFontSize", - "traits": { - "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the text display size.

" - } - }, - "com.amazonaws.quicksight#FontStyle": { - "type": "enum", - "members": { - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - }, - "ITALIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ITALIC" - } - } - } - }, - "com.amazonaws.quicksight#FontWeight": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#FontWeightName", - "traits": { - "smithy.api#documentation": "

The lexical name for the level of boldness of the text display.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" - } - }, - "com.amazonaws.quicksight#FontWeightName": { - "type": "enum", - "members": { - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - }, - "BOLD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOLD" - } - } - } - }, - "com.amazonaws.quicksight#ForecastComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodsForward": { - "target": "com.amazonaws.quicksight#PeriodsForward", - "traits": { - "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" - } - }, - "PeriodsBackward": { - "target": "com.amazonaws.quicksight#PeriodsBackward", - "traits": { - "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" - } - }, - "UpperBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" - } - }, - "LowerBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" - } - }, - "PredictionInterval": { - "target": "com.amazonaws.quicksight#PredictionInterval", - "traits": { - "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" - } - }, - "Seasonality": { - "target": "com.amazonaws.quicksight#ForecastComputationSeasonality", - "traits": { - "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " - } - }, - "CustomSeasonalityValue": { - "target": "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue", - "traits": { - "smithy.api#documentation": "

The custom seasonality value setup of a forecast computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast computation configuration.

" - } - }, - "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 180 - } - } - }, - "com.amazonaws.quicksight#ForecastComputationSeasonality": { - "type": "enum", - "members": { - "AUTOMATIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTOMATIC" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#ForecastConfiguration": { - "type": "structure", - "members": { - "ForecastProperties": { - "target": "com.amazonaws.quicksight#TimeBasedForecastProperties", - "traits": { - "smithy.api#documentation": "

The forecast properties setup of a forecast in the line\n chart.

" - } - }, - "Scenario": { - "target": "com.amazonaws.quicksight#ForecastScenario", - "traits": { - "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast configuration that is used in a line chart's display properties.

" - } - }, - "com.amazonaws.quicksight#ForecastConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ForecastConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ForecastScenario": { - "type": "structure", - "members": { - "WhatIfPointScenario": { - "target": "com.amazonaws.quicksight#WhatIfPointScenario", - "traits": { - "smithy.api#documentation": "

The what-if analysis forecast setup with the target date.

" - } - }, - "WhatIfRangeScenario": { - "target": "com.amazonaws.quicksight#WhatIfRangeScenario", - "traits": { - "smithy.api#documentation": "

The what-if analysis forecast setup with the date range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" - } - }, - "com.amazonaws.quicksight#FormatConfiguration": { - "type": "structure", - "members": { - "StringFormatConfiguration": { - "target": "com.amazonaws.quicksight#StringFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for string fields.

" - } - }, - "NumberFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for number fields.

" - } - }, - "DateTimeFormatConfiguration": { - "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", - "traits": { - "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The formatting configuration for all types of field.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "ScreenCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for the canvas of a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in a free-form layout.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElement": { - "type": "structure", - "members": { - "ElementId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

A unique identifier for an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "ElementType": { - "target": "com.amazonaws.quicksight#LayoutElementType", - "traits": { - "smithy.api#documentation": "

The type of element.

", - "smithy.api#required": {} - } - }, - "XAxisLocation": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The x-axis coordinate of the element.

", - "smithy.api#required": {} - } - }, - "YAxisLocation": { - "target": "com.amazonaws.quicksight#UnlimitedPixelLength", - "traits": { - "smithy.api#documentation": "

The y-axis coordinate of the element.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of an element within a free-form layout.

", - "smithy.api#required": {} - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of an element within a free-form layout.

" - } - }, - "RenderingRules": { - "target": "com.amazonaws.quicksight#SheetElementRenderingRuleList", - "traits": { - "smithy.api#documentation": "

The rendering rules that determine when an element should be displayed within a free-form layout.

" - } - }, - "BorderStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", - "traits": { - "smithy.api#documentation": "

The border style configuration of a free-form layout element.

" - } - }, - "SelectedBorderStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", - "traits": { - "smithy.api#documentation": "

The border style configuration of a free-form layout element. This border style is used when the element is selected.

" - } - }, - "BackgroundStyle": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle", - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "LoadingAnimation": { - "target": "com.amazonaws.quicksight#LoadingAnimation", - "traits": { - "smithy.api#documentation": "

The loading animation configuration of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An element within a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The background visibility of a free-form layout element.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

The background color of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The border visibility of a free-form layout element.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

The border color of a free-form layout element.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" - } - }, - "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions": { - "type": "structure", - "members": { - "OptimizedViewPortWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" - } - }, - "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in the free-form layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The free-form layout configuration of a section.

" - } - }, - "com.amazonaws.quicksight#FreeFromLayoutElementList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FreeFormLayoutElement" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 430 - } - } - }, - "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#FunnelChartDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a funnel chart. Values are grouped by category fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#FunnelChartMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a funnel chart. Values are aggregated based on categories.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#FunnelChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#FunnelChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the categories that are displayed in a FunnelChartVisual.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options for the values that are displayed in a FunnelChartVisual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a FunnelChartVisual.

" - } - }, - "DataLabelOptions": { - "target": "com.amazonaws.quicksight#FunnelChartDataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a FunnelChartVisual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartDataLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility option that determines if data labels are displayed.

" - } - }, - "CategoryLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the category labels within the data labels.

" - } - }, - "MeasureLabelVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the measure labels within the data labels.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#DataLabelPosition", - "traits": { - "smithy.api#documentation": "

Determines the positioning of the data label relative to a section of the funnel.

" - } - }, - "LabelFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration for the data labels.

\n

Only the FontSize attribute of the font configuration is used for data labels.

" - } - }, - "LabelColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the data label text.

" - } - }, - "MeasureDataLabelStyle": { - "target": "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle", - "traits": { - "smithy.api#documentation": "

Determines the style of the metric labels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" - } - }, - "com.amazonaws.quicksight#FunnelChartDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FunnelChartFieldWells": { - "type": "structure", - "members": { - "FunnelChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle": { - "type": "enum", - "members": { - "VALUE_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_ONLY" - } - }, - "PERCENTAGE_BY_FIRST_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_BY_FIRST_STAGE" - } - }, - "PERCENTAGE_BY_PREVIOUS_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTAGE_BY_PREVIOUS_STAGE" - } - }, - "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" - } - }, - "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" - } - } - } - }, - "com.amazonaws.quicksight#FunnelChartMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#FunnelChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" - } - }, - "com.amazonaws.quicksight#FunnelChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#FunnelChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the arc foreground color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartColorConfiguration": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color configuration of a GaugeChartVisual.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color configuration of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption": { - "type": "structure", - "members": { - "PrimaryValue": { - "target": "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" - } - }, - "Arc": { - "target": "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#GaugeChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#GaugeChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" - } - }, - "GaugeChartOptions": { - "target": "com.amazonaws.quicksight#GaugeChartOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a GaugeChartVisual.

" - } - }, - "TooltipOptions": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a GaugeChartVisual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a GaugeChartVisual.

" - } - }, - "ColorConfiguration": { - "target": "com.amazonaws.quicksight#GaugeChartColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a GaugeChartVisual.

" - } - }, - "TargetValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The target value field wells of a GaugeChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartOptions": { - "type": "structure", - "members": { - "PrimaryValueDisplayType": { - "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value display type.

" - } - }, - "Comparison": { - "target": "com.amazonaws.quicksight#ComparisonConfiguration", - "traits": { - "smithy.api#documentation": "

The comparison configuration of a GaugeChartVisual.

" - } - }, - "ArcAxis": { - "target": "com.amazonaws.quicksight#ArcAxisConfiguration", - "traits": { - "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" - } - }, - "Arc": { - "target": "com.amazonaws.quicksight#ArcConfiguration", - "traits": { - "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" - } - }, - "PrimaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value font configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" - } - }, - "com.amazonaws.quicksight#GaugeChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#GaugeChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#GaugeChartConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", - "smithy.api#required": {} - } - }, - "SessionTags": { - "target": "com.amazonaws.quicksight#SessionTagList", - "traits": { - "smithy.api#documentation": "

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

\n

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" - } - }, - "AuthorizedResourceArns": { - "target": "com.amazonaws.quicksight#ArnList", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", - "smithy.api#required": {} - } - }, - "ExperienceConfiguration": { - "target": "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of the experience that you are embedding.

", - "smithy.api#required": {} - } - }, - "AllowedDomains": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

The embed URL for the dashboard.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {}, - "smithy.api#required": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", - "smithy.api#required": {} - } - }, - "AnonymousUserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

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. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", - "smithy.api#required": {} - } - }, - "ExperienceConfiguration": { - "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", - "traits": { - "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "AllowedDomains": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {}, - "smithy.api#required": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GeoSpatialColumnGroup": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnGroupName", - "traits": { - "smithy.api#documentation": "

A display name for the hierarchy.

", - "smithy.api#required": {} - } - }, - "CountryCode": { - "target": "com.amazonaws.quicksight#GeoSpatialCountryCode", - "traits": { - "smithy.api#documentation": "

Country code.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#ColumnList", - "traits": { - "smithy.api#documentation": "

Columns in this hierarchy.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" - } - }, - "com.amazonaws.quicksight#GeoSpatialCountryCode": { - "type": "enum", - "members": { - "US": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US" - } - } - } - }, - "com.amazonaws.quicksight#GeoSpatialDataRole": { - "type": "enum", - "members": { - "COUNTRY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNTRY" - } - }, - "STATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STATE" - } - }, - "COUNTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNTY" - } - }, - "CITY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CITY" - } - }, - "POSTCODE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSTCODE" - } - }, - "LONGITUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LONGITUDE" - } - }, - "LATITUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LATITUDE" - } - } - } - }, - "com.amazonaws.quicksight#GeospatialCoordinateBounds": { - "type": "structure", - "members": { - "North": { - "target": "com.amazonaws.quicksight#Latitude", - "traits": { - "smithy.api#documentation": "

The latitude of the north bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "South": { - "target": "com.amazonaws.quicksight#Latitude", - "traits": { - "smithy.api#documentation": "

The latitude of the south bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "West": { - "target": "com.amazonaws.quicksight#Longitude", - "traits": { - "smithy.api#documentation": "

The longitude of the west bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - }, - "East": { - "target": "com.amazonaws.quicksight#Longitude", - "traits": { - "smithy.api#documentation": "

The longitude of the east bound of the geospatial coordinate bounds.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { - "type": "structure", - "members": { - "Colors": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColorList", - "traits": { - "smithy.api#documentation": "

The list of colors to be used in heatmap point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapConfiguration": { - "type": "structure", - "members": { - "HeatmapColor": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapColorScale", - "traits": { - "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapDataColor": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hex color to be used in the heatmap point style.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The color to be used in the heatmap point style.

" - } - }, - "com.amazonaws.quicksight#GeospatialHeatmapDataColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColor" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 2 - } - } - }, - "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Geospatial": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color field wells of a geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells for a geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#GeospatialMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "WindowOptions": { - "target": "com.amazonaws.quicksight#GeospatialWindowOptions", - "traits": { - "smithy.api#documentation": "

The window options of the geospatial map.

" - } - }, - "MapStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", - "traits": { - "smithy.api#documentation": "

The map style options of the geospatial map.

" - } - }, - "PointStyleOptions": { - "target": "com.amazonaws.quicksight#GeospatialPointStyleOptions", - "traits": { - "smithy.api#documentation": "

The point style options of the geospatial map.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette" - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a GeospatialMapVisual.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapFieldWells": { - "type": "structure", - "members": { - "GeospatialMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for a geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapStyleOptions": { - "type": "structure", - "members": { - "BaseMapStyle": { - "target": "com.amazonaws.quicksight#BaseMapStyleType", - "traits": { - "smithy.api#documentation": "

The base map style of the geospatial map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The map style options of the geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#GeospatialMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#GeospatialPointStyleOptions": { - "type": "structure", - "members": { - "SelectedPointStyle": { - "target": "com.amazonaws.quicksight#GeospatialSelectedPointStyle", - "traits": { - "smithy.api#documentation": "

The selected point styles (point, cluster) of the geospatial map.

" - } - }, - "ClusterMarkerConfiguration": { - "target": "com.amazonaws.quicksight#ClusterMarkerConfiguration", - "traits": { - "smithy.api#documentation": "

The cluster marker configuration of the geospatial point style.

" - } - }, - "HeatmapConfiguration": { - "target": "com.amazonaws.quicksight#GeospatialHeatmapConfiguration", - "traits": { - "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The point style of the geospatial map.

" - } - }, - "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { - "type": "enum", - "members": { - "POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POINT" - } - }, - "CLUSTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLUSTER" - } - }, - "HEATMAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HEATMAP" - } - } - } - }, - "com.amazonaws.quicksight#GeospatialWindowOptions": { - "type": "structure", - "members": { - "Bounds": { - "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds", - "traits": { - "smithy.api#documentation": "

The bounds options (north, south, west, east) of the geospatial window options.

" - } - }, - "MapZoomMode": { - "target": "com.amazonaws.quicksight#MapZoomMode", - "traits": { - "smithy.api#documentation": "

The map zoom modes (manual, auto) of the geospatial window options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The window options of the geospatial map visual.

" - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#DomainNotWhitelistedException" - }, - { - "target": "com.amazonaws.quicksight#IdentityTypeNotSupportedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

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.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard, also added to the Identity and Access Management (IAM)\n policy.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IdentityType": { - "target": "com.amazonaws.quicksight#EmbeddingIdentityType", - "traits": { - "smithy.api#documentation": "

The authentication method that the user uses to sign in.

", - "smithy.api#httpQuery": "creds-type", - "smithy.api#required": {} - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", - "smithy.api#httpQuery": "session-lifetime" - } - }, - "UndoRedoDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

", - "smithy.api#httpQuery": "undo-redo-disabled" - } - }, - "ResetDisabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

", - "smithy.api#httpQuery": "reset-disabled" - } - }, - "StatePersistenceEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", - "smithy.api#httpQuery": "state-persistence-enabled" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

\n \n

Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

", - "smithy.api#httpQuery": "user-arn" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AdditionalDashboardIds": { - "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", - "traits": { - "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", - "smithy.api#httpQuery": "additional-dashboard-ids" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Output returned from the GetDashboardEmbedUrl operation.

", - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrl": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrlRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrlResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/session-embed-url", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrlRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "EntryPoint": { - "target": "com.amazonaws.quicksight#EntryPoint", - "traits": { - "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n ", - "smithy.api#httpQuery": "entry-point" - } - }, - "SessionLifetimeInMinutes": { - "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", - "traits": { - "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", - "smithy.api#httpQuery": "session-lifetime" - } - }, - "UserArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n
    \n
  1. \n

    Active Directory (AD) users or group members

    \n
    2. \n
  2. \n

    Invited nonfederated users

    \n
    3. \n
  3. \n

    IAM users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation

    \n
    4. \n
\n

Omit this parameter for users in the third group, IAM users and IAM role-based\n sessions.

", - "smithy.api#httpQuery": "user-arn" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#GetSessionEmbedUrlResponse": { - "type": "structure", - "members": { - "EmbedUrl": { - "target": "com.amazonaws.quicksight#EmbeddingUrl", - "traits": { - "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tAmazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#GlobalTableBorderOptions": { - "type": "structure", - "members": { - "UniformBorder": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

Determines the options for uniform border.

" - } - }, - "SideSpecificBorder": { - "target": "com.amazonaws.quicksight#TableSideBorderOptions", - "traits": { - "smithy.api#documentation": "

Determines the options for side specific border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the border options for a table visual.

" - } - }, - "com.amazonaws.quicksight#GradientColor": { - "type": "structure", - "members": { - "Stops": { - "target": "com.amazonaws.quicksight#GradientStopList", - "traits": { - "smithy.api#documentation": "

The list of gradient color stops.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the gradient color settings.

" - } - }, - "com.amazonaws.quicksight#GradientStop": { - "type": "structure", - "members": { - "GradientOffset": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Determines gradient offset value.

", - "smithy.api#required": {} - } - }, - "DataValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines the data value.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Determines the color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the gradient stop configuration.

" - } - }, - "com.amazonaws.quicksight#GradientStopList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GradientStop" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "ScreenCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configuration options for the canvas of a grid layout.

" - } - }, - "com.amazonaws.quicksight#GridLayoutConfiguration": { - "type": "structure", - "members": { - "Elements": { - "target": "com.amazonaws.quicksight#GridLayoutElementList", - "traits": { - "smithy.api#documentation": "

The elements that are included in a grid layout.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a grid layout. Also called a tiled layout.

\n

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.

" - } - }, - "com.amazonaws.quicksight#GridLayoutElement": { - "type": "structure", - "members": { - "ElementId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

A unique identifier for an element within a grid layout.

", - "smithy.api#required": {} - } - }, - "ElementType": { - "target": "com.amazonaws.quicksight#LayoutElementType", - "traits": { - "smithy.api#documentation": "

The type of element.

", - "smithy.api#required": {} - } - }, - "ColumnIndex": { - "target": "com.amazonaws.quicksight#GridLayoutElementColumnIndex", - "traits": { - "smithy.api#documentation": "

The column index for the upper left corner of an element.

" - } - }, - "ColumnSpan": { - "target": "com.amazonaws.quicksight#GridLayoutElementColumnSpan", - "traits": { - "smithy.api#documentation": "

The width of a grid element expressed as a number of grid columns.

", - "smithy.api#required": {} - } - }, - "RowIndex": { - "target": "com.amazonaws.quicksight#GridLayoutElementRowIndex", - "traits": { - "smithy.api#documentation": "

The row index for the upper left corner of an element.

" - } - }, - "RowSpan": { - "target": "com.amazonaws.quicksight#GridLayoutElementRowSpan", - "traits": { - "smithy.api#documentation": "

The height of a grid element expressed as a number of grid rows.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An element within a grid layout.

" - } - }, - "com.amazonaws.quicksight#GridLayoutElementColumnIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 35 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementColumnSpan": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 36 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GridLayoutElement" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 430 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementRowIndex": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 9009 - } - } - }, - "com.amazonaws.quicksight#GridLayoutElementRowSpan": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 21 - } - } - }, - "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions": { - "type": "structure", - "members": { - "ResizeOption": { - "target": "com.amazonaws.quicksight#ResizeOption", - "traits": { - "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n ", - "smithy.api#required": {} - } - }, - "OptimizedViewPortWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" - } - }, - "com.amazonaws.quicksight#Group": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group.

" - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

The group description.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the group.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security.

" - } - }, - "com.amazonaws.quicksight#GroupDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#GroupFilterAttribute": { - "type": "enum", - "members": { - "GROUP_NAME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GROUP_NAME" - } - } - } - }, - "com.amazonaws.quicksight#GroupFilterOperator": { - "type": "enum", - "members": { - "StartsWith": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "StartsWith" - } - } - } - }, - "com.amazonaws.quicksight#GroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Group" - } - }, - "com.amazonaws.quicksight#GroupMember": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group member (user).

" - } - }, - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "

The name of the group member (user).

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A member of an Amazon QuickSight group. Currently, group members must be users. Groups\n can't be members of another group. .

" - } - }, - "com.amazonaws.quicksight#GroupMemberList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GroupMember" - } - }, - "com.amazonaws.quicksight#GroupMemberName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#GroupName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#GroupSearchFilter": { - "type": "structure", - "members": { - "Operator": { - "target": "com.amazonaws.quicksight#GroupFilterOperator", - "traits": { - "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\":\n \"StartsWith\". Currently, the only supported operator is\n StartsWith.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#GroupFilterAttribute", - "traits": { - "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"GROUP_NAME\". Currently, the only supported name is\n GROUP_NAME.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A GroupSearchFilter object that you want to apply to your search.

" - } - }, - "com.amazonaws.quicksight#GroupSearchFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#GroupSearchFilter" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#GroupsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#GrowthRateComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodSize": { - "target": "com.amazonaws.quicksight#GrowthRatePeriodSize", - "traits": { - "smithy.api#documentation": "

The period size setup of a growth rate computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The growth rate computation configuration.

" - } - }, - "com.amazonaws.quicksight#GrowthRatePeriodSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 2, - "max": 52 - } - } - }, - "com.amazonaws.quicksight#GutterStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for gutter spacing between tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#HeaderFooterSectionConfiguration": { - "type": "structure", - "members": { - "SectionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of the header or footer section.

", - "smithy.api#required": {} - } - }, - "Layout": { - "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The layout configuration of the header or footer section.

", - "smithy.api#required": {} - } - }, - "Style": { - "target": "com.amazonaws.quicksight#SectionStyle", - "traits": { - "smithy.api#documentation": "

The style options of a header or footer section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a header or footer section.

" - } - }, - "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Rows": { - "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The rows field well of a heat map.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The columns field well of a heat map.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#HeatMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well of a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#HeatMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#HeatMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a heat map.

" - } - }, - "RowLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the row that is displayed in a heat map.

" - } - }, - "ColumnLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the column that is displayed in a heat map.

" - } - }, - "ColorScale": { - "target": "com.amazonaws.quicksight#ColorScale", - "traits": { - "smithy.api#documentation": "

The color options (gradient color, point of divergence) in a heat map.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapFieldWells": { - "type": "structure", - "members": { - "HeatMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#HeatMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a heat map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#HeatMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HeatMapSortConfiguration": { - "type": "structure", - "members": { - "HeatMapRowSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The field sort configuration of the rows fields.

" - } - }, - "HeatMapColumnSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The column sort configuration for heat map for columns that aren't a part of a field well.

" - } - }, - "HeatMapRowItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of rows that are displayed in a heat map.

" - } - }, - "HeatMapColumnItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of columns that are displayed in a heat map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a heat map.

" - } - }, - "com.amazonaws.quicksight#HeatMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#HeatMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a heat map.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#HexColor": { - "type": "string", - "traits": { - "smithy.api#pattern": "^#[A-F0-9]{6}$" - } - }, - "com.amazonaws.quicksight#HexColorWithTransparency": { - "type": "string", - "traits": { - "smithy.api#pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$" - } - }, - "com.amazonaws.quicksight#HierarchyId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#HistogramAggregatedFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#HistogramMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "com.amazonaws.quicksight#HistogramBinOptions": { - "type": "structure", - "members": { - "SelectedBinType": { - "target": "com.amazonaws.quicksight#HistogramBinType", - "traits": { - "smithy.api#documentation": "

The options that determine the selected bin type.

" - } - }, - "BinCount": { - "target": "com.amazonaws.quicksight#BinCountOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" - } - }, - "BinWidth": { - "target": "com.amazonaws.quicksight#BinWidthOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" - } - }, - "StartValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The options that determine the bin start value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" - } - }, - "com.amazonaws.quicksight#HistogramBinType": { - "type": "enum", - "members": { - "BIN_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIN_COUNT" - } - }, - "BIN_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIN_WIDTH" - } - } - } - }, - "com.amazonaws.quicksight#HistogramConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#HistogramFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" - } - }, - "BinOptions": { - "target": "com.amazonaws.quicksight#HistogramBinOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a histogram.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a histogram.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a histogram.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a HistogramVisual.

" - } - }, - "com.amazonaws.quicksight#HistogramFieldWells": { - "type": "structure", - "members": { - "HistogramAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#HistogramAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a histogram.

" - } - }, - "com.amazonaws.quicksight#HistogramMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#HistogramVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#HistogramConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a HistogramVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#HorizontalTextAlignment": { - "type": "enum", - "members": { - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CENTER" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } - }, - "com.amazonaws.quicksight#Host": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignment": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

Assignment ID.

" - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

Assignment name.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM policy.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

Identities.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

Assignment status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An Identity and Access Management (IAM) policy assignment.

" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentSummary": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

Assignment name.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

Assignment status.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

IAM policy assignment summary.

" - } - }, - "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummary" - } - }, - "com.amazonaws.quicksight#IPv4Address": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 7, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#Icon": { - "type": "enum", - "members": { - "CARET_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_UP" - } - }, - "CARET_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CARET_DOWN" - } - }, - "PLUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PLUS" - } - }, - "MINUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUS" - } - }, - "ARROW_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP" - } - }, - "ARROW_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN" - } - }, - "ARROW_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_LEFT" - } - }, - "ARROW_UP_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP_LEFT" - } - }, - "ARROW_DOWN_LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN_LEFT" - } - }, - "ARROW_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_RIGHT" - } - }, - "ARROW_UP_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_UP_RIGHT" - } - }, - "ARROW_DOWN_RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ARROW_DOWN_RIGHT" - } - }, - "FACE_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_UP" - } - }, - "FACE_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_DOWN" - } - }, - "FACE_FLAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FACE_FLAT" - } - }, - "ONE_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ONE_BAR" - } - }, - "TWO_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TWO_BAR" - } - }, - "THREE_BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THREE_BAR" - } - }, - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "TRIANGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIANGLE" - } - }, - "SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQUARE" - } - }, - "FLAG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLAG" - } - }, - "THUMBS_UP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THUMBS_UP" - } - }, - "THUMBS_DOWN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THUMBS_DOWN" - } - }, - "CHECKMARK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CHECKMARK" - } - }, - "X": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "X" - } - } - } - }, - "com.amazonaws.quicksight#Identifier": { - "type": "structure", - "members": { - "Identity": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The identity of the identifier.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the identifier.

" - } - }, - "com.amazonaws.quicksight#IdentityCenterConfiguration": { - "type": "structure", - "members": { - "EnableIdentityPropagation": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for an IAM Identity Center configuration.

" - } - }, - "com.amazonaws.quicksight#IdentityMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#String" - }, - "value": { - "target": "com.amazonaws.quicksight#IdentityNameList" - } - }, - "com.amazonaws.quicksight#IdentityName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } - }, - "com.amazonaws.quicksight#IdentityNameList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IdentityName" - } - }, - "com.amazonaws.quicksight#IdentityStore": { - "type": "enum", - "members": { - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - } - } - }, - "com.amazonaws.quicksight#IdentityType": { - "type": "enum", - "members": { - "IAM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM" - } - }, - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "IAM_IDENTITY_CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_IDENTITY_CENTER" - } - } - } - }, - "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The identity type specified isn't supported. Supported identity types include\n\t\t\t\tIAM and QUICKSIGHT.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } - }, - "com.amazonaws.quicksight#IncrementalRefresh": { - "type": "structure", - "members": { - "LookbackWindow": { - "target": "com.amazonaws.quicksight#LookbackWindow", - "traits": { - "smithy.api#documentation": "

The lookback window setup for an incremental refresh configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The incremental refresh configuration for a dataset.

" - } - }, - "com.amazonaws.quicksight#Ingestion": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", - "traits": { - "smithy.api#documentation": "

Ingestion ID.

" - } - }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", - "traits": { - "smithy.api#documentation": "

Ingestion status.

", - "smithy.api#required": {} - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#ErrorInfo", - "traits": { - "smithy.api#documentation": "

Error information for this ingestion.

" - } - }, - "RowInfo": { - "target": "com.amazonaws.quicksight#RowInfo" - }, - "QueueInfo": { - "target": "com.amazonaws.quicksight#QueueInfo" - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this ingestion started.

", - "smithy.api#required": {} - } - }, - "IngestionTimeInSeconds": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The time that this ingestion took, measured in seconds.

" - } - }, - "IngestionSizeInBytes": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The size of the data ingested, in bytes.

" - } - }, - "RequestSource": { - "target": "com.amazonaws.quicksight#IngestionRequestSource", - "traits": { - "smithy.api#documentation": "

Event source for this ingestion.

" - } - }, - "RequestType": { - "target": "com.amazonaws.quicksight#IngestionRequestType", - "traits": { - "smithy.api#documentation": "

Type of this ingestion.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the SPICE ingestion for a dataset.

" - } - }, - "com.amazonaws.quicksight#IngestionErrorType": { - "type": "enum", - "members": { - "FAILURE_TO_ASSUME_ROLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILURE_TO_ASSUME_ROLE" - } - }, - "INGESTION_SUPERSEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION_SUPERSEDED" - } - }, - "INGESTION_CANCELED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INGESTION_CANCELED" - } - }, - "DATA_SET_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_DELETED" - } - }, - "DATA_SET_NOT_SPICE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_SPICE" - } - }, - "S3_UPLOADED_FILE_DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_UPLOADED_FILE_DELETED" - } - }, - "S3_MANIFEST_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_MANIFEST_ERROR" - } - }, - "DATA_TOLERANCE_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_TOLERANCE_EXCEPTION" - } - }, - "SPICE_TABLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPICE_TABLE_NOT_FOUND" - } - }, - "DATA_SET_SIZE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_SIZE_LIMIT_EXCEEDED" - } - }, - "ROW_SIZE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROW_SIZE_LIMIT_EXCEEDED" - } - }, - "ACCOUNT_CAPACITY_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" - } - }, - "CUSTOMER_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOMER_ERROR" - } - }, - "DATA_SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_NOT_FOUND" - } - }, - "IAM_ROLE_NOT_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IAM_ROLE_NOT_AVAILABLE" - } - }, - "CONNECTION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONNECTION_FAILURE" - } - }, - "SQL_TABLE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_TABLE_NOT_FOUND" - } - }, - "PERMISSION_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_DENIED" - } - }, - "SSL_CERTIFICATE_VALIDATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SSL_CERTIFICATE_VALIDATION_FAILURE" - } - }, - "OAUTH_TOKEN_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OAUTH_TOKEN_FAILURE" - } - }, - "SOURCE_API_LIMIT_EXCEEDED_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_API_LIMIT_EXCEEDED_FAILURE" - } - }, - "PASSWORD_AUTHENTICATION_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PASSWORD_AUTHENTICATION_FAILURE" - } - }, - "SQL_SCHEMA_MISMATCH_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_SCHEMA_MISMATCH_ERROR" - } - }, - "INVALID_DATE_FORMAT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATE_FORMAT" - } - }, - "INVALID_DATAPREP_SYNTAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATAPREP_SYNTAX" - } - }, - "SOURCE_RESOURCE_LIMIT_EXCEEDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_RESOURCE_LIMIT_EXCEEDED" - } - }, - "SQL_INVALID_PARAMETER_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_INVALID_PARAMETER_VALUE" - } - }, - "QUERY_TIMEOUT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUERY_TIMEOUT" - } - }, - "SQL_NUMERIC_OVERFLOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_NUMERIC_OVERFLOW" - } - }, - "UNRESOLVABLE_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNRESOLVABLE_HOST" - } - }, - "UNROUTABLE_HOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNROUTABLE_HOST" - } - }, - "SQL_EXCEPTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQL_EXCEPTION" - } - }, - "S3_FILE_INACCESSIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "S3_FILE_INACCESSIBLE" - } - }, - "IOT_FILE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IOT_FILE_NOT_FOUND" - } - }, - "IOT_DATA_SET_FILE_EMPTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "IOT_DATA_SET_FILE_EMPTY" - } - }, - "INVALID_DATA_SOURCE_CONFIG": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATA_SOURCE_CONFIG" - } - }, - "DATA_SOURCE_AUTH_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_AUTH_FAILED" - } - }, - "DATA_SOURCE_CONNECTION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SOURCE_CONNECTION_FAILED" - } - }, - "FAILURE_TO_PROCESS_JSON_FILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILURE_TO_PROCESS_JSON_FILE" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - }, - "REFRESH_SUPPRESSED_BY_EDIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REFRESH_SUPPRESSED_BY_EDIT" - } - }, - "PERMISSION_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_NOT_FOUND" - } - }, - "ELASTICSEARCH_CURSOR_NOT_ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ELASTICSEARCH_CURSOR_NOT_ENABLED" - } - }, - "CURSOR_NOT_ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CURSOR_NOT_ENABLED" - } - }, - "DUPLICATE_COLUMN_NAMES_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" - } - } - } - }, - "com.amazonaws.quicksight#IngestionId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" - } - }, - "com.amazonaws.quicksight#IngestionMaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#IngestionRequestSource": { - "type": "enum", - "members": { - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - }, - "SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCHEDULED" - } - } - } - }, - "com.amazonaws.quicksight#IngestionRequestType": { - "type": "enum", - "members": { - "INITIAL_INGESTION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIAL_INGESTION" - } - }, - "EDIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EDIT" - } - }, - "INCREMENTAL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREMENTAL_REFRESH" - } - }, - "FULL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REFRESH" - } - } - }, - "traits": { - "smithy.api#documentation": "This defines the type of ingestion request. This is returned as part of create ingestion response." - } - }, - "com.amazonaws.quicksight#IngestionStatus": { - "type": "enum", - "members": { - "INITIALIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZED" - } - }, - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } - }, - "com.amazonaws.quicksight#IngestionType": { - "type": "enum", - "members": { - "INCREMENTAL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCREMENTAL_REFRESH" - } - }, - "FULL_REFRESH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FULL_REFRESH" - } - } - }, - "traits": { - "smithy.api#documentation": "This defines the type of ingestion user wants to trigger. This is part of create ingestion request." - } - }, - "com.amazonaws.quicksight#Ingestions": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Ingestion" - } - }, - "com.amazonaws.quicksight#InnerFilter": { - "type": "structure", - "members": { - "CategoryInnerFilter": { - "target": "com.amazonaws.quicksight#CategoryInnerFilter", - "traits": { - "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

" - } - }, - "com.amazonaws.quicksight#InputColumn": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of this column in the underlying data source.

", - "smithy.api#required": {} - } - }, - "Type": { - "target": "com.amazonaws.quicksight#InputColumnDataType", - "traits": { - "smithy.api#documentation": "

The data type of the column.

", - "smithy.api#required": {} - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Metadata for a column that is used as the input of a transform operation.

" - } - }, - "com.amazonaws.quicksight#InputColumnDataType": { - "type": "enum", - "members": { - "STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRING" - } - }, - "INTEGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTEGER" - } - }, - "DECIMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DECIMAL" - } - }, - "DATETIME": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATETIME" - } - }, - "BIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BIT" - } - }, - "BOOLEAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOOLEAN" - } - }, - "JSON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JSON" - } - } - } - }, - "com.amazonaws.quicksight#InputColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#InputColumn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#InsightConfiguration": { - "type": "structure", - "members": { - "Computations": { - "target": "com.amazonaws.quicksight#ComputationList", - "traits": { - "smithy.api#documentation": "

The computations configurations of the insight visual

" - } - }, - "CustomNarrative": { - "target": "com.amazonaws.quicksight#CustomNarrativeOptions", - "traits": { - "smithy.api#documentation": "

The custom narrative of the insight visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of an insight visual.

" - } - }, - "com.amazonaws.quicksight#InsightVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "InsightConfiguration": { - "target": "com.amazonaws.quicksight#InsightConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of an insight visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The dataset that is used in the insight visual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#InstanceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#Integer": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the integer parameter created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the integer parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given integer parameter. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An integer parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The default value for the integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of an integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#IntegerDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveLongObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#IntegerDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the IntegerDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the IntegerParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#IntegerParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of the integer parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveLongList", - "traits": { - "smithy.api#documentation": "

The values for the integer parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An integer parameter.

" - } - }, - "com.amazonaws.quicksight#IntegerParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#IntegerDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "com.amazonaws.quicksight#IntegerParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#IntegerParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveLong", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#InternalFailureException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An internal failure occurred.

", - "smithy.api#error": "server", - "smithy.api#httpError": 500 - } - }, - "com.amazonaws.quicksight#InvalidNextTokenException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The NextToken value isn't valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidParameterValueException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more parameters has a value that isn't valid.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidRequestException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#InvalidTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the InvalidTopicReviewedAnswer.

" - } - }, - "Error": { - "target": "com.amazonaws.quicksight#ReviewedAnswerErrorCode", - "traits": { - "smithy.api#documentation": "

The error that is returned for the InvalidTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a InvalidTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#InvalidTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswer" - } - }, - "com.amazonaws.quicksight#IpRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#IpRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#CIDR" - }, - "value": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleDescription" - } - }, - "com.amazonaws.quicksight#ItemsLimitConfiguration": { - "type": "structure", - "members": { - "ItemsLimit": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The limit on how many items of a field are showed in the chart. For\n example, the number of slices that are displayed in a pie chart.

" - } - }, - "OtherCategories": { - "target": "com.amazonaws.quicksight#OtherCategories", - "traits": { - "smithy.api#documentation": "

The Show\n other of an axis in the chart. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The limit configuration of the visual display for an axis.

" - } - }, - "com.amazonaws.quicksight#JiraParameters": { - "type": "structure", - "members": { - "SiteBaseUrl": { - "target": "com.amazonaws.quicksight#SiteBaseUrl", - "traits": { - "smithy.api#documentation": "

The base URL of the Jira site.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Jira.

" - } - }, - "com.amazonaws.quicksight#JoinInstruction": { - "type": "structure", - "members": { - "LeftOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", - "traits": { - "smithy.api#documentation": "

The operand on the left side of a join.

", - "smithy.api#required": {} - } - }, - "RightOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", - "traits": { - "smithy.api#documentation": "

The operand on the right side of a join.

", - "smithy.api#required": {} - } - }, - "LeftJoinKeyProperties": { - "target": "com.amazonaws.quicksight#JoinKeyProperties", - "traits": { - "smithy.api#documentation": "

Join key properties of the left operand.

" - } - }, - "RightJoinKeyProperties": { - "target": "com.amazonaws.quicksight#JoinKeyProperties", - "traits": { - "smithy.api#documentation": "

Join key properties of the right operand.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#JoinType", - "traits": { - "smithy.api#documentation": "

The type of join that it is.

", - "smithy.api#required": {} - } - }, - "OnClause": { - "target": "com.amazonaws.quicksight#OnClause", - "traits": { - "smithy.api#documentation": "

The join instructions provided in the ON clause of a join.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The instructions associated with a join.

" - } - }, - "com.amazonaws.quicksight#JoinKeyProperties": { - "type": "structure", - "members": { - "UniqueKey": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Properties associated with the columns participating in a join.

" - } - }, - "com.amazonaws.quicksight#JoinType": { - "type": "enum", - "members": { - "INNER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INNER" - } - }, - "OUTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTER" - } - }, - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the actual value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the actual value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the comparison value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the comparison value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#KPIConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormattingOption": { - "type": "structure", - "members": { - "PrimaryValue": { - "target": "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" - } - }, - "ProgressBar": { - "target": "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" - } - }, - "ActualValue": { - "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" - } - }, - "ComparisonValue": { - "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#KPIConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#KPIConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#KPIFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a KPI visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#KPISortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a KPI visual.

" - } - }, - "KPIOptions": { - "target": "com.amazonaws.quicksight#KPIOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a KPI visual.

" - } - }, - "TargetValues": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The target value field wells of a KPI visual.

" - } - }, - "TrendGroups": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The trend group field wells of a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIOptions": { - "type": "structure", - "members": { - "ProgressBar": { - "target": "com.amazonaws.quicksight#ProgressBarOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" - } - }, - "TrendArrows": { - "target": "com.amazonaws.quicksight#TrendArrowOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" - } - }, - "SecondaryValue": { - "target": "com.amazonaws.quicksight#SecondaryValueOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" - } - }, - "Comparison": { - "target": "com.amazonaws.quicksight#ComparisonConfiguration", - "traits": { - "smithy.api#documentation": "

The comparison configuration of a KPI visual.

" - } - }, - "PrimaryValueDisplayType": { - "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value display type.

" - } - }, - "PrimaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the primary value font configuration.

" - } - }, - "SecondaryValueFontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the secondary value font configuration.

" - } - }, - "Sparkline": { - "target": "com.amazonaws.quicksight#KPISparklineOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" - } - }, - "VisualLayoutOptions": { - "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting": { - "type": "structure", - "members": { - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value's text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the primary value's icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting": { - "type": "structure", - "members": { - "ForegroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting of the progress bar's foreground color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISortConfiguration": { - "type": "structure", - "members": { - "TrendGroupSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the trend group fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISparklineOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the sparkline.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#KPISparklineType", - "traits": { - "smithy.api#documentation": "

The type of the sparkline.

", - "smithy.api#required": {} - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the sparkline.

" - } - }, - "TooltipVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The tooltip visibility of the sparkline.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPISparklineType": { - "type": "enum", - "members": { - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - }, - "AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AREA" - } - } - } - }, - "com.amazonaws.quicksight#KPIVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#KPIConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a KPI visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#KPIConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#KPIVisualLayoutOptions": { - "type": "structure", - "members": { - "StandardLayout": { - "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", - "traits": { - "smithy.api#documentation": "

The standard layout of the KPI visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIVisualStandardLayout": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", - "traits": { - "smithy.api#documentation": "

The standard layout type.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The standard layout of the KPI visual.

" - } - }, - "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { - "type": "enum", - "members": { - "CLASSIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CLASSIC" - } - }, - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - } - } - }, - "com.amazonaws.quicksight#KeyRegistration": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RegisteredCustomerManagedKey" - } - }, - "com.amazonaws.quicksight#LabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the label is visible.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The text for the label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The share label options for the labels.

" - } - }, - "com.amazonaws.quicksight#Latitude": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -90, - "max": 90 - } - } - }, - "com.amazonaws.quicksight#Layout": { - "type": "structure", - "members": { - "Configuration": { - "target": "com.amazonaws.quicksight#LayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines what the type of layout for a sheet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A Layout defines the placement of elements within a sheet.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LayoutConfiguration": { - "type": "structure", - "members": { - "GridLayout": { - "target": "com.amazonaws.quicksight#GridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

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: FIXED or RESPONSIVE.

" - } - }, - "FreeFormLayout": { - "target": "com.amazonaws.quicksight#FreeFormLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

" - } - }, - "SectionBasedLayout": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that determines what the type of layout will be used on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LayoutElementType": { - "type": "enum", - "members": { - "VISUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VISUAL" - } - }, - "FILTER_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_CONTROL" - } - }, - "PARAMETER_CONTROL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARAMETER_CONTROL" - } - }, - "TEXT_BOX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TEXT_BOX" - } - } - } - }, - "com.amazonaws.quicksight#LayoutList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Layout" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#LegendOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the legend is visible.

" - } - }, - "Title": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The custom title for the legend.

" - } - }, - "Position": { - "target": "com.amazonaws.quicksight#LegendPosition", - "traits": { - "smithy.api#documentation": "

The positions for the legend. Choose one of the following\n options:

\n " - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of the legend. If this value is omitted, a default width is used when rendering.

" - } - }, - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the legend setup of a visual.

" - } - }, - "com.amazonaws.quicksight#LegendPosition": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - } - } - }, - "com.amazonaws.quicksight#Length": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit" - } - }, - "com.amazonaws.quicksight#LimitExceededException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

Limit exceeded.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A limit is exceeded.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#LimitedString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#LineChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a line chart. Values are grouped by category fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a line chart. Values are aggregated based on categories.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The color field wells of a line chart. Values are grouped by category fields.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#LineChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#LineChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a line chart.

" - } - }, - "ForecastConfigurations": { - "target": "com.amazonaws.quicksight#ForecastConfigurationList", - "traits": { - "smithy.api#documentation": "

The forecast configuration of a line chart.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#LineChartType", - "traits": { - "smithy.api#documentation": "

Determines the type of the line chart.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" - } - }, - "SecondaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "SecondaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary y-axis label.

" - } - }, - "SingleAxisOptions": { - "target": "com.amazonaws.quicksight#SingleAxisOptions" - }, - "DefaultSeriesSettings": { - "target": "com.amazonaws.quicksight#LineChartDefaultSeriesSettings", - "traits": { - "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" - } - }, - "Series": { - "target": "com.amazonaws.quicksight#SeriesItemList", - "traits": { - "smithy.api#documentation": "

The series item configuration of a line chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend configuration of a line chart.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a line chart.

" - } - }, - "ReferenceLines": { - "target": "com.amazonaws.quicksight#ReferenceLineList", - "traits": { - "smithy.api#documentation": "

The reference lines configuration of a line chart.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip configuration of a line chart.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The default configuration of a line chart's contribution analysis.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a line chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartDefaultSeriesSettings": { - "type": "structure", - "members": { - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis to which you are binding all line series to.

" - } - }, - "LineStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", - "traits": { - "smithy.api#documentation": "

Line styles options for all line series in the visual.

" - } - }, - "MarkerStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", - "traits": { - "smithy.api#documentation": "

Marker styles options for all line series in the visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartFieldWells": { - "type": "structure", - "members": { - "LineChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#LineChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartLineStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - } - } - }, - "com.amazonaws.quicksight#LineChartLineStyleSettings": { - "type": "structure", - "members": { - "LineVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Configuration option that determines whether to show the line for the series.

" - } - }, - "LineInterpolation": { - "target": "com.amazonaws.quicksight#LineInterpolation", - "traits": { - "smithy.api#documentation": "

Interpolation style for line series.

\n " - } - }, - "LineStyle": { - "target": "com.amazonaws.quicksight#LineChartLineStyle", - "traits": { - "smithy.api#documentation": "

Line style for line series.

\n " - } - }, - "LineWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Width that determines the line thickness.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartMarkerShape": { - "type": "enum", - "members": { - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "TRIANGLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRIANGLE" - } - }, - "SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SQUARE" - } - }, - "DIAMOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIAMOND" - } - }, - "ROUNDED_SQUARE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROUNDED_SQUARE" - } - } - } - }, - "com.amazonaws.quicksight#LineChartMarkerStyleSettings": { - "type": "structure", - "members": { - "MarkerVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Configuration option that determines whether to show the markers in the series.

" - } - }, - "MarkerShape": { - "target": "com.amazonaws.quicksight#LineChartMarkerShape", - "traits": { - "smithy.api#documentation": "

Shape option for markers in the series.

\n " - } - }, - "MarkerSize": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Size of marker in the series.

" - } - }, - "MarkerColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Color of marker in the series.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" - } - }, - "com.amazonaws.quicksight#LineChartSeriesSettings": { - "type": "structure", - "members": { - "LineStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", - "traits": { - "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" - } - }, - "MarkerStyleSettings": { - "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", - "traits": { - "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a line series in the visual

" - } - }, - "com.amazonaws.quicksight#LineChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories that are displayed in a line chart.

" - } - }, - "ColorItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of lines that are displayed in a line chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LineChartType": { - "type": "enum", - "members": { - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - }, - "AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AREA" - } - }, - "STACKED_AREA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STACKED_AREA" - } - } - } - }, - "com.amazonaws.quicksight#LineChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#LineChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a line chart.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#LineInterpolation": { - "type": "enum", - "members": { - "LINEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINEAR" - } - }, - "SMOOTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMOOTH" - } - }, - "STEPPED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STEPPED" - } - } - } - }, - "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions": { - "type": "structure", - "members": { - "AxisOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the line series axis.

" - } - }, - "MissingDataConfigurations": { - "target": "com.amazonaws.quicksight#MissingDataConfigurationList", - "traits": { - "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series axis configuration of a line chart.

" - } - }, - "com.amazonaws.quicksight#LinkEntityArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - }, - "smithy.api#pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$" - } - }, - "com.amazonaws.quicksight#LinkEntityArnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#LinkEntityArn" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#LinkSharingConfiguration": { - "type": "structure", - "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that contains the permissions of a shareable link.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the configuration of a shareable link to the dashboard.

" - } - }, - "com.amazonaws.quicksight#ListAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAnalysesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/analyses", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AnalysisSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAnalysesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAnalysesResponse": { - "type": "structure", - "members": { - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", - "traits": { - "smithy.api#documentation": "

Metadata describing each of the analyses that are listed.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AssetBundleExportJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export jobs were executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { - "type": "structure", - "members": { - "AssetBundleExportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", - "traits": { - "smithy.api#documentation": "

A list of export job summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AssetBundleImportJobSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { - "type": "structure", - "members": { - "AssetBundleImportJobSummaryList": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", - "traits": { - "smithy.api#documentation": "

A list of import job summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListControlDisplayOptions": { - "type": "structure", - "members": { - "SearchOptions": { - "target": "com.amazonaws.quicksight#ListControlSearchOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the search options in a list control.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" - } - }, - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#ListControlSearchOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the search options in a list control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the search options in a list control.

" - } - }, - "com.amazonaws.quicksight#ListControlSelectAllOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the Select all options in a list control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" - } - }, - "com.amazonaws.quicksight#ListDashboardVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDashboardVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDashboardVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDashboardVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDashboardVersionsResponse": { - "type": "structure", - "members": { - "DashboardVersionSummaryList": { - "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains information about each version of the dashboard.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDashboards": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDashboardsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDashboardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists dashboards in an Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/dashboards", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDashboardsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboards that you're\n listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDashboardsResponse": { - "type": "structure", - "members": { - "DashboardSummaryList": { - "target": "com.amazonaws.quicksight#DashboardSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the dashboards in your Amazon Web Services account. This structure\n provides basic information about the dashboards.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDataSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDataSetsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDataSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSetSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDataSetsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDataSetsResponse": { - "type": "structure", - "members": { - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", - "traits": { - "smithy.api#documentation": "

The list of dataset summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSources", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListDataSourcesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListDataSourcesResponse": { - "type": "structure", - "members": { - "DataSources": { - "target": "com.amazonaws.quicksight#DataSourceList", - "traits": { - "smithy.api#documentation": "

A list of data sources.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListFolderMembers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListFolderMembersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListFolderMembersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderMemberList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListFolderMembersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListFolderMembersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderMemberList": { - "target": "com.amazonaws.quicksight#FolderMemberList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListFolders": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListFoldersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListFoldersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all folders in an account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/folders", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListFoldersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListFoldersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderSummaryList": { - "target": "com.amazonaws.quicksight#FolderSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListGroupMemberships": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListGroupMembershipsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListGroupMembershipsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists member users in a group.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupMemberList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListGroupMembershipsRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to see a membership list of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want a list of users from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListGroupMembershipsResponse": { - "type": "structure", - "members": { - "GroupMemberList": { - "target": "com.amazonaws.quicksight#GroupMemberList", - "traits": { - "smithy.api#documentation": "

The list of the members of the group.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all user groups in Amazon QuickSight.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListGroupsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want a list of groups from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

The list of the groups.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignments": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the\n\t\t\tIAM policy assignments in the current Amazon QuickSight\n\t\t\taccount.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "IAMPolicyAssignments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of\n\t\t\tthe IAM policy assignments, including the Amazon\n\t\t\tResource Names\n\t\t\t(ARNs),\n\t\t\tfor the IAM policies assigned to the specified user and\n\t\t\tgroup,\n\t\t\tor groups that the user belongs to.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ActiveAssignments", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The name of the user.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse": { - "type": "structure", - "members": { - "ActiveAssignments": { - "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", - "traits": { - "smithy.api#documentation": "

The active assignments for this user.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains these IAM policy\n\t\t\tassignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignments.

", - "smithy.api#httpQuery": "assignment-status" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace for the assignments.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { - "type": "structure", - "members": { - "IAMPolicyAssignments": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", - "traits": { - "smithy.api#documentation": "

Information describing the IAM policy assignments.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigs": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#ListIdentityPropagationMaxResults", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The maximum number of results to be returned.

", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse": { - "type": "structure", - "members": { - "Services": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsByServices", - "traits": { - "smithy.api#documentation": "

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListIdentityPropagationMaxResults": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#ListIngestions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListIngestionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListIngestionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the history of SPICE ingestions for a dataset.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Ingestions", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListIngestionsRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#IngestionMaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListIngestionsResponse": { - "type": "structure", - "members": { - "Ingestions": { - "target": "com.amazonaws.quicksight#Ingestions", - "traits": { - "smithy.api#documentation": "

A list of the ingestions.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListNamespaces": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListNamespacesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListNamespacesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "Namespaces", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListNamespacesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListNamespacesResponse": { - "type": "structure", - "members": { - "Namespaces": { - "target": "com.amazonaws.quicksight#Namespaces", - "traits": { - "smithy.api#documentation": "

The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and \n identity store.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListRefreshSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { - "type": "structure", - "members": { - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#RefreshSchedules", - "traits": { - "smithy.api#documentation": "

The list of refresh schedules for the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListRoleMemberships": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListRoleMembershipsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListRoleMembershipsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all groups that are associated with a role.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "MembersList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListRoleMembershipsRequest": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

", - "smithy.api#httpQuery": "max-results" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that includes the role.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListRoleMembershipsResponse": { - "type": "structure", - "members": { - "MembersList": { - "target": "com.amazonaws.quicksight#GroupsList", - "traits": { - "smithy.api#documentation": "

The list of groups associated with a role

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTagsForResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTagsForResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTagsForResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the tags assigned to a resource.

", - "smithy.api#http": { - "method": "GET", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTagsForResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTagsForResourceResponse": { - "type": "structure", - "members": { - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplateAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplateAliasesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplateAliasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the aliases of a template.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateAliasList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplateAliasesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplateAliasesResponse": { - "type": "structure", - "members": { - "TemplateAliasList": { - "target": "com.amazonaws.quicksight#TemplateAliasList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of the template's aliases.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplateVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplateVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplateVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the templates in the current Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplateVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplateVersionsResponse": { - "type": "structure", - "members": { - "TemplateVersionSummaryList": { - "target": "com.amazonaws.quicksight#TemplateVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing a list of all the versions of the specified template.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTemplates": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTemplatesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTemplatesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the templates in the current Amazon QuickSight account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/templates", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "TemplateSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTemplatesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTemplatesResponse": { - "type": "structure", - "members": { - "TemplateSummaryList": { - "target": "com.amazonaws.quicksight#TemplateSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing information about the templates in the list.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemeAliases": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemeAliasesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemeAliasesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the aliases of a theme.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListThemeAliasesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-result" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemeAliasesResponse": { - "type": "structure", - "members": { - "ThemeAliasList": { - "target": "com.amazonaws.quicksight#ThemeAliasList", - "traits": { - "smithy.api#documentation": "

A structure containing the list of the theme's aliases.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemeVersions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemeVersionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemeVersionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the versions of the themes in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/versions", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ThemeVersionSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListThemeVersionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemeVersionsResponse": { - "type": "structure", - "members": { - "ThemeVersionSummaryList": { - "target": "com.amazonaws.quicksight#ThemeVersionSummaryList", - "traits": { - "smithy.api#documentation": "

A structure containing a list of all the versions of the specified theme.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListThemes": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListThemesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListThemesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all the themes in the current Amazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/themes", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "ThemeSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListThemesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", - "traits": { - "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n ", - "smithy.api#httpQuery": "type" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListThemesResponse": { - "type": "structure", - "members": { - "ThemeSummaryList": { - "target": "com.amazonaws.quicksight#ThemeSummaryList", - "traits": { - "smithy.api#documentation": "

Information about the themes in the list.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedules": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the refresh schedules for a topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want described.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "RefreshSchedules": { - "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummaries", - "traits": { - "smithy.api#documentation": "

The list of topic refresh schedules.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all reviewed answers for a Q Topic.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Answers": { - "target": "com.amazonaws.quicksight#TopicReviewedAnswers", - "traits": { - "smithy.api#documentation": "

The definition of all Answers in the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListTopics": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListTopicsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListTopicsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the topics within an account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/topics", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListTopicsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topics that you want to\n list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListTopicsResponse": { - "type": "structure", - "members": { - "TopicsSummaries": { - "target": "com.amazonaws.quicksight#TopicSummaries", - "traits": { - "smithy.api#documentation": "

A list of topic summaries.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListUserGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListUserGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListUserGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListUserGroupsRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to list group memberships for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListUserGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

The list of groups the user is a member of.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListUsers": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListUsersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListUsersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Returns a list of all of the Amazon QuickSight users belonging to this account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "UserList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListUsersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListUsersResponse": { - "type": "structure", - "members": { - "UserList": { - "target": "com.amazonaws.quicksight#UserList", - "traits": { - "smithy.api#documentation": "

The list of users.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#ListVPCConnections": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#ListVPCConnectionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#ListVPCConnectionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Lists all of the VPC connections in the current set Amazon Web Services Region of an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#http": { - "method": "GET", - "uri": "/accounts/{AwsAccountId}/vpc-connections", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#ListVPCConnectionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connections\n\t\t\tthat you want to list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

", - "smithy.api#httpQuery": "max-results" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#ListVPCConnectionsResponse": { - "type": "structure", - "members": { - "VPCConnectionSummaries": { - "target": "com.amazonaws.quicksight#VPCConnectionSummaryList", - "traits": { - "smithy.api#documentation": "

A VPCConnectionSummaries object that returns a summary of VPC connection\n\t\t\tobjects.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more\n\t\t\tresults.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#LoadingAnimation": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of LoadingAnimation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of loading animation in free-form layout.

" - } - }, - "com.amazonaws.quicksight#LocalNavigationConfiguration": { - "type": "structure", - "members": { - "TargetSheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The sheet that is targeted for navigation in the same analysis.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The navigation configuration for CustomActionNavigationOperation.

" - } - }, - "com.amazonaws.quicksight#LogicalTable": { - "type": "structure", - "members": { - "Alias": { - "target": "com.amazonaws.quicksight#LogicalTableAlias", - "traits": { - "smithy.api#documentation": "

A display name for the logical table.

", - "smithy.api#required": {} - } - }, - "DataTransforms": { - "target": "com.amazonaws.quicksight#TransformOperationList", - "traits": { - "smithy.api#documentation": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

" - } - }, - "Source": { - "target": "com.amazonaws.quicksight#LogicalTableSource", - "traits": { - "smithy.api#documentation": "

Source of this logical table.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

" - } - }, - "com.amazonaws.quicksight#LogicalTableAlias": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#LogicalTableId": { - "type": "string", - "traits": { - "smithy.api#documentation": "

An identifier for the logical table that is defined in the dataset

", - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-]*$" - } - }, - "com.amazonaws.quicksight#LogicalTableMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LogicalTableId" - }, - "value": { - "target": "com.amazonaws.quicksight#LogicalTable" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#LogicalTableSource": { - "type": "structure", - "members": { - "JoinInstruction": { - "target": "com.amazonaws.quicksight#JoinInstruction", - "traits": { - "smithy.api#documentation": "

Specifies the result of a join of two logical tables.

" - } - }, - "PhysicalTableId": { - "target": "com.amazonaws.quicksight#PhysicalTableId", - "traits": { - "smithy.api#documentation": "

Physical table ID.

" - } - }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the parent dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#Long": { - "type": "long", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#LongFormatText": { - "type": "structure", - "members": { - "PlainText": { - "target": "com.amazonaws.quicksight#LongPlainText", - "traits": { - "smithy.api#documentation": "

Plain text format.

" - } - }, - "RichText": { - "target": "com.amazonaws.quicksight#LongRichText", - "traits": { - "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The text format for a subtitle.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#LongPlainText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#LongRichText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#Longitude": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -1800, - "max": 1800 - } - } - }, - "com.amazonaws.quicksight#LookbackWindow": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of the lookback window column.

", - "smithy.api#required": {} - } - }, - "Size": { - "target": "com.amazonaws.quicksight#PositiveLong", - "traits": { - "smithy.api#documentation": "

The lookback window column size.

", - "smithy.api#required": {} - } - }, - "SizeUnit": { - "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", - "traits": { - "smithy.api#documentation": "

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The lookback window setup of an incremental refresh configuration.

" - } - }, - "com.amazonaws.quicksight#LookbackWindowSizeUnit": { - "type": "enum", - "members": { - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - } - } - }, - "com.amazonaws.quicksight#ManifestFileLocation": { - "type": "structure", - "members": { - "Bucket": { - "target": "com.amazonaws.quicksight#S3Bucket", - "traits": { - "smithy.api#documentation": "

Amazon S3 bucket.

", - "smithy.api#required": {} - } - }, - "Key": { - "target": "com.amazonaws.quicksight#S3Key", - "traits": { - "smithy.api#documentation": "

Amazon S3 key that identifies an object.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Amazon S3 manifest file location.

" - } - }, - "com.amazonaws.quicksight#MapZoomMode": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - } - } - }, - "com.amazonaws.quicksight#MappedDataSetParameter": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

A unique name that identifies a dataset within the analysis or dashboard.

", - "smithy.api#required": {} - } - }, - "DataSetParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the dataset parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A dataset parameter that is mapped to an analysis parameter.

" - } - }, - "com.amazonaws.quicksight#MappedDataSetParameters": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MappedDataSetParameter" - }, - "traits": { - "smithy.api#documentation": "

A list of dataset parameters that are mapped to an analysis parameter.

", - "smithy.api#length": { - "min": 0, - "max": 150 - } - } - }, - "com.amazonaws.quicksight#MarginStyle": { - "type": "structure", - "members": { - "Show": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

This Boolean value controls whether to display sheet margins.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for margins around the outside edge of sheets.

" - } - }, - "com.amazonaws.quicksight#MariaDbParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for MariaDB.

" - } - }, - "com.amazonaws.quicksight#MaxResults": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#MaximumLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the maximum label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum label of a data path label.

" - } - }, - "com.amazonaws.quicksight#MaximumMinimumComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#MaximumMinimumComputationType", - "traits": { - "smithy.api#documentation": "

The type of computation. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The maximum and minimum computation configuration.

" - } - }, - "com.amazonaws.quicksight#MaximumMinimumComputationType": { - "type": "enum", - "members": { - "MAXIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAXIMUM" - } - }, - "MINIMUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINIMUM" - } - } - } - }, - "com.amazonaws.quicksight#MeasureField": { - "type": "structure", - "members": { - "NumericalMeasureField": { - "target": "com.amazonaws.quicksight#NumericalMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with numerical type columns.

" - } - }, - "CategoricalMeasureField": { - "target": "com.amazonaws.quicksight#CategoricalMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with categorical type columns.

" - } - }, - "DateMeasureField": { - "target": "com.amazonaws.quicksight#DateMeasureField", - "traits": { - "smithy.api#documentation": "

The measure type field with date type columns.

" - } - }, - "CalculatedMeasureField": { - "target": "com.amazonaws.quicksight#CalculatedMeasureField", - "traits": { - "smithy.api#documentation": "

The calculated measure field only used in pivot tables.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure (metric) type field.

" - } - }, - "com.amazonaws.quicksight#MeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#MemberIdArnPair": { - "type": "structure", - "members": { - "MemberId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the member.

" - } - }, - "MemberArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

" - } - }, - "com.amazonaws.quicksight#MemberType": { - "type": "enum", - "members": { - "DASHBOARD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHBOARD" - } - }, - "ANALYSIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ANALYSIS" - } - }, - "DATASET": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET" - } - }, - "DATASOURCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASOURCE" - } - }, - "TOPIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOPIC" - } - } - } - }, - "com.amazonaws.quicksight#MetricComparisonComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "FromValue": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The field that is used in a metric comparison from value setup.

" - } - }, - "TargetValue": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The field that is used in a metric comparison to value setup.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The metric comparison computation configuration.

" - } - }, - "com.amazonaws.quicksight#MinimumLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the minimum label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The minimum label of a data path label.

" - } - }, - "com.amazonaws.quicksight#MissingDataConfiguration": { - "type": "structure", - "members": { - "TreatmentOption": { - "target": "com.amazonaws.quicksight#MissingDataTreatmentOption", - "traits": { - "smithy.api#documentation": "

The treatment option that determines how missing data should be rendered. Choose\n from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" - } - }, - "com.amazonaws.quicksight#MissingDataConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MissingDataConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#MissingDataTreatmentOption": { - "type": "enum", - "members": { - "INTERPOLATE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERPOLATE" - } - }, - "SHOW_AS_ZERO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHOW_AS_ZERO" - } - }, - "SHOW_AS_BLANK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHOW_AS_BLANK" - } - } - } - }, - "com.amazonaws.quicksight#MySqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for MySQL.

" - } - }, - "com.amazonaws.quicksight#NamedEntityAggType": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "PERCENTILE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENTILE" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - } - } - }, - "com.amazonaws.quicksight#NamedEntityDefinition": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the entity.

" - } - }, - "PropertyName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The property name to be used for the named entity.

" - } - }, - "PropertyRole": { - "target": "com.amazonaws.quicksight#PropertyRole", - "traits": { - "smithy.api#documentation": "

The property role. Valid values for this structure are PRIMARY and ID.

" - } - }, - "PropertyUsage": { - "target": "com.amazonaws.quicksight#PropertyUsage", - "traits": { - "smithy.api#documentation": "

The property usage. Valid values for this structure are INHERIT,\n DIMENSION,\n and MEASURE.

" - } - }, - "Metric": { - "target": "com.amazonaws.quicksight#NamedEntityDefinitionMetric", - "traits": { - "smithy.api#documentation": "

The definition of a metric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a named entity.

" - } - }, - "com.amazonaws.quicksight#NamedEntityDefinitionMetric": { - "type": "structure", - "members": { - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedEntityAggType", - "traits": { - "smithy.api#documentation": "

The aggregation of a named entity. Valid values for this structure are SUM,\n MIN, MAX, COUNT, AVERAGE,\n DISTINCT_COUNT, STDEV, STDEVP, VAR,\n VARP, PERCENTILE,\n MEDIAN,\n and CUSTOM.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggregationFunctionParameters", - "traits": { - "smithy.api#documentation": "

The additional parameters for an aggregation function.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a metric.

" - } - }, - "com.amazonaws.quicksight#NamedEntityDefinitions": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NamedEntityDefinition" - } - }, - "com.amazonaws.quicksight#NamedEntityRef": { - "type": "structure", - "members": { - "NamedEntityName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The NamedEntityName for the NamedEntityRef.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a NamedEntityRef.

" - } - }, - "com.amazonaws.quicksight#NamedFilterAggType": { - "type": "enum", - "members": { - "NO_AGGREGATION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NO_AGGREGATION" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - } - } - }, - "com.amazonaws.quicksight#NamedFilterType": { - "type": "enum", - "members": { - "CATEGORY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CATEGORY_FILTER" - } - }, - "NUMERIC_EQUALITY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" - } - }, - "NUMERIC_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" - } - }, - "DATE_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE_FILTER" - } - }, - "RELATIVE_DATE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RELATIVE_DATE_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#Namespace": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" - } - }, - "com.amazonaws.quicksight#NamespaceError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#NamespaceErrorType", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The message for the error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Errors that occur during namespace creation.

" - } - }, - "com.amazonaws.quicksight#NamespaceErrorType": { - "type": "enum", - "members": { - "PERMISSION_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERMISSION_DENIED" - } - }, - "INTERNAL_SERVICE_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" - } - } - } - }, - "com.amazonaws.quicksight#NamespaceInfoV2": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The name of the error.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The namespace ARN.

" - } - }, - "CapacityRegion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The namespace Amazon Web Services Region.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#NamespaceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of a namespace that is not yet completely created.

" - } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "

The identity store used for the namespace.

" - } - }, - "NamespaceError": { - "target": "com.amazonaws.quicksight#NamespaceError", - "traits": { - "smithy.api#documentation": "

An error that occurred when the namespace was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The error type.

" - } - }, - "com.amazonaws.quicksight#NamespaceStatus": { - "type": "enum", - "members": { - "CREATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATED" - } - }, - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "RETRYABLE_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RETRYABLE_FAILURE" - } - }, - "NON_RETRYABLE_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" - } - } - } - }, - "com.amazonaws.quicksight#Namespaces": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NamespaceInfoV2" - } - }, - "com.amazonaws.quicksight#NarrativeString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150000 - } - } - }, - "com.amazonaws.quicksight#NegativeFormat": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The prefix for a negative format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The suffix for a negative format.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a negative format.

" - } - }, - "com.amazonaws.quicksight#NegativeValueConfiguration": { - "type": "structure", - "members": { - "DisplayMode": { - "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", - "traits": { - "smithy.api#documentation": "

Determines the display mode of the negative value configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "com.amazonaws.quicksight#NegativeValueDisplayMode": { - "type": "enum", - "members": { - "POSITIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POSITIVE" - } - }, - "NEGATIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEGATIVE" - } - } - } - }, - "com.amazonaws.quicksight#NestedFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeInnerSet": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

", - "smithy.api#required": {} - } - }, - "InnerFilter": { - "target": "com.amazonaws.quicksight#InnerFilter", - "traits": { - "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" - } - }, - "com.amazonaws.quicksight#NetworkInterface": { - "type": "structure", - "members": { - "SubnetId": { - "target": "com.amazonaws.quicksight#SubnetId", - "traits": { - "smithy.api#documentation": "

The subnet ID associated with the network interface.

" - } - }, - "AvailabilityZone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The availability zone that the network interface resides in.

" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An error message.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#NetworkInterfaceStatus", - "traits": { - "smithy.api#documentation": "

The status of the network interface.

" - } - }, - "NetworkInterfaceId": { - "target": "com.amazonaws.quicksight#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "

The network interface ID.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure that contains information about a network interface.

" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 255 - }, - "smithy.api#pattern": "^eni-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#NetworkInterface" - } - }, - "com.amazonaws.quicksight#NetworkInterfaceStatus": { - "type": "enum", - "members": { - "CREATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATING" - } - }, - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATING" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETING" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - }, - "DELETION_SCHEDULED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_SCHEDULED" - } - }, - "ATTACHMENT_FAILED_ROLLBACK_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ATTACHMENT_FAILED_ROLLBACK_FAILED" - } - } - } - }, - "com.amazonaws.quicksight#NewDefaultValues": { - "type": "structure", - "members": { - "StringStaticValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given string parameter.

" - } - }, - "DecimalStaticValues": { - "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" - } - }, - "DateTimeStaticValues": { - "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" - } - }, - "IntegerStaticValues": { - "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

" - } - }, - "com.amazonaws.quicksight#NonEmptyString": { - "type": "string", - "traits": { - "smithy.api#pattern": "\\S" - } - }, - "com.amazonaws.quicksight#NonRepeatingVisualsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#NullFilterOption": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - }, - "NON_NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NON_NULLS_ONLY" - } - }, - "NULLS_ONLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULLS_ONLY" - } - } - } - }, - "com.amazonaws.quicksight#NullString": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#NullValueFormatConfiguration": { - "type": "structure", - "members": { - "NullString": { - "target": "com.amazonaws.quicksight#NullString", - "traits": { - "smithy.api#documentation": "

Determines the null string of null values.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "com.amazonaws.quicksight#NullableBoolean": { - "type": "boolean" - }, - "com.amazonaws.quicksight#NumberDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the number format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the number format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NumberScale": { - "target": "com.amazonaws.quicksight#NumberScale", - "traits": { - "smithy.api#documentation": "

Determines the number scale value of the number format.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the number display format configuration.

" - } - }, - "com.amazonaws.quicksight#NumberFormatConfiguration": { - "type": "structure", - "members": { - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for number fields.

" - } - }, - "com.amazonaws.quicksight#NumberScale": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "THOUSANDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THOUSANDS" - } - }, - "MILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MILLIONS" - } - }, - "BILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BILLIONS" - } - }, - "TRILLIONS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TRILLIONS" - } - } - } - }, - "com.amazonaws.quicksight#NumericAxisOptions": { - "type": "structure", - "members": { - "Scale": { - "target": "com.amazonaws.quicksight#AxisScale", - "traits": { - "smithy.api#documentation": "

The scale setup of a numeric axis.

" - } - }, - "Range": { - "target": "com.amazonaws.quicksight#AxisDisplayRange", - "traits": { - "smithy.api#documentation": "

The range setup of a numeric axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for an axis with a numeric field.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The value of the double input numeric drill down filter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The numeric equality type drill down filter.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The input value.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "MatchOperator": { - "target": "com.amazonaws.quicksight#NumericEqualityMatchOperator", - "traits": { - "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the filter.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A NumericEqualityFilter filters values that are equal to the specified value.

" - } - }, - "com.amazonaws.quicksight#NumericEqualityMatchOperator": { - "type": "enum", - "members": { - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "DOES_NOT_EQUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOES_NOT_EQUAL" - } - } - } - }, - "com.amazonaws.quicksight#NumericFilterSelectAllOptions": { - "type": "enum", - "members": { - "FILTER_ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FILTER_ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#NumericFormatConfiguration": { - "type": "structure", - "members": { - "NumberDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the number display format configuration.

" - } - }, - "CurrencyDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the currency display format configuration.

" - } - }, - "PercentageDisplayFormatConfiguration": { - "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the numeric format configuration.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#NumericRangeFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeMinimum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" - } - }, - "IncludeMaximum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" - } - }, - "RangeMinimum": { - "target": "com.amazonaws.quicksight#NumericRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

" - } - }, - "RangeMaximum": { - "target": "com.amazonaws.quicksight#NumericRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

" - } - }, - "SelectAllOptions": { - "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", - "traits": { - "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the filter.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A NumericRangeFilter filters values that are within the value range.

" - } - }, - "com.amazonaws.quicksight#NumericRangeFilterValue": { - "type": "structure", - "members": { - "StaticValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The static value of the numeric range filter.

" - } - }, - "Parameter": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter that is used in the numeric range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value input pf the numeric range filter.

" - } - }, - "com.amazonaws.quicksight#NumericSeparatorConfiguration": { - "type": "structure", - "members": { - "DecimalSeparator": { - "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the decimal separator.

" - } - }, - "ThousandsSeparator": { - "target": "com.amazonaws.quicksight#ThousandSeparatorOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "com.amazonaws.quicksight#NumericSeparatorSymbol": { - "type": "enum", - "members": { - "COMMA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMA" - } - }, - "DOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOT" - } - }, - "SPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SPACE" - } - } - } - }, - "com.amazonaws.quicksight#NumericalAggregationFunction": { - "type": "structure", - "members": { - "SimpleNumericalAggregation": { - "target": "com.amazonaws.quicksight#SimpleNumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

Built-in aggregation functions for numerical values.

\n " - } - }, - "PercentileAggregation": { - "target": "com.amazonaws.quicksight#PercentileAggregation", - "traits": { - "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregation for numerical values.

" - } - }, - "com.amazonaws.quicksight#NumericalDimensionField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the NumericalDimensionField.

", - "smithy.api#required": {} - } - }, - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The custom hierarchy ID.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The dimension type field with numerical type columns.

" - } - }, - "com.amazonaws.quicksight#NumericalMeasureField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the NumericalMeasureField.

", - "smithy.api#required": {} - } - }, - "AggregationFunction": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function of the measure field.

" - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumberFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The measure type field with numerical type columns.

" - } - }, - "com.amazonaws.quicksight#OnClause": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#OperandList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Identifier" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 25 - } - } - }, - "com.amazonaws.quicksight#OptionalPort": { - "type": "integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 65535 - } - } - }, - "com.amazonaws.quicksight#OracleParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

An Oracle host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

The database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Oracle.

" - } - }, - "com.amazonaws.quicksight#OtherCategories": { - "type": "enum", - "members": { - "INCLUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INCLUDE" - } - }, - "EXCLUDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCLUDE" - } - } - } - }, - "com.amazonaws.quicksight#OutputColumn": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The display name of the column..

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#ColumnDescriptiveText", - "traits": { - "smithy.api#documentation": "

A description for a column.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ColumnDataType", - "traits": { - "smithy.api#documentation": "

The data type of the column.

" - } - }, - "SubType": { - "target": "com.amazonaws.quicksight#ColumnDataSubType", - "traits": { - "smithy.api#documentation": "

The sub data type of the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Output column.

" - } - }, - "com.amazonaws.quicksight#OutputColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#OutputColumn" - } - }, - "com.amazonaws.quicksight#OverrideDatasetParameterOperation": { - "type": "structure", - "members": { - "ParameterName": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter to be overridden with different values.

", - "smithy.api#required": {} - } - }, - "NewParameterName": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The new name for the parameter.

" - } - }, - "NewDefaultValues": { - "target": "com.amazonaws.quicksight#NewDefaultValues", - "traits": { - "smithy.api#documentation": "

The new default values for the parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

" - } - }, - "com.amazonaws.quicksight#PageNumber": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 0 - } - } - }, - "com.amazonaws.quicksight#PaginationConfiguration": { - "type": "structure", - "members": { - "PageSize": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Indicates how many items render in one page.

", - "smithy.api#required": {} - } - }, - "PageNumber": { - "target": "com.amazonaws.quicksight#PageNumber", - "traits": { - "smithy.api#documentation": "

Indicates the page number.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The pagination configuration for a table visual or boxplot.

" - } - }, - "com.amazonaws.quicksight#PanelBorderStyle": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - } - } - }, - "com.amazonaws.quicksight#PanelConfiguration": { - "type": "structure", - "members": { - "Title": { - "target": "com.amazonaws.quicksight#PanelTitleOptions", - "traits": { - "smithy.api#documentation": "

Configures the title display within each small multiples panel.

" - } - }, - "BorderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not each panel displays a border.

" - } - }, - "BorderThickness": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Sets the line thickness of panel borders.

" - } - }, - "BorderStyle": { - "target": "com.amazonaws.quicksight#PanelBorderStyle", - "traits": { - "smithy.api#documentation": "

Sets the line style of panel borders.

" - } - }, - "BorderColor": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

Sets the line color of panel borders.

" - } - }, - "GutterVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not negative space between sibling panels is rendered.

" - } - }, - "GutterSpacing": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

Sets the total amount of negative space to display between sibling panels.

" - } - }, - "BackgroundVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not a background for each small multiples panel is rendered.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColorWithTransparency", - "traits": { - "smithy.api#documentation": "

Sets the background color for each panel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A collection of options that configure how each panel displays in a small multiples chart.

" - } - }, - "com.amazonaws.quicksight#PanelTitleOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not panel titles are displayed.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration" - }, - "HorizontalTextAlignment": { - "target": "com.amazonaws.quicksight#HorizontalTextAlignment", - "traits": { - "smithy.api#documentation": "

Sets the horizontal text alignment of the title within each panel.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the title styles for each small multiples\n panel.

" - } - }, - "com.amazonaws.quicksight#PaperOrientation": { - "type": "enum", - "members": { - "PORTRAIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PORTRAIT" - } - }, - "LANDSCAPE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LANDSCAPE" - } - } - } - }, - "com.amazonaws.quicksight#PaperSize": { - "type": "enum", - "members": { - "US_LETTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_LETTER" - } - }, - "US_LEGAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_LEGAL" - } - }, - "US_TABLOID_LEDGER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "US_TABLOID_LEDGER" - } - }, - "A0": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A0" - } - }, - "A1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A1" - } - }, - "A2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A2" - } - }, - "A3": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A3" - } - }, - "A4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A4" - } - }, - "A5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "A5" - } - }, - "JIS_B4": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIS_B4" - } - }, - "JIS_B5": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "JIS_B5" - } - } - } - }, - "com.amazonaws.quicksight#ParameterControl": { - "type": "structure", - "members": { - "DateTimePicker": { - "target": "com.amazonaws.quicksight#ParameterDateTimePickerControl", - "traits": { - "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" - } - }, - "List": { - "target": "com.amazonaws.quicksight#ParameterListControl", - "traits": { - "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" - } - }, - "Dropdown": { - "target": "com.amazonaws.quicksight#ParameterDropDownControl", - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "TextField": { - "target": "com.amazonaws.quicksight#ParameterTextFieldControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "TextArea": { - "target": "com.amazonaws.quicksight#ParameterTextAreaControl", - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "Slider": { - "target": "com.amazonaws.quicksight#ParameterSliderControl", - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The control of a parameter that users can interact with in a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ParameterControlList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ParameterControl" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ParameterDateTimePickerControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the ParameterDateTimePickerControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" - } - }, - "com.amazonaws.quicksight#ParameterDeclaration": { - "type": "structure", - "members": { - "StringParameterDeclaration": { - "target": "com.amazonaws.quicksight#StringParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the String data type.

" - } - }, - "DecimalParameterDeclaration": { - "target": "com.amazonaws.quicksight#DecimalParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" - } - }, - "IntegerParameterDeclaration": { - "target": "com.amazonaws.quicksight#IntegerParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" - } - }, - "DateTimeParameterDeclaration": { - "target": "com.amazonaws.quicksight#DateTimeParameterDeclaration", - "traits": { - "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The declaration definition of a parameter.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ParameterDeclarationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ParameterDeclaration" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ParameterDropDownControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterDropDownControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type parameter name of the ParameterDropDownControl.

" - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#ParameterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" - } - }, - "com.amazonaws.quicksight#ParameterListControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterListControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#ListControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#SheetControlListType", - "traits": { - "smithy.api#documentation": "

The type of ParameterListControl.

" - } - }, - "SelectableValues": { - "target": "com.amazonaws.quicksight#ParameterSelectableValues", - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "CascadingControlConfiguration": { - "target": "com.amazonaws.quicksight#CascadingControlConfiguration", - "traits": { - "smithy.api#documentation": "

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.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" - } - }, - "com.amazonaws.quicksight#ParameterName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[a-zA-Z0-9]+$" - } - }, - "com.amazonaws.quicksight#ParameterSelectableValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#ParameterSelectableValues": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#ParameterSelectableValueList", - "traits": { - "smithy.api#documentation": "

The values that are used in ParameterSelectableValues.

" - } - }, - "LinkToDataSetColumn": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column identifier that fetches values from the data set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of selectable values that are used in a control.

" - } - }, - "com.amazonaws.quicksight#ParameterSliderControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterSliderControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "MaximumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", - "smithy.api#required": {} - } - }, - "MinimumValue": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", - "smithy.api#required": {} - } - }, - "StepSize": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" - } - }, - "com.amazonaws.quicksight#ParameterTextAreaControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterTextAreaControl.

", - "smithy.api#required": {} - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", - "traits": { - "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" - } - }, - "com.amazonaws.quicksight#ParameterTextFieldControl": { - "type": "structure", - "members": { - "ParameterControlId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetControlTitle", - "traits": { - "smithy.api#documentation": "

The title of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "SourceParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The source parameter name of the ParameterTextFieldControl.

", - "smithy.api#required": {} - } - }, - "DisplayOptions": { - "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" - } - }, - "com.amazonaws.quicksight#ParameterValueType": { - "type": "enum", - "members": { - "MULTI_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_VALUED" - } - }, - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - } - } - }, - "com.amazonaws.quicksight#Parameters": { - "type": "structure", - "members": { - "StringParameters": { - "target": "com.amazonaws.quicksight#StringParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of string.

" - } - }, - "IntegerParameters": { - "target": "com.amazonaws.quicksight#IntegerParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of integer.

" - } - }, - "DecimalParameters": { - "target": "com.amazonaws.quicksight#DecimalParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of decimal.

" - } - }, - "DateTimeParameters": { - "target": "com.amazonaws.quicksight#DateTimeParameterList", - "traits": { - "smithy.api#documentation": "

The parameters that have a data type of date-time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A list of Amazon QuickSight parameters and the list's override values.

" - } - }, - "com.amazonaws.quicksight#Password": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#Path": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Arn" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#PercentNumber": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PercentVisibleRange": { - "type": "structure", - "members": { - "From": { - "target": "com.amazonaws.quicksight#PercentNumber", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower bound of the range.

" - } - }, - "To": { - "target": "com.amazonaws.quicksight#PercentNumber", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The top bound of the range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The percent range in the visible range.

" - } - }, - "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration": { - "type": "structure", - "members": { - "Prefix": { - "target": "com.amazonaws.quicksight#Prefix", - "traits": { - "smithy.api#documentation": "

Determines the prefix value of the percentage format.

" - } - }, - "Suffix": { - "target": "com.amazonaws.quicksight#Suffix", - "traits": { - "smithy.api#documentation": "

Determines the suffix value of the percentage format.

" - } - }, - "SeparatorConfiguration": { - "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" - } - }, - "DecimalPlacesConfiguration": { - "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", - "traits": { - "smithy.api#documentation": "

The option that determines the decimal places configuration.

" - } - }, - "NegativeValueConfiguration": { - "target": "com.amazonaws.quicksight#NegativeValueConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the negative value configuration.

" - } - }, - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" - } - }, - "com.amazonaws.quicksight#PercentileAggregation": { - "type": "structure", - "members": { - "PercentileValue": { - "target": "com.amazonaws.quicksight#PercentileValue", - "traits": { - "smithy.api#documentation": "

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" - } - }, - "com.amazonaws.quicksight#PercentileValue": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PeriodOverPeriodComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The period over period computation configuration.

" - } - }, - "com.amazonaws.quicksight#PeriodToDateComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "PeriodTimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity setup of period to date computation. Choose from the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The period to date computation configuration.

" - } - }, - "com.amazonaws.quicksight#PeriodsBackward": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 0, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#PeriodsForward": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 1000 - } - } - }, - "com.amazonaws.quicksight#PhysicalTable": { - "type": "union", - "members": { - "RelationalTable": { - "target": "com.amazonaws.quicksight#RelationalTable", - "traits": { - "smithy.api#documentation": "

A physical table type for relational data sources.

" - } - }, - "CustomSql": { - "target": "com.amazonaws.quicksight#CustomSql", - "traits": { - "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" - } - }, - "S3Source": { - "target": "com.amazonaws.quicksight#S3Source", - "traits": { - "smithy.api#documentation": "

A physical table type for as S3 data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

" - } - }, - "com.amazonaws.quicksight#PhysicalTableId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[0-9a-zA-Z-]*$" - } - }, - "com.amazonaws.quicksight#PhysicalTableMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#PhysicalTableId" - }, - "value": { - "target": "com.amazonaws.quicksight#PhysicalTable" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#PieChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category (group/color) field wells of a pie chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a pie chart. Values are aggregated based on categories.

" - } - }, - "SmallMultiples": { - "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The small multiples field well of a pie chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#PieChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#PieChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a pie chart.

" - } - }, - "DonutOptions": { - "target": "com.amazonaws.quicksight#DonutOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

" - } - }, - "SmallMultiplesOptions": { - "target": "com.amazonaws.quicksight#SmallMultiplesOptions", - "traits": { - "smithy.api#documentation": "

The small multiples setup for the visual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options of the group/color that is displayed in a pie chart.

" - } - }, - "ValueLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options for the value that is displayed in a pie chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "ContributionAnalysisDefaults": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", - "traits": { - "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartFieldWells": { - "type": "structure", - "members": { - "PieChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#PieChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a pie chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#PieChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of categories that are displayed in a pie chart.

" - } - }, - "SmallMultiplesSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the small multiples field.

" - } - }, - "SmallMultiplesLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a pie chart.

" - } - }, - "com.amazonaws.quicksight#PieChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#PieChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a pie chart.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A pie or donut chart.

\n

The PieChartVisual structure describes a visual that is a member of the pie chart family.

\n

The following charts can be described by using this structure:

\n \n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

\n

For more information, see Using donut charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#PivotFieldSortOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for the field sort options.

", - "smithy.api#required": {} - } - }, - "SortBy": { - "target": "com.amazonaws.quicksight#PivotTableSortBy", - "traits": { - "smithy.api#documentation": "

The sort by field for the field sort options.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" - } - }, - "com.amazonaws.quicksight#PivotFieldSortOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotFieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#PivotMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 40 - } - } - }, - "com.amazonaws.quicksight#PivotTableAggregatedFieldWells": { - "type": "structure", - "members": { - "Rows": { - "target": "com.amazonaws.quicksight#PivotTableDimensionList", - "traits": { - "smithy.api#documentation": "

The rows field well for a pivot table. Values are grouped by rows fields.

" - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#PivotTableDimensionList", - "traits": { - "smithy.api#documentation": "

The columns field well for a pivot table. Values are grouped by columns fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#PivotMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for the pivot table.

" - } - }, - "com.amazonaws.quicksight#PivotTableCellConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", - "smithy.api#required": {} - } - }, - "TextFormat": { - "target": "com.amazonaws.quicksight#TextConditionalFormat", - "traits": { - "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" - } - }, - "Scope": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope", - "traits": { - "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" - } - }, - "Scopes": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList", - "traits": { - "smithy.api#documentation": "

A list of cell scopes for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingOption": { - "type": "structure", - "members": { - "Cell": { - "target": "com.amazonaws.quicksight#PivotTableCellConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScope": { - "type": "structure", - "members": { - "Role": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole", - "traits": { - "smithy.api#documentation": "

The role (field, field total, grand total) of the cell for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole": { - "type": "enum", - "members": { - "FIELD": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD" - } - }, - "FIELD_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIELD_TOTAL" - } - }, - "GRAND_TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRAND_TOTAL" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#PivotTableFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#PivotTableSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" - } - }, - "TableOptions": { - "target": "com.amazonaws.quicksight#PivotTableOptions", - "traits": { - "smithy.api#documentation": "

The table options for a pivot table visual.

" - } - }, - "TotalOptions": { - "target": "com.amazonaws.quicksight#PivotTableTotalOptions", - "traits": { - "smithy.api#documentation": "

The total options for a pivot table visual.

" - } - }, - "FieldOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldOptions", - "traits": { - "smithy.api#documentation": "

The field options for a pivot table visual.

" - } - }, - "PaginatedReportOptions": { - "target": "com.amazonaws.quicksight#PivotTablePaginatedReportOptions", - "traits": { - "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableDataPathOption": { - "type": "structure", - "members": { - "DataPathList": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The list of data path values for the data path options.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width of the data path option.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The data path options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableDataPathOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableDataPathOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableDataPathType": { - "type": "enum", - "members": { - "HIERARCHY_ROWS_LAYOUT_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY_ROWS_LAYOUT_COLUMN" - } - }, - "MULTIPLE_ROW_METRICS_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTIPLE_ROW_METRICS_COLUMN" - } - }, - "EMPTY_COLUMN_HEADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPTY_COLUMN_HEADER" - } - }, - "COUNT_METRIC_COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT_METRIC_COLUMN" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableDimensionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 40 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseState": { - "type": "enum", - "members": { - "COLLAPSED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLLAPSED" - } - }, - "EXPANDED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXPANDED" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption": { - "type": "structure", - "members": { - "Target": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget", - "traits": { - "smithy.api#documentation": "

A tagged-union object that sets the collapse state.

", - "smithy.api#required": {} - } - }, - "State": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseState", - "traits": { - "smithy.api#documentation": "

The state of the field target of a pivot table. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption" - } - }, - "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The field ID of the pivot table that the collapse state needs to be set to.

" - } - }, - "FieldDataPathValues": { - "target": "com.amazonaws.quicksight#DataPathValueList", - "traits": { - "smithy.api#documentation": "

The data path of the pivot table's header. Used to set the collapse state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The target of a pivot table field collapse state.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the pivot table field.

", - "smithy.api#required": {} - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#CustomLabel", - "traits": { - "smithy.api#documentation": "

The custom label of the pivot table field.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the pivot table field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The selected field options for the pivot table field options.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldOptions": { - "type": "structure", - "members": { - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldOptionList", - "traits": { - "smithy.api#documentation": "

The selected field options for the pivot table field options.

" - } - }, - "DataPathOptions": { - "target": "com.amazonaws.quicksight#PivotTableDataPathOptionList", - "traits": { - "smithy.api#documentation": "

The data path options for the pivot table field options.

" - } - }, - "CollapseStateOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList", - "traits": { - "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the subtotal options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The optional configuration of subtotals cells.

" - } - }, - "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#PivotTableFieldWells": { - "type": "structure", - "members": { - "PivotTableAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#PivotTableAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for the pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells for a pivot table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#PivotTableMetricPlacement": { - "type": "enum", - "members": { - "ROW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ROW" - } - }, - "COLUMN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COLUMN" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableOptions": { - "type": "structure", - "members": { - "MetricPlacement": { - "target": "com.amazonaws.quicksight#PivotTableMetricPlacement", - "traits": { - "smithy.api#documentation": "

The metric placement (row, column) options.

" - } - }, - "SingleMetricVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the single metric options.

" - } - }, - "ColumnNamesVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the column names.

" - } - }, - "ToggleButtonsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the pivot table.

" - } - }, - "ColumnHeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of the column header.

" - } - }, - "RowHeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of the row headers.

" - } - }, - "CellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of cells.

" - } - }, - "RowFieldNamesStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of row field names.

" - } - }, - "RowAlternateColorOptions": { - "target": "com.amazonaws.quicksight#RowAlternateColorOptions", - "traits": { - "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors).

" - } - }, - "CollapsedRowDimensionsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

" - } - }, - "RowsLayout": { - "target": "com.amazonaws.quicksight#PivotTableRowsLayout", - "traits": { - "smithy.api#documentation": "

The layout for the row dimension headers of a pivot table. Choose one of the following options.

\n " - } - }, - "RowsLabelOptions": { - "target": "com.amazonaws.quicksight#PivotTableRowsLabelOptions", - "traits": { - "smithy.api#documentation": "

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" - } - }, - "DefaultCellWidth": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The default cell width of the pivot table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTablePaginatedReportOptions": { - "type": "structure", - "members": { - "VerticalOverflowVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the printing table overflow across pages.

" - } - }, - "OverflowColumnHeaderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the repeating header rows on each page.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableRowsLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the rows label.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#PivotTableRowsLabelText", - "traits": { - "smithy.api#documentation": "

The custom label string for the rows label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" - } - }, - "com.amazonaws.quicksight#PivotTableRowsLabelText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#PivotTableRowsLayout": { - "type": "enum", - "members": { - "TABULAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TABULAR" - } - }, - "HIERARCHY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIERARCHY" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableSortBy": { - "type": "structure", - "members": { - "Field": { - "target": "com.amazonaws.quicksight#FieldSort", - "traits": { - "smithy.api#documentation": "

The field sort (field id, direction) for the pivot table sort by options.

" - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnSort", - "traits": { - "smithy.api#documentation": "

The column sort (field id, direction) for the pivot table sort by options.

" - } - }, - "DataPath": { - "target": "com.amazonaws.quicksight#DataPathSort", - "traits": { - "smithy.api#documentation": "

The data path sort (data path value, direction) for the pivot table sort by options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort by field for the field sort options.

" - } - }, - "com.amazonaws.quicksight#PivotTableSortConfiguration": { - "type": "structure", - "members": { - "FieldSortOptions": { - "target": "com.amazonaws.quicksight#PivotFieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PivotTableSubtotalLevel": { - "type": "enum", - "members": { - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - } - } - }, - "com.amazonaws.quicksight#PivotTableTotalOptions": { - "type": "structure", - "members": { - "RowSubtotalOptions": { - "target": "com.amazonaws.quicksight#SubtotalOptions", - "traits": { - "smithy.api#documentation": "

The row subtotal options.

" - } - }, - "ColumnSubtotalOptions": { - "target": "com.amazonaws.quicksight#SubtotalOptions", - "traits": { - "smithy.api#documentation": "

The column subtotal options.

" - } - }, - "RowTotalOptions": { - "target": "com.amazonaws.quicksight#PivotTotalOptions", - "traits": { - "smithy.api#documentation": "

The row total options.

" - } - }, - "ColumnTotalOptions": { - "target": "com.amazonaws.quicksight#PivotTotalOptions", - "traits": { - "smithy.api#documentation": "

The column total options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total options for a pivot table visual.

" - } - }, - "com.amazonaws.quicksight#PivotTableVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#PivotTableConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#PivotTableConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#PivotTotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the total cells.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#TableTotalsPlacement", - "traits": { - "smithy.api#documentation": "

The placement (start, end) for the total cells.

" - } - }, - "ScrollStatus": { - "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", - "traits": { - "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the total cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the total cells.

" - } - }, - "ValueCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the totals of value cells.

" - } - }, - "MetricHeaderCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the total of header cells.

" - } - }, - "TotalAggregationOptions": { - "target": "com.amazonaws.quicksight#TotalAggregationOptionList", - "traits": { - "smithy.api#documentation": "

The total aggregation options for each value field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The optional configuration of totals cells in a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#PixelLength": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit in px" - } - }, - "com.amazonaws.quicksight#Port": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 65535 - } - } - }, - "com.amazonaws.quicksight#PositiveInteger": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#PositiveLong": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#PostgreSqlParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for PostgreSQL.

" - } - }, - "com.amazonaws.quicksight#PreconditionNotMetException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more preconditions aren't met.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#PredefinedHierarchy": { - "type": "structure", - "members": { - "HierarchyId": { - "target": "com.amazonaws.quicksight#HierarchyId", - "traits": { - "smithy.api#documentation": "

The hierarchy ID of the predefined hierarchy.

", - "smithy.api#required": {} - } - }, - "Columns": { - "target": "com.amazonaws.quicksight#PredefinedHierarchyColumnList", - "traits": { - "smithy.api#documentation": "

The list of columns that define the predefined hierarchy.

", - "smithy.api#required": {} - } - }, - "DrillDownFilters": { - "target": "com.amazonaws.quicksight#DrillDownFilterList", - "traits": { - "smithy.api#documentation": "

The option that determines the drill down filters for the predefined hierarchy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "com.amazonaws.quicksight#PredefinedHierarchyColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ColumnIdentifier" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#PredictionInterval": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 50, - "max": 95 - } - } - }, - "com.amazonaws.quicksight#Prefix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#PrestoParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

Catalog.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Presto.

" - } - }, - "com.amazonaws.quicksight#PrimaryValueDisplayType": { - "type": "enum", - "members": { - "HIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIDDEN" - } - }, - "COMPARISON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPARISON" - } - }, - "ACTUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACTUAL" - } - } - } - }, - "com.amazonaws.quicksight#Principal": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#PrincipalList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ProgressBarOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the progress bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#ProjectId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#ProjectOperation": { - "type": "structure", - "members": { - "ProjectedColumns": { - "target": "com.amazonaws.quicksight#ProjectedColumnList", - "traits": { - "smithy.api#documentation": "

Projected columns.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

" - } - }, - "com.amazonaws.quicksight#ProjectedColumnList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#PropertyRole": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "ID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ID" - } - } - } - }, - "com.amazonaws.quicksight#PropertyUsage": { - "type": "enum", - "members": { - "INHERIT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INHERIT" - } - }, - "DIMENSION": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DIMENSION" - } - }, - "MEASURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEASURE" - } - } - } - }, - "com.amazonaws.quicksight#PurchaseMode": { - "type": "enum", - "members": { - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - }, - "AUTO_PURCHASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO_PURCHASE" - } - } - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshProperties": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates or updates the dataset refresh properties for the dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetRefreshProperties": { - "target": "com.amazonaws.quicksight#DataSetRefreshProperties", - "traits": { - "smithy.api#documentation": "

The dataset refresh properties.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Query": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#QueryExecutionMode": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "MANUAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MANUAL" - } - } - } - }, - "com.amazonaws.quicksight#QueryExecutionOptions": { - "type": "structure", - "members": { - "QueryExecutionMode": { - "target": "com.amazonaws.quicksight#QueryExecutionMode", - "traits": { - "smithy.api#documentation": "

A structure that describes the query execution mode.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that describes the query execution options.

" - } - }, - "com.amazonaws.quicksight#QueueInfo": { - "type": "structure", - "members": { - "WaitingOnIngestion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the queued ingestion.

", - "smithy.api#required": {} - } - }, - "QueuedIngestion": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a queued dataset SPICE ingestion.

" - } - }, - "com.amazonaws.quicksight#QuickSightUserNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The user with the provided name isn't found. This error can happen in any operation\n\t\t\tthat requires finding a user based on a provided user name, such as\n\t\t\t\tDeleteUser, DescribeUser, and so on.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.quicksight#QuickSight_20180401": { - "type": "service", - "version": "2018-04-01", - "operations": [ - { - "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer" - }, - { - "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer" - }, - { - "target": "com.amazonaws.quicksight#CancelIngestion" - }, - { - "target": "com.amazonaws.quicksight#CreateAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#CreateAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#CreateAnalysis" - }, - { - "target": "com.amazonaws.quicksight#CreateDashboard" - }, - { - "target": "com.amazonaws.quicksight#CreateDataSet" - }, - { - "target": "com.amazonaws.quicksight#CreateDataSource" - }, - { - "target": "com.amazonaws.quicksight#CreateFolder" - }, - { - "target": "com.amazonaws.quicksight#CreateFolderMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateGroup" - }, - { - "target": "com.amazonaws.quicksight#CreateGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#CreateIngestion" - }, - { - "target": "com.amazonaws.quicksight#CreateNamespace" - }, - { - "target": "com.amazonaws.quicksight#CreateRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#CreateRoleMembership" - }, - { - "target": "com.amazonaws.quicksight#CreateTemplate" - }, - { - "target": "com.amazonaws.quicksight#CreateTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#CreateTheme" - }, - { - "target": "com.amazonaws.quicksight#CreateThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#CreateTopic" - }, - { - "target": "com.amazonaws.quicksight#CreateTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#CreateVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#DeleteAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#DeleteAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#DeleteAnalysis" - }, - { - "target": "com.amazonaws.quicksight#DeleteDashboard" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSet" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#DeleteDataSource" - }, - { - "target": "com.amazonaws.quicksight#DeleteFolder" - }, - { - "target": "com.amazonaws.quicksight#DeleteFolderMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteGroup" - }, - { - "target": "com.amazonaws.quicksight#DeleteGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfig" - }, - { - "target": "com.amazonaws.quicksight#DeleteNamespace" - }, - { - "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DeleteRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#DeleteRoleMembership" - }, - { - "target": "com.amazonaws.quicksight#DeleteTemplate" - }, - { - "target": "com.amazonaws.quicksight#DeleteTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#DeleteTheme" - }, - { - "target": "com.amazonaws.quicksight#DeleteThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#DeleteTopic" - }, - { - "target": "com.amazonaws.quicksight#DeleteTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DeleteUser" - }, - { - "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" - }, - { - "target": "com.amazonaws.quicksight#DeleteVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountSettings" - }, - { - "target": "com.amazonaws.quicksight#DescribeAccountSubscription" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysis" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysisDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeAnalysisPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboard" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJob" - }, - { - "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSet" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSource" - }, - { - "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolder" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolderPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeGroup" - }, - { - "target": "com.amazonaws.quicksight#DescribeGroupMembership" - }, - { - "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#DescribeIngestion" - }, - { - "target": "com.amazonaws.quicksight#DescribeIpRestriction" - }, - { - "target": "com.amazonaws.quicksight#DescribeKeyRegistration" - }, - { - "target": "com.amazonaws.quicksight#DescribeNamespace" - }, - { - "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DescribeRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplate" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplateDefinition" - }, - { - "target": "com.amazonaws.quicksight#DescribeTemplatePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTheme" - }, - { - "target": "com.amazonaws.quicksight#DescribeThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#DescribeThemePermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopic" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicPermissions" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicRefresh" - }, - { - "target": "com.amazonaws.quicksight#DescribeTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#DescribeUser" - }, - { - "target": "com.amazonaws.quicksight#DescribeVPCConnection" - }, - { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser" - }, - { - "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser" - }, - { - "target": "com.amazonaws.quicksight#GetDashboardEmbedUrl" - }, - { - "target": "com.amazonaws.quicksight#GetSessionEmbedUrl" - }, - { - "target": "com.amazonaws.quicksight#ListAnalyses" - }, - { - "target": "com.amazonaws.quicksight#ListAssetBundleExportJobs" - }, - { - "target": "com.amazonaws.quicksight#ListAssetBundleImportJobs" - }, - { - "target": "com.amazonaws.quicksight#ListDashboards" - }, - { - "target": "com.amazonaws.quicksight#ListDashboardVersions" - }, - { - "target": "com.amazonaws.quicksight#ListDataSets" - }, - { - "target": "com.amazonaws.quicksight#ListDataSources" - }, - { - "target": "com.amazonaws.quicksight#ListFolderMembers" - }, - { - "target": "com.amazonaws.quicksight#ListFolders" - }, - { - "target": "com.amazonaws.quicksight#ListGroupMemberships" - }, - { - "target": "com.amazonaws.quicksight#ListGroups" - }, - { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignments" - }, - { - "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser" - }, - { - "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigs" - }, - { - "target": "com.amazonaws.quicksight#ListIngestions" - }, - { - "target": "com.amazonaws.quicksight#ListNamespaces" - }, - { - "target": "com.amazonaws.quicksight#ListRefreshSchedules" - }, - { - "target": "com.amazonaws.quicksight#ListRoleMemberships" - }, - { - "target": "com.amazonaws.quicksight#ListTagsForResource" - }, - { - "target": "com.amazonaws.quicksight#ListTemplateAliases" - }, - { - "target": "com.amazonaws.quicksight#ListTemplates" - }, - { - "target": "com.amazonaws.quicksight#ListTemplateVersions" - }, - { - "target": "com.amazonaws.quicksight#ListThemeAliases" - }, - { - "target": "com.amazonaws.quicksight#ListThemes" - }, - { - "target": "com.amazonaws.quicksight#ListThemeVersions" - }, - { - "target": "com.amazonaws.quicksight#ListTopicRefreshSchedules" - }, - { - "target": "com.amazonaws.quicksight#ListTopicReviewedAnswers" - }, - { - "target": "com.amazonaws.quicksight#ListTopics" - }, - { - "target": "com.amazonaws.quicksight#ListUserGroups" - }, - { - "target": "com.amazonaws.quicksight#ListUsers" - }, - { - "target": "com.amazonaws.quicksight#ListVPCConnections" - }, - { - "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" - }, - { - "target": "com.amazonaws.quicksight#RegisterUser" - }, - { - "target": "com.amazonaws.quicksight#RestoreAnalysis" - }, - { - "target": "com.amazonaws.quicksight#SearchAnalyses" - }, - { - "target": "com.amazonaws.quicksight#SearchDashboards" - }, - { - "target": "com.amazonaws.quicksight#SearchDataSets" - }, - { - "target": "com.amazonaws.quicksight#SearchDataSources" - }, - { - "target": "com.amazonaws.quicksight#SearchFolders" - }, - { - "target": "com.amazonaws.quicksight#SearchGroups" - }, - { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" - }, - { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJob" - }, - { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJob" - }, - { - "target": "com.amazonaws.quicksight#TagResource" - }, - { - "target": "com.amazonaws.quicksight#UntagResource" - }, - { - "target": "com.amazonaws.quicksight#UpdateAccountCustomization" - }, - { - "target": "com.amazonaws.quicksight#UpdateAccountSettings" - }, - { - "target": "com.amazonaws.quicksight#UpdateAnalysis" - }, - { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboard" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardLinks" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSet" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSource" - }, - { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateFolder" - }, - { - "target": "com.amazonaws.quicksight#UpdateFolderPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateGroup" - }, - { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignment" - }, - { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfig" - }, - { - "target": "com.amazonaws.quicksight#UpdateIpRestriction" - }, - { - "target": "com.amazonaws.quicksight#UpdateKeyRegistration" - }, - { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" - }, - { - "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" - }, - { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplate" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplateAlias" - }, - { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTheme" - }, - { - "target": "com.amazonaws.quicksight#UpdateThemeAlias" - }, - { - "target": "com.amazonaws.quicksight#UpdateThemePermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopic" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopicPermissions" - }, - { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshSchedule" - }, - { - "target": "com.amazonaws.quicksight#UpdateUser" - }, - { - "target": "com.amazonaws.quicksight#UpdateVPCConnection" - } - ], - "traits": { - "aws.api#service": { - "sdkId": "QuickSight", - "arnNamespace": "quicksight", - "cloudFormationName": "QuickSight", - "cloudTrailEventSource": "quicksight.amazonaws.com", - "endpointPrefix": "quicksight" - }, - "aws.auth#sigv4": { - "name": "quicksight" - }, - "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon QuickSight API Reference\n

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

", - "smithy.api#title": "Amazon QuickSight", - "smithy.rules#endpointRuleSet": { - "version": "1.0", - "parameters": { - "Region": { - "builtIn": "AWS::Region", - "required": false, - "documentation": "The AWS region used to dispatch the request.", - "type": "String" - }, - "UseDualStack": { - "builtIn": "AWS::UseDualStack", - "required": true, - "default": false, - "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", - "type": "Boolean" - }, - "UseFIPS": { - "builtIn": "AWS::UseFIPS", - "required": true, - "default": false, - "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", - "type": "Boolean" - }, - "Endpoint": { - "builtIn": "SDK::Endpoint", - "required": false, - "documentation": "Override the endpoint used to send this request", - "type": "String" - } - }, - "rules": [ - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Endpoint" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "error": "Invalid Configuration: FIPS and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", - "type": "error" - }, - { - "conditions": [], - "endpoint": { - "url": { - "ref": "Endpoint" - }, - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "isSet", - "argv": [ - { - "ref": "Region" - } - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "aws.partition", - "argv": [ - { - "ref": "Region" - } - ], - "assign": "PartitionResult" - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - }, - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - } - ] - }, - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS and DualStack are enabled, but this partition does not support one or both", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseFIPS" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsFIPS" - ] - }, - true - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight-fips.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "FIPS is enabled but this partition does not support FIPS", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - { - "ref": "UseDualStack" - }, - true - ] - } - ], - "rules": [ - { - "conditions": [ - { - "fn": "booleanEquals", - "argv": [ - true, - { - "fn": "getAttr", - "argv": [ - { - "ref": "PartitionResult" - }, - "supportsDualStack" - ] - } - ] - } - ], - "rules": [ - { - "conditions": [], - "endpoint": { - "url": "https://quicksight.{Region}.{PartitionResult#dualStackDnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "DualStack is enabled but this partition does not support DualStack", - "type": "error" - } - ], - "type": "tree" - }, - { - "conditions": [], - "endpoint": { - "url": "https://quicksight.{Region}.{PartitionResult#dnsSuffix}", - "properties": {}, - "headers": {} - }, - "type": "endpoint" - } - ], - "type": "tree" - } - ], - "type": "tree" - }, - { - "conditions": [], - "error": "Invalid Configuration: Missing Region", - "type": "error" - } - ] - }, - "smithy.rules#endpointTests": { - "testCases": [ - { - "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ap-northeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ap-northeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-northeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ap-south-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-south-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ap-southeast-1.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ap-southeast-2.amazonaws.com" - } - }, - "params": { - "Region": "ap-southeast-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region api with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.api.amazonaws.com" - } - }, - "params": { - "Region": "api", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.ca-central-1.amazonaws.com" - } - }, - "params": { - "Region": "ca-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.eu-central-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-central-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.eu-west-1.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.eu-west-2.amazonaws.com" - } - }, - "params": { - "Region": "eu-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.sa-east-1.amazonaws.com" - } - }, - "params": { - "Region": "sa-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-east-2.amazonaws.com" - } - }, - "params": { - "Region": "us-east-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-west-2.amazonaws.com" - } - }, - "params": { - "Region": "us-west-2", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-east-1.api.aws" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight.cn-north-1.api.amazonwebservices.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.cn-north-1.amazonaws.com.cn" - } - }, - "params": { - "Region": "cn-north-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region api with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.api.amazonaws.com" - } - }, - "params": { - "Region": "api", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-gov-west-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-west-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-gov-east-1.api.aws" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-gov-east-1.amazonaws.com" - } - }, - "params": { - "Region": "us-gov-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-iso-east-1.c2s.ic.gov" - } - }, - "params": { - "Region": "us-iso-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", - "expect": { - "error": "FIPS and DualStack are enabled, but this partition does not support one or both" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight-fips.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": true, - "UseDualStack": false - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", - "expect": { - "error": "DualStack is enabled but this partition does not support DualStack" - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": true - } - }, - { - "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", - "expect": { - "endpoint": { - "url": "https://quicksight.us-isob-east-1.sc2s.sgov.gov" - } - }, - "params": { - "Region": "us-isob-east-1", - "UseFIPS": false, - "UseDualStack": false - } - }, - { - "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", - "expect": { - "endpoint": { - "url": "https://example.com" - } - }, - "params": { - "UseFIPS": false, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips enabled and dualstack disabled", - "expect": { - "error": "Invalid Configuration: FIPS and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": true, - "UseDualStack": false, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "For custom endpoint with fips disabled and dualstack enabled", - "expect": { - "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" - }, - "params": { - "Region": "us-east-1", - "UseFIPS": false, - "UseDualStack": true, - "Endpoint": "https://example.com" - } - }, - { - "documentation": "Missing region", - "expect": { - "error": "Invalid Configuration: Missing Region" - } - } - ], - "version": "1.0" - } - } - }, - "com.amazonaws.quicksight#RadarChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Category": { - "target": "com.amazonaws.quicksight#RadarChartCategoryFieldList", - "traits": { - "smithy.api#documentation": "

The aggregated field well categories of a radar chart.

" - } - }, - "Color": { - "target": "com.amazonaws.quicksight#RadarChartColorFieldList", - "traits": { - "smithy.api#documentation": "

The color that are assigned to the aggregated field wells of a radar chart.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#RadarChartValuesFieldList", - "traits": { - "smithy.api#documentation": "

The values that are assigned to the aggregated field wells of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartAreaStyleSettings": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility settings of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configured style settings of a radar chart.

" - } - }, - "com.amazonaws.quicksight#RadarChartAxesRangeScale": { - "type": "enum", - "members": { - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - }, - "INDEPENDENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INDEPENDENT" - } - }, - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - } - } - }, - "com.amazonaws.quicksight#RadarChartCategoryFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RadarChartColorFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RadarChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#RadarChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a RadarChartVisual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#RadarChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" - } - }, - "Shape": { - "target": "com.amazonaws.quicksight#RadarChartShape", - "traits": { - "smithy.api#documentation": "

The shape of the radar chart.

" - } - }, - "BaseSeriesSettings": { - "target": "com.amazonaws.quicksight#RadarChartSeriesSettings", - "traits": { - "smithy.api#documentation": "

The base sreies settings of a radar chart.

" - } - }, - "StartAngle": { - "target": "com.amazonaws.quicksight#RadarChartStartAngle", - "traits": { - "smithy.api#documentation": "

The start angle of a radar chart's axis.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "AlternateBandColorsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the colors of alternatign bands in a radar chart.

" - } - }, - "AlternateBandEvenColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the even-numbered alternate bands of a radar chart.

" - } - }, - "AlternateBandOddColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the odd-numbered alternate bands of a radar chart.

" - } - }, - "CategoryAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The category axis of a radar chart.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The category label options of a radar chart.

" - } - }, - "ColorAxis": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The color axis of a radar chart.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The color label options of a radar chart.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "AxesRangeScale": { - "target": "com.amazonaws.quicksight#RadarChartAxesRangeScale", - "traits": { - "smithy.api#documentation": "

The axis behavior options of a radar chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartFieldWells": { - "type": "structure", - "members": { - "RadarChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#RadarChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a radar chart visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a radar chart visual.

" - } - }, - "com.amazonaws.quicksight#RadarChartSeriesSettings": { - "type": "structure", - "members": { - "AreaStyleSettings": { - "target": "com.amazonaws.quicksight#RadarChartAreaStyleSettings", - "traits": { - "smithy.api#documentation": "

The area style settings of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series settings of a radar chart.

" - } - }, - "com.amazonaws.quicksight#RadarChartShape": { - "type": "enum", - "members": { - "CIRCLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CIRCLE" - } - }, - "POLYGON": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "POLYGON" - } - } - } - }, - "com.amazonaws.quicksight#RadarChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The category sort options of a radar chart.

" - } - }, - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The category items limit for a radar chart.

" - } - }, - "ColorSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The color sort configuration of a radar chart.

" - } - }, - "ColorItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The color items limit of a radar chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" - } - }, - "com.amazonaws.quicksight#RadarChartStartAngle": { - "type": "double", - "traits": { - "smithy.api#range": { - "min": -360, - "max": 360 - } - } - }, - "com.amazonaws.quicksight#RadarChartValuesFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#RadarChartVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#RadarChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A radar chart visual.

" - } - }, - "com.amazonaws.quicksight#RangeConstant": { - "type": "structure", - "members": { - "Minimum": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The minimum value for a range constant.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The maximum value for a range constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a range constant.

" - } - }, - "com.amazonaws.quicksight#RangeEndsLabelType": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the range ends label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range ends label type of a data path label.

" - } - }, - "com.amazonaws.quicksight#RdsParameters": { - "type": "structure", - "members": { - "InstanceId": { - "target": "com.amazonaws.quicksight#InstanceId", - "traits": { - "smithy.api#documentation": "

Instance ID.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Amazon RDS.

" - } - }, - "com.amazonaws.quicksight#RecoveryWindowInDays": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 7, - "max": 30 - } - } - }, - "com.amazonaws.quicksight#RedshiftIAMParameters": { - "type": "structure", - "members": { - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", - "smithy.api#required": {} - } - }, - "DatabaseUser": { - "target": "com.amazonaws.quicksight#DatabaseUser", - "traits": { - "smithy.api#documentation": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" - } - }, - "DatabaseGroups": { - "target": "com.amazonaws.quicksight#DatabaseGroupList", - "traits": { - "smithy.api#documentation": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" - } - }, - "AutoCreateDatabaseUser": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" - } - }, - "com.amazonaws.quicksight#RedshiftParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host. This field can be blank if ClusterId is provided.

" - } - }, - "Port": { - "target": "com.amazonaws.quicksight#OptionalPort", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

Port. This field can be blank if the ClusterId is provided.

" - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - }, - "ClusterId": { - "target": "com.amazonaws.quicksight#ClusterId", - "traits": { - "smithy.api#documentation": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

" - } - }, - "IAMParameters": { - "target": "com.amazonaws.quicksight#RedshiftIAMParameters", - "traits": { - "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" - } - }, - "IdentityCenterConfiguration": { - "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", - "traits": { - "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

" - } - }, - "com.amazonaws.quicksight#ReferenceLine": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the reference line. Choose one of the following options:

\n " - } - }, - "DataConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineDataConfiguration", - "traits": { - "smithy.api#documentation": "

The data configuration of the reference line.

", - "smithy.api#required": {} - } - }, - "StyleConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineStyleConfiguration", - "traits": { - "smithy.api#documentation": "

The style configuration of the reference line.

" - } - }, - "LabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The label configuration of the reference line.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The reference line visual display options.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration": { - "type": "structure", - "members": { - "CustomLabel": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The string text of the custom label.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a custom label on a ReferenceLine.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineDataConfiguration": { - "type": "structure", - "members": { - "StaticConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration", - "traits": { - "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" - } - }, - "DynamicConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration", - "traits": { - "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" - } - }, - "AxisBinding": { - "target": "com.amazonaws.quicksight#AxisBinding", - "traits": { - "smithy.api#documentation": "

The axis binding type of the reference line. Choose one of the following options:

\n " - } - }, - "SeriesType": { - "target": "com.amazonaws.quicksight#ReferenceLineSeriesType", - "traits": { - "smithy.api#documentation": "

The series type of the reference line data configuration. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The data configuration of the reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the dynamic data targets.

", - "smithy.api#required": {} - } - }, - "MeasureAggregationFunction": { - "target": "com.amazonaws.quicksight#AggregationFunction", - "traits": { - "smithy.api#documentation": "

The aggregation function that is used in the dynamic data.

" - } - }, - "Calculation": { - "target": "com.amazonaws.quicksight#NumericalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The calculation that is used in the dynamic data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelConfiguration": { - "type": "structure", - "members": { - "ValueLabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" - } - }, - "CustomLabelConfiguration": { - "target": "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration", - "traits": { - "smithy.api#documentation": "

The custom label configuration of the label in a reference line.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the label in a reference line.

" - } - }, - "FontColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The font color configuration of the label in a reference line.

" - } - }, - "HorizontalPosition": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition", - "traits": { - "smithy.api#documentation": "

The horizontal position configuration of the label in a reference line. Choose one of\n the following options:

\n " - } - }, - "VerticalPosition": { - "target": "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition", - "traits": { - "smithy.api#documentation": "

The vertical position configuration of the label in a reference line. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The label configuration of a reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition": { - "type": "enum", - "members": { - "LEFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEFT" - } - }, - "CENTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CENTER" - } - }, - "RIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RIGHT" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition": { - "type": "enum", - "members": { - "ABOVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABOVE" - } - }, - "BELOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BELOW" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ReferenceLine" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#ReferenceLinePatternType": { - "type": "enum", - "members": { - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - }, - "DASHED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DASHED" - } - }, - "DOTTED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOTTED" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineSeriesType": { - "type": "enum", - "members": { - "BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BAR" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - } - } - }, - "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#SensitiveDouble", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The double input of the static data.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineStyleConfiguration": { - "type": "structure", - "members": { - "Pattern": { - "target": "com.amazonaws.quicksight#ReferenceLinePatternType", - "traits": { - "smithy.api#documentation": "

The pattern type of the line style. Choose one of the following options:

\n " - } - }, - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The hex color of the reference line.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The style configuration of the reference\n line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration": { - "type": "structure", - "members": { - "RelativePosition": { - "target": "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition", - "traits": { - "smithy.api#documentation": "

The relative position of the value label. Choose one of the following options:

\n " - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the value label.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" - } - }, - "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition": { - "type": "enum", - "members": { - "BEFORE_CUSTOM_LABEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BEFORE_CUSTOM_LABEL" - } - }, - "AFTER_CUSTOM_LABEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AFTER_CUSTOM_LABEL" - } - } - } - }, - "com.amazonaws.quicksight#RefreshConfiguration": { - "type": "structure", - "members": { - "IncrementalRefresh": { - "target": "com.amazonaws.quicksight#IncrementalRefresh", - "traits": { - "smithy.api#documentation": "

The incremental refresh for the dataset.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh configuration of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshFrequency": { - "type": "structure", - "members": { - "Interval": { - "target": "com.amazonaws.quicksight#RefreshInterval", - "traits": { - "smithy.api#documentation": "

The interval between scheduled refreshes. Valid values are as follows:

\n ", - "smithy.api#required": {} - } - }, - "RefreshOnDay": { - "target": "com.amazonaws.quicksight#ScheduleRefreshOnEntity", - "traits": { - "smithy.api#documentation": "

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

" - } - }, - "Timezone": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

" - } - }, - "TimeOfTheDay": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Specifies the interval between each scheduled refresh of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshInterval": { - "type": "enum", - "members": { - "MINUTE15": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE15" - } - }, - "MINUTE30": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE30" - } - }, - "HOURLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURLY" - } - }, - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAILY" - } - }, - "WEEKLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEKLY" - } - }, - "MONTHLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHLY" - } - } - } - }, - "com.amazonaws.quicksight#RefreshSchedule": { - "type": "structure", - "members": { - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

An identifier for the refresh schedule.

", - "smithy.api#required": {} - } - }, - "ScheduleFrequency": { - "target": "com.amazonaws.quicksight#RefreshFrequency", - "traits": { - "smithy.api#documentation": "

The frequency for the refresh schedule.

", - "smithy.api#required": {} - } - }, - "StartAfterDateTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

" - } - }, - "RefreshType": { - "target": "com.amazonaws.quicksight#IngestionType", - "traits": { - "smithy.api#documentation": "

The type of refresh that a datset undergoes. Valid values are as follows:

\n \n

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

", - "smithy.api#required": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh schedule of a dataset.

" - } - }, - "com.amazonaws.quicksight#RefreshSchedules": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

A list of RefreshSchedule objects.

" - } - } - }, - "com.amazonaws.quicksight#RegisterUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#RegisterUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#RegisterUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#RegisterUserRequest": { - "type": "structure", - "members": { - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", - "traits": { - "smithy.api#documentation": "

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the user that you want to register.

", - "smithy.api#required": {} - } - }, - "UserRole": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n ", - "smithy.api#required": {} - } - }, - "IamArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

" - } - }, - "SessionName": { - "target": "com.amazonaws.quicksight#RoleSessionName", - "traits": { - "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the CLI Reference.\n

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

" - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

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.

\n " - } - }, - "CustomFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

The tags to associate with the user.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#RegisterUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The user's user name.

" - } - }, - "UserInvitationUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL the user visits to complete registration and provide a password. This is\n\t\t\treturned only for users with an identity type of QUICKSIGHT.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#RegisteredCustomerManagedKey": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

" - } - }, - "DefaultKey": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n " - } - }, - "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations": { - "type": "structure", - "members": { - "StatePersistence": { - "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", - "traits": { - "smithy.api#documentation": "

The state persistence configurations of an embedded Amazon QuickSight console.

" - } - }, - "SharedView": { - "target": "com.amazonaws.quicksight#SharedViewConfigurations", - "traits": { - "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The feature configurations of an embedded Amazon QuickSight console.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", - "smithy.api#required": {} - } - }, - "FeatureConfigurations": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations", - "traits": { - "smithy.api#documentation": "

The feature configurations of an embbedded Amazon QuickSight dashboard.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the dashboard you want to embed.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations": { - "type": "structure", - "members": { - "StatePersistence": { - "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", - "traits": { - "smithy.api#documentation": "

The state persistence settings of an embedded dashboard.

" - } - }, - "SharedView": { - "target": "com.amazonaws.quicksight#SharedViewConfigurations", - "traits": { - "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" - } - }, - "Bookmarks": { - "target": "com.amazonaws.quicksight#BookmarksConfigurations", - "traits": { - "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialDashboardVisualId": { - "target": "com.amazonaws.quicksight#DashboardVisualId", - "traits": { - "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration": { - "type": "structure", - "members": { - "Dashboard": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for providing a dashboard embedding experience.

" - } - }, - "QuickSightConsole": { - "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" - } - }, - "QSearchBar": { - "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" - } - }, - "DashboardVisual": { - "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" - } - }, - "GenerativeQnA": { - "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n " - } - }, - "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that provides information about the configuration of a Generative Q&A experience.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialTopicId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Q search bar embedding experience.

" - } - }, - "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration": { - "type": "structure", - "members": { - "InitialPath": { - "target": "com.amazonaws.quicksight#EntryPath", - "traits": { - "smithy.api#documentation": "

The initial URL path for the Amazon QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n " - } - }, - "FeatureConfigurations": { - "target": "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations", - "traits": { - "smithy.api#documentation": "

The embedding configuration of an embedded Amazon QuickSight console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the Amazon QuickSight console that you want to embed.

" - } - }, - "com.amazonaws.quicksight#RelationalTable": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#RelationalTableCatalog", - "traits": { - "smithy.api#documentation": "

The catalog associated with a table.

" - } - }, - "Schema": { - "target": "com.amazonaws.quicksight#RelationalTableSchema", - "traits": { - "smithy.api#documentation": "

The schema name. This name applies to certain relational database engines.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#RelationalTableName", - "traits": { - "smithy.api#documentation": "

The name of the relational table.

", - "smithy.api#required": {} - } - }, - "InputColumns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

The column schema of the table.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type for relational data sources.

" - } - }, - "com.amazonaws.quicksight#RelationalTableCatalog": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelationalTableName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelationalTableSchema": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "DateTimeFormat": { - "target": "com.amazonaws.quicksight#DateTimeFormat", - "traits": { - "smithy.api#documentation": "

Customize how dates are formatted in controls.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#RelativeDateType": { - "type": "enum", - "members": { - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - } - } - }, - "com.amazonaws.quicksight#RelativeDatesFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "AnchorDateConfiguration": { - "target": "com.amazonaws.quicksight#AnchorDateConfiguration", - "traits": { - "smithy.api#documentation": "

The date configuration of the filter.

", - "smithy.api#required": {} - } - }, - "MinimumGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The minimum granularity (period granularity) of the relative dates filter.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", - "smithy.api#required": {} - } - }, - "RelativeDateType": { - "target": "com.amazonaws.quicksight#RelativeDateType", - "traits": { - "smithy.api#documentation": "

The range date type of the filter. Choose one of the options below:

\n ", - "smithy.api#required": {} - } - }, - "RelativeDateValue": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The date value of the filter.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "ExcludePeriodConfiguration": { - "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for the exclude period of the filter.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A RelativeDatesFilter filters relative dates values.

" - } - }, - "com.amazonaws.quicksight#RelativeFontSize": { - "type": "enum", - "members": { - "EXTRA_SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTRA_SMALL" - } - }, - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - }, - "EXTRA_LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXTRA_LARGE" - } - } - } - }, - "com.amazonaws.quicksight#RenameColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The name of the column to be renamed.

", - "smithy.api#required": {} - } - }, - "NewColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The new name for the column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that renames a column.

" - } - }, - "com.amazonaws.quicksight#ResizeOption": { - "type": "enum", - "members": { - "FIXED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIXED" - } - }, - "RESPONSIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESPONSIVE" - } - } - } - }, - "com.amazonaws.quicksight#ResourceExistsException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The resource specified already exists.

", - "smithy.api#error": "client", - "smithy.api#httpError": 409 - } - }, - "com.amazonaws.quicksight#ResourceId": { - "type": "string" - }, - "com.amazonaws.quicksight#ResourceName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#ResourceNotFoundException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

One or more resources can't be found.

", - "smithy.api#error": "client", - "smithy.api#httpError": 404 - } - }, - "com.amazonaws.quicksight#ResourcePermission": { - "type": "structure", - "members": { - "Principal": { - "target": "com.amazonaws.quicksight#Principal", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n ", - "smithy.api#required": {} - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#ActionList", - "traits": { - "smithy.api#documentation": "

The IAM action to grant or revoke permissions on.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

Permission for the resource.

" - } - }, - "com.amazonaws.quicksight#ResourcePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - } - } - }, - "com.amazonaws.quicksight#ResourceStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "CREATION_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_SUCCESSFUL" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_SUCCESSFUL" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } - }, - "com.amazonaws.quicksight#ResourceUnavailableException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "ResourceType": { - "target": "com.amazonaws.quicksight#ExceptionResourceType", - "traits": { - "smithy.api#documentation": "

The resource type for this request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This resource is currently unavailable.

", - "smithy.api#error": "server", - "smithy.api#httpError": 503 - } - }, - "com.amazonaws.quicksight#RestoreAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#RestoreAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#RestoreAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Restores an analysis.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#RestoreAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're restoring.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#RestoreAnalysisResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you're restoring.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you're restoring.\n

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#RestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.quicksight#ReviewedAnswerErrorCode": { - "type": "enum", - "members": { - "INTERNAL_ERROR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_ERROR" - } - }, - "MISSING_ANSWER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSING_ANSWER" - } - }, - "DATASET_DOES_NOT_EXIST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATASET_DOES_NOT_EXIST" - } - }, - "INVALID_DATASET_ARN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATASET_ARN" - } - }, - "DUPLICATED_ANSWER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DUPLICATED_ANSWER" - } - }, - "INVALID_DATA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INVALID_DATA" - } - }, - "MISSING_REQUIRED_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MISSING_REQUIRED_FIELDS" - } - } - } - }, - "com.amazonaws.quicksight#Role": { - "type": "enum", - "members": { - "ADMIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN" - } - }, - "AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR" - } - }, - "READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER" - } - }, - "ADMIN_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN_PRO" - } - }, - "AUTHOR_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR_PRO" - } - }, - "READER_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER_PRO" - } - } - } - }, - "com.amazonaws.quicksight#RoleArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 20, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#RoleName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 64 - }, - "smithy.api#pattern": "^[a-zA-Z0-9+=,.@_-]+$" - } - }, - "com.amazonaws.quicksight#RoleSessionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 2, - "max": 64 - }, - "smithy.api#pattern": "^[\\w+=.@-]*$" - } - }, - "com.amazonaws.quicksight#RollingDateConfiguration": { - "type": "structure", - "members": { - "DataSetIdentifier": { - "target": "com.amazonaws.quicksight#DataSetIdentifier", - "traits": { - "smithy.api#documentation": "

The data set that is used in the rolling date configuration.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression of the rolling date configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The rolling date configuration of a date time filter.

" - } - }, - "com.amazonaws.quicksight#RowAlternateColorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#HexColor" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#RowAlternateColorOptions": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

Determines the widget status.

" - } - }, - "RowAlternateColors": { - "target": "com.amazonaws.quicksight#RowAlternateColorList", - "traits": { - "smithy.api#documentation": "

Determines the list of row alternate colors.

" - } - }, - "UsePrimaryBackgroundColor": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The primary background color options for alternate rows.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the row alternate color options.

" - } - }, - "com.amazonaws.quicksight#RowInfo": { - "type": "structure", - "members": { - "RowsIngested": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of rows that were ingested.

" - } - }, - "RowsDropped": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of rows that were not ingested.

" - } - }, - "TotalRowsInDataset": { - "target": "com.amazonaws.quicksight#Long", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The total number of rows in the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about rows for a data set SPICE ingestion.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionDataSet": { - "type": "structure", - "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the dataset that contains permissions for RLS.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", - "smithy.api#required": {} - } - }, - "PermissionPolicy": { - "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", - "traits": { - "smithy.api#documentation": "

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS\n is included for backward compatibility only.

", - "smithy.api#required": {} - } - }, - "FormatVersion": { - "target": "com.amazonaws.quicksight#RowLevelPermissionFormatVersion", - "traits": { - "smithy.api#documentation": "

The user or group rules associated with the dataset that contains permissions for RLS.

\n

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#Status", - "traits": { - "smithy.api#documentation": "

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionFormatVersion": { - "type": "enum", - "members": { - "VERSION_1": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION_1" - } - }, - "VERSION_2": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERSION_2" - } - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionPolicy": { - "type": "enum", - "members": { - "GRANT_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GRANT_ACCESS" - } - }, - "DENY_ACCESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DENY_ACCESS" - } - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#Status", - "traits": { - "smithy.api#documentation": "

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" - } - }, - "TagRules": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleList", - "traits": { - "smithy.api#documentation": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", - "smithy.api#required": {} - } - }, - "TagRuleConfigurations": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRule": { - "type": "structure", - "members": { - "TagKey": { - "target": "com.amazonaws.quicksight#SessionTagKey", - "traits": { - "smithy.api#documentation": "

The unique key for a tag.

", - "smithy.api#required": {} - } - }, - "ColumnName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The column name that a tag key is assigned to.

", - "smithy.api#required": {} - } - }, - "TagMultiValueDelimiter": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "MatchAllValue": { - "target": "com.amazonaws.quicksight#SessionTagValue", - "traits": { - "smithy.api#documentation": "

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A set of rules associated with a tag.

" - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagRule" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#RowSortList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldSortOptions" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#S3Bucket": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#S3BucketConfiguration": { - "type": "structure", - "members": { - "BucketName": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

", - "smithy.api#required": {} - } - }, - "BucketPrefix": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

", - "smithy.api#required": {} - } - }, - "BucketRegion": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

" - } - }, - "com.amazonaws.quicksight#S3Key": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#S3Parameters": { - "type": "structure", - "members": { - "ManifestFileLocation": { - "target": "com.amazonaws.quicksight#ManifestFileLocation", - "traits": { - "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.

", - "smithy.api#required": {} - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for S3.

" - } - }, - "com.amazonaws.quicksight#S3Source": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", - "smithy.api#required": {} - } - }, - "UploadSettings": { - "target": "com.amazonaws.quicksight#UploadSettings", - "traits": { - "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" - } - }, - "InputColumns": { - "target": "com.amazonaws.quicksight#InputColumnList", - "traits": { - "smithy.api#documentation": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A physical table type for an S3 data source.

" - } - }, - "com.amazonaws.quicksight#S3Uri": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" - } - }, - "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration": { - "type": "structure", - "members": { - "TargetVisuals": { - "target": "com.amazonaws.quicksight#TargetVisualList", - "traits": { - "smithy.api#documentation": "

A list of the target visual IDs that are located in the same sheet of the analysis.

" - } - }, - "TargetVisualOptions": { - "target": "com.amazonaws.quicksight#TargetVisualOptions", - "traits": { - "smithy.api#documentation": "

The options that choose the target visual in the same sheet.

\n

Valid values are defined as follows:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The source field wells of a sankey diagram.

" - } - }, - "Destination": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The destination field wells of a sankey diagram.

" - } - }, - "Weight": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The weight field wells of a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#SankeyDiagramFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a sankey diagram.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramFieldWells": { - "type": "structure", - "members": { - "SankeyDiagramAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramSortConfiguration": { - "type": "structure", - "members": { - "WeightSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the weight fields.

" - } - }, - "SourceItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of source nodes that are displayed in a sankey diagram.

" - } - }, - "DestinationItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of destination nodes that are displayed in a sankey diagram.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" - } - }, - "com.amazonaws.quicksight#SankeyDiagramVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of a sankey diagram.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is aggregated by category.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is aggregated by category.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field well of a scatter plot.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a scatter plot.

" - } - }, - "Label": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The label field well of a scatter plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a scatter plot.

" - } - }, - "XAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

" - } - }, - "XAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

" - } - }, - "YAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

" - } - }, - "YAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotFieldWells": { - "type": "structure", - "members": { - "ScatterPlotCategoricallyAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

" - } - }, - "ScatterPlotUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\n unaggregated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a scatter plot.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotSortConfiguration": { - "type": "structure", - "members": { - "ScatterPlotLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration" - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { - "type": "structure", - "members": { - "XAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is a dimension field and cannot be aggregated.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is a dimension field and cannot be aggregated.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a scatter plot.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field well of a scatter plot.

" - } - }, - "Label": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The label field well of a scatter plot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field wells of a scatter plot.

" - } - }, - "com.amazonaws.quicksight#ScatterPlotVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { - "type": "structure", - "members": { - "DayOfWeek": { - "target": "com.amazonaws.quicksight#DayOfWeek", - "traits": { - "smithy.api#documentation": "

The day of the week that you want to schedule a refresh on.

" - } - }, - "DayOfMonth": { - "target": "com.amazonaws.quicksight#DayOfMonth", - "traits": { - "smithy.api#documentation": "

The day of the month that you want to schedule refresh on.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The refresh on entity for weekly or monthly schedules.

" - } - }, - "com.amazonaws.quicksight#ScrollBarOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the data zoom scroll bar.

" - } - }, - "VisibleRange": { - "target": "com.amazonaws.quicksight#VisibleRangeOptions", - "traits": { - "smithy.api#documentation": "

The visibility range for the data zoom scroll bar.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual display options for a data zoom scroll bar.

" - } - }, - "com.amazonaws.quicksight#SearchAnalyses": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchAnalysesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchAnalysesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/analyses", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "AnalysisSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchAnalysesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses that you're searching\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", - "traits": { - "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchAnalysesResponse": { - "type": "structure", - "members": { - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", - "traits": { - "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDashboards": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDashboardsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDashboardsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches for dashboards that belong to a user.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/dashboards", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DashboardSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDashboardsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DashboardSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDashboardsResponse": { - "type": "structure", - "members": { - "DashboardSummaryList": { - "target": "com.amazonaws.quicksight#DashboardSummaryList", - "traits": { - "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDataSets": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDataSetsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDataSetsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchDataSets operation to search for datasets that belong to an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/data-sets", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSetSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDataSetsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DataSetSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDataSetsResponse": { - "type": "structure", - "members": { - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", - "traits": { - "smithy.api#documentation": "

A DataSetSummaries object that returns a summary of a dataset.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchDataSources": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchDataSourcesRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchDataSourcesResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchDataSources operation to search for data sources that belong to an account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/data-sources", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "DataSourceSummaries", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchDataSourcesRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#DataSourceSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search.

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchDataSourcesResponse": { - "type": "structure", - "members": { - "DataSourceSummaries": { - "target": "com.amazonaws.quicksight#DataSourceSummaryList", - "traits": { - "smithy.api#documentation": "

A DataSourceSummaries object that returns a summary of a data source.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchFolders": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchFoldersRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchFoldersResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#InvalidRequestException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Searches the subfolders in a folder.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/search/folders", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "FolderSummaryList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchFoldersRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#FolderSearchFilterList", - "traits": { - "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].

", - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to be returned per request.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchFoldersResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "FolderSummaryList": { - "target": "com.amazonaws.quicksight#FolderSummaryList", - "traits": { - "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#SearchGroups": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#SearchGroupsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#SearchGroupsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidNextTokenException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", - "code": 200 - }, - "smithy.api#paginated": { - "inputToken": "NextToken", - "outputToken": "NextToken", - "items": "GroupList", - "pageSize": "MaxResults" - } - } - }, - "com.amazonaws.quicksight#SearchGroupsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#documentation": "

The maximum number of results to return from this request.

", - "smithy.api#httpQuery": "max-results" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to search.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#GroupSearchFilterList", - "traits": { - "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#SearchGroupsResponse": { - "type": "structure", - "members": { - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", - "traits": { - "smithy.api#documentation": "

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#Seasonality": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 180 - } - } - }, - "com.amazonaws.quicksight#SecondaryValueOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the secondary value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" - } - }, - "com.amazonaws.quicksight#SecretArn": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - }, - "smithy.api#pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$" - } - }, - "com.amazonaws.quicksight#SectionAfterPageBreak": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#SectionPageBreakStatus", - "traits": { - "smithy.api#documentation": "

The option that enables or disables a page break at the end of a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a page break after a section.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions": { - "type": "structure", - "members": { - "PaperCanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for the canvas of a section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutConfiguration": { - "type": "structure", - "members": { - "HeaderSections": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of header section configurations.

", - "smithy.api#required": {} - } - }, - "BodySections": { - "target": "com.amazonaws.quicksight#BodySectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of body section configurations.

", - "smithy.api#required": {} - } - }, - "FooterSections": { - "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", - "traits": { - "smithy.api#documentation": "

A list of footer section configurations.

", - "smithy.api#required": {} - } - }, - "CanvasSizeOptions": { - "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", - "traits": { - "smithy.api#documentation": "

The options for the canvas of a section-based layout.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a\n section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions": { - "type": "structure", - "members": { - "PaperSize": { - "target": "com.amazonaws.quicksight#PaperSize", - "traits": { - "smithy.api#documentation": "

The paper size that is used to define canvas dimensions.

" - } - }, - "PaperOrientation": { - "target": "com.amazonaws.quicksight#PaperOrientation", - "traits": { - "smithy.api#documentation": "

The paper orientation that\n is used to define canvas dimensions. Choose one of the following\n options:

\n " - } - }, - "PaperMargin": { - "target": "com.amazonaws.quicksight#Spacing", - "traits": { - "smithy.api#documentation": "

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" - } - }, - "com.amazonaws.quicksight#SectionLayoutConfiguration": { - "type": "structure", - "members": { - "FreeFormLayout": { - "target": "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The free-form layout configuration of a section.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The layout configuration of a section.

" - } - }, - "com.amazonaws.quicksight#SectionPageBreakConfiguration": { - "type": "structure", - "members": { - "After": { - "target": "com.amazonaws.quicksight#SectionAfterPageBreak", - "traits": { - "smithy.api#documentation": "

The configuration of a page break after a section.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a page break for a section.

" - } - }, - "com.amazonaws.quicksight#SectionPageBreakStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#SectionStyle": { - "type": "structure", - "members": { - "Height": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The height of a section.

\n

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

" - } - }, - "Padding": { - "target": "com.amazonaws.quicksight#Spacing", - "traits": { - "smithy.api#documentation": "

The spacing between section content and its top, bottom, left, and right edges.

\n

There is no padding by default.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that style a section.

" - } - }, - "com.amazonaws.quicksight#SecurityGroupId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^sg-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#SecurityGroupIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SecurityGroupId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 16 - } - } - }, - "com.amazonaws.quicksight#SelectAllValueOptions": { - "type": "enum", - "members": { - "ALL_VALUES": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VALUES" - } - } - } - }, - "com.amazonaws.quicksight#SelectedFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SelectedFieldOptions": { - "type": "enum", - "members": { - "ALL_FIELDS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_FIELDS" - } - } - } - }, - "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration": { - "type": "structure", - "members": { - "SheetVisualScopingConfigurations": { - "target": "com.amazonaws.quicksight#SheetVisualScopingConfigurations", - "traits": { - "smithy.api#documentation": "

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

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.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SelectedTooltipType": { - "type": "enum", - "members": { - "BASIC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BASIC" - } - }, - "DETAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DETAILED" - } - } - } - }, - "com.amazonaws.quicksight#SemanticEntityType": { - "type": "structure", - "members": { - "TypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic entity type name.

" - } - }, - "SubTypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic entity sub type name.

" - } - }, - "TypeParameters": { - "target": "com.amazonaws.quicksight#TypeParameters", - "traits": { - "smithy.api#documentation": "

The semantic entity type parameters.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a semantic entity type.

" - } - }, - "com.amazonaws.quicksight#SemanticType": { - "type": "structure", - "members": { - "TypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic type name.

" - } - }, - "SubTypeName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The semantic type sub type name.

" - } - }, - "TypeParameters": { - "target": "com.amazonaws.quicksight#TypeParameters", - "traits": { - "smithy.api#documentation": "

The semantic type parameters.

" - } - }, - "TruthyCellValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The semantic type truthy cell value.

" - } - }, - "TruthyCellValueSynonyms": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the true cell value.

" - } - }, - "FalseyCellValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

The semantic type falsey cell value.

" - } - }, - "FalseyCellValueSynonyms": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the false cell value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a semantic type.

" - } - }, - "com.amazonaws.quicksight#SensitiveDouble": { - "type": "double", - "traits": { - "smithy.api#default": 0, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveDoubleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveDouble" - } - }, - "com.amazonaws.quicksight#SensitiveDoubleObject": { - "type": "double", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveLong": { - "type": "long", - "traits": { - "smithy.api#default": 0, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveLongList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveLong" - } - }, - "com.amazonaws.quicksight#SensitiveLongObject": { - "type": "long", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveS3Uri": { - "type": "string", - "traits": { - "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveString": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveStringList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveString" - } - }, - "com.amazonaws.quicksight#SensitiveStringObject": { - "type": "string", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveTimestamp": { - "type": "timestamp", - "traits": { - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SensitiveTimestampList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveTimestamp" - } - }, - "com.amazonaws.quicksight#SeriesItem": { - "type": "structure", - "members": { - "FieldSeriesItem": { - "target": "com.amazonaws.quicksight#FieldSeriesItem", - "traits": { - "smithy.api#documentation": "

The field series item configuration of a line chart.

" - } - }, - "DataFieldSeriesItem": { - "target": "com.amazonaws.quicksight#DataFieldSeriesItem", - "traits": { - "smithy.api#documentation": "

The data field series item configuration of a line chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The series item configuration of a line chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#SeriesItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SeriesItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#ServiceNowParameters": { - "type": "structure", - "members": { - "SiteBaseUrl": { - "target": "com.amazonaws.quicksight#SiteBaseUrl", - "traits": { - "smithy.api#documentation": "

URL of the base site.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for ServiceNow.

" - } - }, - "com.amazonaws.quicksight#ServiceType": { - "type": "enum", - "members": { - "REDSHIFT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "REDSHIFT" - } - } - } - }, - "com.amazonaws.quicksight#SessionLifetimeInMinutes": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 15, - "max": 600 - } - } - }, - "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The number of minutes specified for the lifetime of a session isn't valid. The session\n\t\t\tlifetime must be 15-600 minutes.

", - "smithy.api#error": "client", - "smithy.api#httpError": 400 - } - }, - "com.amazonaws.quicksight#SessionTag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.quicksight#SessionTagKey", - "traits": { - "smithy.api#documentation": "

The key for the tag.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#SessionTagValue", - "traits": { - "smithy.api#documentation": "

The value that you want to assign the tag.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The key-value pair used for the row-level security tags feature.

" - } - }, - "com.amazonaws.quicksight#SessionTagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#SessionTagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#SessionTagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SessionTag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#SessionTagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#SetParameterValueConfiguration": { - "type": "structure", - "members": { - "DestinationParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The destination parameter name of the SetParameterValueConfiguration.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#DestinationParameterValueConfiguration", - "traits": { - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of adding parameters in action.

" - } - }, - "com.amazonaws.quicksight#SetParameterValueConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SetParameterValueConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#ShapeConditionalFormat": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the shape background color of a filled map visual.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The shape conditional formatting of a filled map visual.

" - } - }, - "com.amazonaws.quicksight#SharedViewConfigurations": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#SharingModel": { - "type": "enum", - "members": { - "ACCOUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCOUNT" - } - }, - "NAMESPACE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NAMESPACE" - } - } - } - }, - "com.amazonaws.quicksight#Sheet": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier associated with a sheet.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#SheetName", - "traits": { - "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

" - } - }, - "com.amazonaws.quicksight#SheetContentType": { - "type": "enum", - "members": { - "PAGINATED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PAGINATED" - } - }, - "INTERACTIVE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERACTIVE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlDateTimePickerType": { - "type": "enum", - "members": { - "SINGLE_VALUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_VALUED" - } - }, - "DATE_RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of info icon label options.

" - } - }, - "InfoIconText": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconText", - "traits": { - "smithy.api#documentation": "

The text content of info icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A control to display info icons for filters and parameters.

" - } - }, - "com.amazonaws.quicksight#SheetControlInfoIconText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#SheetControlLayout": { - "type": "structure", - "members": { - "Configuration": { - "target": "com.amazonaws.quicksight#SheetControlLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A grid layout to define the placement of sheet control.

" - } - }, - "com.amazonaws.quicksight#SheetControlLayoutConfiguration": { - "type": "structure", - "members": { - "GridLayout": { - "target": "com.amazonaws.quicksight#GridLayoutConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" - } - }, - "com.amazonaws.quicksight#SheetControlLayoutList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetControlLayout" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SheetControlListType": { - "type": "enum", - "members": { - "MULTI_SELECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_SELECT" - } - }, - "SINGLE_SELECT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_SELECT" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlSliderType": { - "type": "enum", - "members": { - "SINGLE_POINT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_POINT" - } - }, - "RANGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANGE" - } - } - } - }, - "com.amazonaws.quicksight#SheetControlTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#SheetControlsOption": { - "type": "structure", - "members": { - "VisibilityState": { - "target": "com.amazonaws.quicksight#DashboardUIState", - "traits": { - "smithy.api#documentation": "

Visibility state.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Sheet controls option.

" - } - }, - "com.amazonaws.quicksight#SheetDefinition": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The unique identifier of a sheet.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#SheetTitle", - "traits": { - "smithy.api#documentation": "

The title of the sheet.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#SheetDescription", - "traits": { - "smithy.api#documentation": "

A description of the sheet.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#SheetName", - "traits": { - "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" - } - }, - "ParameterControls": { - "target": "com.amazonaws.quicksight#ParameterControlList", - "traits": { - "smithy.api#documentation": "

The list of parameter controls that are on a sheet.

\n

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

" - } - }, - "FilterControls": { - "target": "com.amazonaws.quicksight#FilterControlList", - "traits": { - "smithy.api#documentation": "

The list of filter controls that are on a sheet.

\n

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

" - } - }, - "Visuals": { - "target": "com.amazonaws.quicksight#VisualList", - "traits": { - "smithy.api#documentation": "

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

" - } - }, - "TextBoxes": { - "target": "com.amazonaws.quicksight#SheetTextBoxList", - "traits": { - "smithy.api#documentation": "

The text boxes that are on a sheet.

" - } - }, - "Layouts": { - "target": "com.amazonaws.quicksight#LayoutList", - "traits": { - "smithy.api#documentation": "

Layouts define how the components of a sheet are arranged.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

" - } - }, - "SheetControlLayouts": { - "target": "com.amazonaws.quicksight#SheetControlLayoutList", - "traits": { - "smithy.api#documentation": "

The control layouts of the sheet.

" - } - }, - "ContentType": { - "target": "com.amazonaws.quicksight#SheetContentType", - "traits": { - "smithy.api#documentation": "

The layout content type of the sheet. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

A sheet is an object that contains a set of visuals that\n are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

" - } - }, - "com.amazonaws.quicksight#SheetDefinitionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetDefinition" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SheetDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SheetElementConfigurationOverrides": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the overrides are visible. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

" - } - }, - "com.amazonaws.quicksight#SheetElementRenderingRule": { - "type": "structure", - "members": { - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression of the rendering rules of a sheet.

", - "smithy.api#required": {} - } - }, - "ConfigurationOverrides": { - "target": "com.amazonaws.quicksight#SheetElementConfigurationOverrides", - "traits": { - "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The rendering rules of a sheet that uses a free-form layout.

" - } - }, - "com.amazonaws.quicksight#SheetElementRenderingRuleList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetElementRenderingRule" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10000 - } - } - }, - "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The status of the sheet layout maximization options of a dashbaord.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" - } - }, - "com.amazonaws.quicksight#SheetList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Sheet" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#SheetName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#SheetStyle": { - "type": "structure", - "members": { - "Tile": { - "target": "com.amazonaws.quicksight#TileStyle", - "traits": { - "smithy.api#documentation": "

The display options for tiles.

" - } - }, - "TileLayout": { - "target": "com.amazonaws.quicksight#TileLayoutStyle", - "traits": { - "smithy.api#documentation": "

The layout options for tiles.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme display options for sheets.

" - } - }, - "com.amazonaws.quicksight#SheetTextBox": { - "type": "structure", - "members": { - "SheetTextBoxId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#SheetTextBoxContent", - "traits": { - "smithy.api#documentation": "

The content that is displayed in the text box.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A text box.

" - } - }, - "com.amazonaws.quicksight#SheetTextBoxContent": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150000 - } - } - }, - "com.amazonaws.quicksight#SheetTextBoxList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetTextBox" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#SheetTitle": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SheetVisualScopingConfiguration": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The selected sheet that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Scope": { - "target": "com.amazonaws.quicksight#FilterVisualScope", - "traits": { - "smithy.api#documentation": "

The scope of the applied entities. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - }, - "VisualIds": { - "target": "com.amazonaws.quicksight#FilteredVisualsList", - "traits": { - "smithy.api#documentation": "

The selected visuals that the filter is applied to.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The filter that is applied to the options.

" - } - }, - "com.amazonaws.quicksight#SheetVisualScopingConfigurations": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SheetVisualScopingConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#ShortFormatText": { - "type": "structure", - "members": { - "PlainText": { - "target": "com.amazonaws.quicksight#ShortPlainText", - "traits": { - "smithy.api#documentation": "

Plain text format.

" - } - }, - "RichText": { - "target": "com.amazonaws.quicksight#ShortRichText", - "traits": { - "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The text format for the title.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#ShortPlainText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#ShortRestrictiveResourceId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } - }, - "com.amazonaws.quicksight#ShortRichText": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SignupResponse": { - "type": "structure", - "members": { - "IAMUser": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an\n authentication method.

" - } - }, - "userLoginName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The user login name for your Amazon QuickSight account.

" - } - }, - "accountName": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of your Amazon QuickSight account.

" - } - }, - "directoryType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the Amazon QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A SignupResponse object that contains a summary of a newly created account.

" - } - }, - "com.amazonaws.quicksight#SimpleAttributeAggregationFunction": { - "type": "enum", - "members": { - "UNIQUE_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNIQUE_VALUE" - } - } - } - }, - "com.amazonaws.quicksight#SimpleClusterMarker": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of the simple cluster marker.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" - } - }, - "com.amazonaws.quicksight#SimpleNumericalAggregationFunction": { - "type": "enum", - "members": { - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COUNT" - } - }, - "DISTINCT_COUNT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISTINCT_COUNT" - } - }, - "VAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VAR" - } - }, - "VARP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VARP" - } - }, - "STDEV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEV" - } - }, - "STDEVP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STDEVP" - } - }, - "MEDIAN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIAN" - } - } - } - }, - "com.amazonaws.quicksight#SimpleTotalAggregationFunction": { - "type": "enum", - "members": { - "DEFAULT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DEFAULT" - } - }, - "SUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SUM" - } - }, - "AVERAGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVERAGE" - } - }, - "MIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIN" - } - }, - "MAX": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MAX" - } - }, - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - } - } - }, - "com.amazonaws.quicksight#SingleAxisOptions": { - "type": "structure", - "members": { - "YAxisOptions": { - "target": "com.amazonaws.quicksight#YAxisOptions", - "traits": { - "smithy.api#documentation": "

The Y axis options of a single axis configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings of a chart's single axis configuration.

" - } - }, - "com.amazonaws.quicksight#SingleYAxisOption": { - "type": "enum", - "members": { - "PRIMARY_Y_AXIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_Y_AXIS" - } - } - } - }, - "com.amazonaws.quicksight#SiteBaseUrl": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1024 - } - } - }, - "com.amazonaws.quicksight#SliderControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#Slot": { - "type": "structure", - "members": { - "SlotId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The slot ID of the slot.

" - } - }, - "VisualId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The visual ID for the slot.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for the slot.

" - } - }, - "com.amazonaws.quicksight#Slots": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Slot" - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisPlacement": { - "type": "enum", - "members": { - "OUTSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OUTSIDE" - } - }, - "INSIDE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INSIDE" - } - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisProperties": { - "type": "structure", - "members": { - "Scale": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisScale", - "traits": { - "smithy.api#documentation": "

Determines whether scale of the axes are shared or independent. The default value is SHARED.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisPlacement", - "traits": { - "smithy.api#documentation": "

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Configures the properties of a chart's axes that are used by small multiples panels.

" - } - }, - "com.amazonaws.quicksight#SmallMultiplesAxisScale": { - "type": "enum", - "members": { - "SHARED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SHARED" - } - }, - "INDEPENDENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INDEPENDENT" - } - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SmallMultiplesOptions": { - "type": "structure", - "members": { - "MaxVisibleRows": { - "target": "com.amazonaws.quicksight#VisiblePanelRows", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of visible rows to display in the grid of small multiples panels.

\n

The default value is Auto,\n which automatically adjusts the rows in the grid\n to fit the overall layout and size of the given chart.

" - } - }, - "MaxVisibleColumns": { - "target": "com.amazonaws.quicksight#VisiblePanelColumns", - "traits": { - "smithy.api#documentation": "

Sets the maximum number of visible columns to display in the grid of small multiples panels.

\n

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

" - } - }, - "PanelConfiguration": { - "target": "com.amazonaws.quicksight#PanelConfiguration", - "traits": { - "smithy.api#documentation": "

Configures the display options for each small multiples panel.

" - } - }, - "XAxis": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", - "traits": { - "smithy.api#documentation": "

The properties of a small multiples X axis.

" - } - }, - "YAxis": { - "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", - "traits": { - "smithy.api#documentation": "

The properties of a small multiples Y axis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Options that determine the layout and display options of a chart's small multiples.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUser": { - "type": "structure", - "members": { - "RowLevelPermissionTags": { - "target": "com.amazonaws.quicksight#SessionTagList", - "traits": { - "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the anonymous user configuration.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUser" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted": { - "type": "structure", - "members": { - "RowLevelPermissionTagKeys": { - "target": "com.amazonaws.quicksight#SessionTagKeyList", - "traits": { - "smithy.api#documentation": "

The tag keys for the RowLevelPermissionTags.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotConfiguration": { - "type": "structure", - "members": { - "FileGroups": { - "target": "com.amazonaws.quicksight#SnapshotFileGroupList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

", - "smithy.api#required": {} - } - }, - "DestinationConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotDestinationConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

" - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters" - } - }, - "traits": { - "smithy.api#documentation": "

Describes the configuration of the dashboard snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotDestinationConfiguration": { - "type": "structure", - "members": { - "S3Destinations": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList", - "traits": { - "smithy.api#documentation": "

\n A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotFile": { - "type": "structure", - "members": { - "SheetSelections": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

", - "smithy.api#required": {} - } - }, - "FormatType": { - "target": "com.amazonaws.quicksight#SnapshotFileFormatType", - "traits": { - "smithy.api#documentation": "

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileFormatType": { - "type": "enum", - "members": { - "CSV": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CSV" - } - }, - "PDF": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PDF" - } - }, - "EXCEL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXCEL" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotFileGroup": { - "type": "structure", - "members": { - "Files": { - "target": "com.amazonaws.quicksight#SnapshotFileList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains the information on the snapshot files.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFileGroup" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 7 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFile" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelection": { - "type": "structure", - "members": { - "SheetId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

", - "smithy.api#required": {} - } - }, - "SelectionScope": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope", - "traits": { - "smithy.api#documentation": "

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

\n ", - "smithy.api#required": {} - } - }, - "VisualIds": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList", - "traits": { - "smithy.api#documentation": "

\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information that identifies the snapshot that needs to be generated.

" - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotFileSheetSelection" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - }, - "SELECTED_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SELECTED_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 5 - } - } - }, - "com.amazonaws.quicksight#SnapshotJobErrorInfo": { - "type": "structure", - "members": { - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, - "ErrorType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that contains information on the error that caused the snapshot job to fail.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResult": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList", - "traits": { - "smithy.api#documentation": "

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultErrorInfo": { - "type": "structure", - "members": { - "ErrorMessage": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - }, - "ErrorType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The error type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information on the error that caused the snapshot job to fail.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfo" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultFileGroup": { - "type": "structure", - "members": { - "Files": { - "target": "com.amazonaws.quicksight#SnapshotFileList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotFile objects.

" - } - }, - "S3Results": { - "target": "com.amazonaws.quicksight#SnapshotJobS3ResultList", - "traits": { - "smithy.api#documentation": "

A list of SnapshotJobS3Result objects.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information on the generated snapshot file groups.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobResultFileGroupList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroup" - } - }, - "com.amazonaws.quicksight#SnapshotJobS3Result": { - "type": "structure", - "members": { - "S3DestinationConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration", - "traits": { - "smithy.api#documentation": "

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.\n

" - } - }, - "S3Uri": { - "target": "com.amazonaws.quicksight#SensitiveS3Uri", - "traits": { - "smithy.api#documentation": "

The Amazon S3 Uri.

" - } - }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList", - "traits": { - "smithy.api#documentation": "

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

" - } - }, - "com.amazonaws.quicksight#SnapshotJobS3ResultList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotJobS3Result" - } - }, - "com.amazonaws.quicksight#SnapshotJobStatus": { - "type": "enum", - "members": { - "QUEUED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUEUED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - } - } - }, - "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration": { - "type": "structure", - "members": { - "BucketConfiguration": { - "target": "com.amazonaws.quicksight#S3BucketConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

" - } - }, - "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1 - } - } - }, - "com.amazonaws.quicksight#SnapshotUserConfiguration": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserList", - "traits": { - "smithy.api#documentation": "

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for.

" - } - }, - "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted": { - "type": "structure", - "members": { - "AnonymousUsers": { - "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList", - "traits": { - "smithy.api#documentation": "

\n An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" - } - }, - "com.amazonaws.quicksight#SnowflakeParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - }, - "Warehouse": { - "target": "com.amazonaws.quicksight#Warehouse", - "traits": { - "smithy.api#documentation": "

Warehouse.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Snowflake.

" - } - }, - "com.amazonaws.quicksight#SortDirection": { - "type": "enum", - "members": { - "ASC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASC" - } - }, - "DESC": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESC" - } - } - } - }, - "com.amazonaws.quicksight#Spacing": { - "type": "structure", - "members": { - "Top": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the top spacing.

" - } - }, - "Bottom": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the bottom spacing.

" - } - }, - "Left": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the left spacing.

" - } - }, - "Right": { - "target": "com.amazonaws.quicksight#Length", - "traits": { - "smithy.api#documentation": "

Define the right spacing.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of spacing (often a margin or padding).

" - } - }, - "com.amazonaws.quicksight#SparkParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Spark.

" - } - }, - "com.amazonaws.quicksight#SpecialValue": { - "type": "enum", - "members": { - "EMPTY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPTY" - } - }, - "NULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULL" - } - }, - "OTHER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "OTHER" - } - } - } - }, - "com.amazonaws.quicksight#SqlEndpointPath": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 4096 - } - } - }, - "com.amazonaws.quicksight#SqlQuery": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 168000 - } - } - }, - "com.amazonaws.quicksight#SqlServerParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for SQL Server.

" - } - }, - "com.amazonaws.quicksight#SslProperties": { - "type": "structure", - "members": { - "DisableSsl": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean option to control whether SSL should be disabled.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

" - } - }, - "com.amazonaws.quicksight#StarburstParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Starburst data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Starburst data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

The catalog name for the Starburst data source.

", - "smithy.api#required": {} - } - }, - "ProductType": { - "target": "com.amazonaws.quicksight#StarburstProductType", - "traits": { - "smithy.api#documentation": "

The product type for the Starburst data source.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" - } - }, - "com.amazonaws.quicksight#StarburstProductType": { - "type": "enum", - "members": { - "GALAXY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "GALAXY" - } - }, - "ENTERPRISE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENTERPRISE" - } - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartAssetBundleExportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account to export assets from.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", - "smithy.api#required": {} - } - }, - "ResourceArns": { - "target": "com.amazonaws.quicksight#AssetBundleResourceArns", - "traits": { - "smithy.api#documentation": "

An array of resource ARNs to export. The following resources are supported.

\n \n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", - "smithy.api#required": {} - } - }, - "IncludeAllDependencies": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all dependencies of each resource ARN are recursively\n exported with the job. For example, say you provided a Dashboard ARN to the\n ResourceArns parameter. If you set IncludeAllDependencies to\n TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also\n exported.

" - } - }, - "ExportFormat": { - "target": "com.amazonaws.quicksight#AssetBundleExportFormat", - "traits": { - "smithy.api#documentation": "

The export data format.

", - "smithy.api#required": {} - } - }, - "CloudFormationOverridePropertyConfiguration": { - "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", - "traits": { - "smithy.api#documentation": "

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

\n

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

" - } - }, - "IncludePermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.\n

" - } - }, - "IncludeTags": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleExportJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" - } - }, - "AssetBundleExportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartAssetBundleImportJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account to import assets into.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", - "smithy.api#required": {} - } - }, - "AssetBundleImportSource": { - "target": "com.amazonaws.quicksight#AssetBundleImportSource", - "traits": { - "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.\n

", - "smithy.api#required": {} - } - }, - "OverrideParameters": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", - "traits": { - "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" - } - }, - "FailureAction": { - "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", - "traits": { - "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

" - } - }, - "OverridePermissions": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", - "traits": { - "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideTags": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", - "traits": { - "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" - } - }, - "OverrideValidationStrategy": { - "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", - "traits": { - "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartAssetBundleImportJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" - } - }, - "AssetBundleImportJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the response.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJob": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n \n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n \n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dashboard that you want to start a snapshot job for.\n

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

", - "smithy.api#required": {} - } - }, - "UserConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotUserConfiguration", - "traits": { - "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

", - "smithy.api#required": {} - } - }, - "SnapshotConfiguration": { - "target": "com.amazonaws.quicksight#SnapshotConfiguration", - "traits": { - "smithy.api#documentation": "

A structure that describes the configuration of the dashboard snapshot.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dashboard snapshot job.

" - } - }, - "SnapshotJobId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#StatePersistenceConfigurations": { - "type": "structure", - "members": { - "Enabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" - } - }, - "com.amazonaws.quicksight#Status": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#StatusCode": { - "type": "integer", - "traits": { - "smithy.api#default": 0 - } - }, - "com.amazonaws.quicksight#String": { - "type": "string" - }, - "com.amazonaws.quicksight#StringDatasetParameter": { - "type": "structure", - "members": { - "Id": { - "target": "com.amazonaws.quicksight#DatasetParameterId", - "traits": { - "smithy.api#documentation": "

An identifier for the string parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DatasetParameterName", - "traits": { - "smithy.api#documentation": "

The name of the string parameter that is created in the dataset.

", - "smithy.api#required": {} - } - }, - "ValueType": { - "target": "com.amazonaws.quicksight#DatasetParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValues", - "traits": { - "smithy.api#documentation": "

A list of default values for a given string dataset parameter type. This structure only accepts static values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A string parameter for a dataset.

" - } - }, - "com.amazonaws.quicksight#StringDatasetParameterDefaultValue": { - "type": "string", - "traits": { - "smithy.api#documentation": "

The default value for the string parameter.

", - "smithy.api#length": { - "min": 0, - "max": 512 - } - } - }, - "com.amazonaws.quicksight#StringDatasetParameterDefaultValues": { - "type": "structure", - "members": { - "StaticValues": { - "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", - "traits": { - "smithy.api#documentation": "

A list of static default values for a given string parameter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of a string parameter.

" - } - }, - "com.amazonaws.quicksight#StringDatasetParameterValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValue" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 32 - } - } - }, - "com.amazonaws.quicksight#StringDefaultValueList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SensitiveStringObject" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50000 - } - } - }, - "com.amazonaws.quicksight#StringDefaultValues": { - "type": "structure", - "members": { - "DynamicValue": { - "target": "com.amazonaws.quicksight#DynamicDefaultValue", - "traits": { - "smithy.api#documentation": "

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

" - } - }, - "StaticValues": { - "target": "com.amazonaws.quicksight#StringDefaultValueList", - "traits": { - "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The default values of the StringParameterDeclaration.

" - } - }, - "com.amazonaws.quicksight#StringFormatConfiguration": { - "type": "structure", - "members": { - "NullValueFormatConfiguration": { - "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The options that determine the null value format configuration.

" - } - }, - "NumericFormatConfiguration": { - "target": "com.amazonaws.quicksight#NumericFormatConfiguration", - "traits": { - "smithy.api#documentation": "

The formatting configuration for numeric strings.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Formatting configuration for string fields.

" - } - }, - "com.amazonaws.quicksight#StringList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#String" - } - }, - "com.amazonaws.quicksight#StringParameter": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

A display name for a string parameter.

", - "smithy.api#required": {} - } - }, - "Values": { - "target": "com.amazonaws.quicksight#SensitiveStringList", - "traits": { - "smithy.api#documentation": "

The values of a string parameter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A string parameter.

" - } - }, - "com.amazonaws.quicksight#StringParameterDeclaration": { - "type": "structure", - "members": { - "ParameterValueType": { - "target": "com.amazonaws.quicksight#ParameterValueType", - "traits": { - "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The name of the parameter that is being declared.

", - "smithy.api#required": {} - } - }, - "DefaultValues": { - "target": "com.amazonaws.quicksight#StringDefaultValues", - "traits": { - "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" - } - }, - "ValueWhenUnset": { - "target": "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" - } - }, - "MappedDataSetParameters": { - "target": "com.amazonaws.quicksight#MappedDataSetParameters" - } - }, - "traits": { - "smithy.api#documentation": "

A parameter declaration for the String data type.

" - } - }, - "com.amazonaws.quicksight#StringParameterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#StringParameter" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration": { - "type": "structure", - "members": { - "ValueWhenUnsetOption": { - "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", - "traits": { - "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " - } - }, - "CustomValue": { - "target": "com.amazonaws.quicksight#SensitiveString", - "traits": { - "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" - } - }, - "com.amazonaws.quicksight#StyledCellType": { - "type": "enum", - "members": { - "TOTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOTAL" - } - }, - "METRIC_HEADER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "METRIC_HEADER" - } - }, - "VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VALUE" - } - } - } - }, - "com.amazonaws.quicksight#SubnetId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^subnet-[0-9a-z]*$" - } - }, - "com.amazonaws.quicksight#SubnetIdList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SubnetId" - }, - "traits": { - "smithy.api#length": { - "min": 2, - "max": 15 - } - } - }, - "com.amazonaws.quicksight#SubtotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the subtotal cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the subtotal cells.

" - } - }, - "FieldLevel": { - "target": "com.amazonaws.quicksight#PivotTableSubtotalLevel", - "traits": { - "smithy.api#documentation": "

The field level (all, custom, last) for the subtotal cells.

" - } - }, - "FieldLevelOptions": { - "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList", - "traits": { - "smithy.api#documentation": "

The optional configuration of subtotal cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotal cells.

" - } - }, - "ValueCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotals of value cells.

" - } - }, - "MetricHeaderCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The cell styling options for the subtotals of header cells.

" - } - }, - "StyleTargets": { - "target": "com.amazonaws.quicksight#TableStyleTargetList", - "traits": { - "smithy.api#documentation": "

The style targets options for subtotals.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The subtotal options.

" - } - }, - "com.amazonaws.quicksight#SucceededTopicReviewedAnswer": { - "type": "structure", - "members": { - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID for the SucceededTopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a SucceededTopicReviewedAnswer.

" - } - }, - "com.amazonaws.quicksight#SucceededTopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswer" - } - }, - "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry" - } - }, - "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry": { - "type": "structure", - "members": { - "KeyArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

", - "smithy.api#required": {} - } - }, - "StatusCode": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

" - } - }, - "com.amazonaws.quicksight#Suffix": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - }, - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#Synonyms": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#LimitedString" - } - }, - "com.amazonaws.quicksight#TableAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well for a pivot table. Values are grouped by group by fields.

" - } - }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The aggregated field well for the table.

" - } - }, - "com.amazonaws.quicksight#TableBorderOptions": { - "type": "structure", - "members": { - "Color": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of a table border.

" - } - }, - "Thickness": { - "target": "com.amazonaws.quicksight#TableBorderThickness", - "traits": { - "smithy.api#documentation": "

The thickness of a table border.

" - } - }, - "Style": { - "target": "com.amazonaws.quicksight#TableBorderStyle", - "traits": { - "smithy.api#documentation": "

The style (none, solid) of a table border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The border options for a table border.

" - } - }, - "com.amazonaws.quicksight#TableBorderStyle": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "SOLID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOLID" - } - } - } - }, - "com.amazonaws.quicksight#TableBorderThickness": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 4 - } - } - }, - "com.amazonaws.quicksight#TableCellConditionalFormatting": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", - "smithy.api#required": {} - } - }, - "TextFormat": { - "target": "com.amazonaws.quicksight#TextConditionalFormat", - "traits": { - "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a table.

" - } - }, - "com.amazonaws.quicksight#TableCellImageScalingConfiguration": { - "type": "enum", - "members": { - "FIT_TO_CELL_HEIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_CELL_HEIGHT" - } - }, - "FIT_TO_CELL_WIDTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FIT_TO_CELL_WIDTH" - } - }, - "DO_NOT_SCALE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DO_NOT_SCALE" - } - } - } - }, - "com.amazonaws.quicksight#TableCellImageSizingConfiguration": { - "type": "structure", - "members": { - "TableCellImageScalingConfiguration": { - "target": "com.amazonaws.quicksight#TableCellImageScalingConfiguration", - "traits": { - "smithy.api#documentation": "

The cell scaling configuration of the sizing options for the table image configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sizing options for the table image configuration.

" - } - }, - "com.amazonaws.quicksight#TableCellStyle": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the table cells.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the table cells.

" - } - }, - "TextWrap": { - "target": "com.amazonaws.quicksight#TextWrap", - "traits": { - "smithy.api#documentation": "

The text wrap (none, wrap) for the table cells.

" - } - }, - "HorizontalTextAlignment": { - "target": "com.amazonaws.quicksight#HorizontalTextAlignment", - "traits": { - "smithy.api#documentation": "

The horizontal text alignment (left, center, right, auto) for the table cells.

" - } - }, - "VerticalTextAlignment": { - "target": "com.amazonaws.quicksight#VerticalTextAlignment", - "traits": { - "smithy.api#documentation": "

The vertical text alignment (top, middle, bottom) for the table cells.

" - } - }, - "BackgroundColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color for the table cells.

" - } - }, - "Height": { - "target": "com.amazonaws.quicksight#TableFieldHeight", - "traits": { - "smithy.api#documentation": "

The height color for the table cells.

" - } - }, - "Border": { - "target": "com.amazonaws.quicksight#GlobalTableBorderOptions", - "traits": { - "smithy.api#documentation": "

The borders for the table cells.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table cell style for a cell in pivot table or table visual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormatting": { - "type": "structure", - "members": { - "ConditionalFormattingOptions": { - "target": "com.amazonaws.quicksight#TableConditionalFormattingOptionList", - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormattingOption": { - "type": "structure", - "members": { - "Cell": { - "target": "com.amazonaws.quicksight#TableCellConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The cell conditional formatting option for a table.

" - } - }, - "Row": { - "target": "com.amazonaws.quicksight#TableRowConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The row conditional formatting option for a table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" - } - }, - "com.amazonaws.quicksight#TableConditionalFormattingOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableConditionalFormattingOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#TableConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#TableFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#TableSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration for a TableVisual.

" - } - }, - "TableOptions": { - "target": "com.amazonaws.quicksight#TableOptions", - "traits": { - "smithy.api#documentation": "

The table options for a table visual.

" - } - }, - "TotalOptions": { - "target": "com.amazonaws.quicksight#TotalOptions", - "traits": { - "smithy.api#documentation": "

The total options for a table visual.

" - } - }, - "FieldOptions": { - "target": "com.amazonaws.quicksight#TableFieldOptions", - "traits": { - "smithy.api#documentation": "

The field options for a table visual.

" - } - }, - "PaginatedReportOptions": { - "target": "com.amazonaws.quicksight#TablePaginatedReportOptions", - "traits": { - "smithy.api#documentation": "

The paginated report options for a table visual.

" - } - }, - "TableInlineVisualizations": { - "target": "com.amazonaws.quicksight#TableInlineVisualizationList", - "traits": { - "smithy.api#documentation": "

A collection of inline visualizations to display within a chart.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration for a TableVisual.

" - } - }, - "com.amazonaws.quicksight#TableFieldCustomIconContent": { - "type": "structure", - "members": { - "Icon": { - "target": "com.amazonaws.quicksight#TableFieldIconSetType", - "traits": { - "smithy.api#documentation": "

The icon set type (link) of the custom icon content for table URL link content.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldCustomTextContent": { - "type": "structure", - "members": { - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The string value of the custom text content for the table URL link content.

" - } - }, - "FontConfiguration": { - "target": "com.amazonaws.quicksight#FontConfiguration", - "traits": { - "smithy.api#documentation": "

The font configuration of the custom text content for the table URL link content.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldHeight": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 8, - "max": 500 - } - } - }, - "com.amazonaws.quicksight#TableFieldIconSetType": { - "type": "enum", - "members": { - "LINK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINK" - } - } - } - }, - "com.amazonaws.quicksight#TableFieldImageConfiguration": { - "type": "structure", - "members": { - "SizingOptions": { - "target": "com.amazonaws.quicksight#TableCellImageSizingConfiguration", - "traits": { - "smithy.api#documentation": "

The sizing options for the table image configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The image configuration of a table field URL.

" - } - }, - "com.amazonaws.quicksight#TableFieldLinkConfiguration": { - "type": "structure", - "members": { - "Target": { - "target": "com.amazonaws.quicksight#URLTargetConfiguration", - "traits": { - "smithy.api#documentation": "

The URL target (new tab, new window, same tab) for the table link configuration.

", - "smithy.api#required": {} - } - }, - "Content": { - "target": "com.amazonaws.quicksight#TableFieldLinkContentConfiguration", - "traits": { - "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The link configuration of a table field URL.

" - } - }, - "com.amazonaws.quicksight#TableFieldLinkContentConfiguration": { - "type": "structure", - "members": { - "CustomTextContent": { - "target": "com.amazonaws.quicksight#TableFieldCustomTextContent", - "traits": { - "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" - } - }, - "CustomIconContent": { - "target": "com.amazonaws.quicksight#TableFieldCustomIconContent", - "traits": { - "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

" - } - }, - "com.amazonaws.quicksight#TableFieldOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field ID for a table field.

", - "smithy.api#required": {} - } - }, - "Width": { - "target": "com.amazonaws.quicksight#PixelLength", - "traits": { - "smithy.api#documentation": "

The width for a table field.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#CustomLabel", - "traits": { - "smithy.api#documentation": "

The custom label for a table field.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of a table field.

" - } - }, - "URLStyling": { - "target": "com.amazonaws.quicksight#TableFieldURLConfiguration", - "traits": { - "smithy.api#documentation": "

The URL configuration for a table field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options for a table field.

" - } - }, - "com.amazonaws.quicksight#TableFieldOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableFieldOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TableFieldOptions": { - "type": "structure", - "members": { - "SelectedFieldOptions": { - "target": "com.amazonaws.quicksight#TableFieldOptionList", - "traits": { - "smithy.api#documentation": "

The field options to be configured to a table.

" - } - }, - "Order": { - "target": "com.amazonaws.quicksight#FieldOrderList", - "traits": { - "smithy.api#documentation": "

The order of the field IDs that are configured as field options for a table visual.

" - } - }, - "PinnedFieldOptions": { - "target": "com.amazonaws.quicksight#TablePinnedFieldOptions", - "traits": { - "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field options of a table visual.

" - } - }, - "com.amazonaws.quicksight#TableFieldOrderList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#FieldId" - }, - "traits": { - "smithy.api#documentation": "

A list of table field IDs.

", - "smithy.api#length": { - "min": 0, - "max": 201 - } - } - }, - "com.amazonaws.quicksight#TableFieldURLConfiguration": { - "type": "structure", - "members": { - "LinkConfiguration": { - "target": "com.amazonaws.quicksight#TableFieldLinkConfiguration", - "traits": { - "smithy.api#documentation": "

The link configuration of a table field URL.

" - } - }, - "ImageConfiguration": { - "target": "com.amazonaws.quicksight#TableFieldImageConfiguration", - "traits": { - "smithy.api#documentation": "

The image configuration of a table field URL.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The URL configuration for a table field.

" - } - }, - "com.amazonaws.quicksight#TableFieldWells": { - "type": "structure", - "members": { - "TableAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TableAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field well for the table.

" - } - }, - "TableUnaggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TableUnaggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The unaggregated field well for the table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells for a table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#TableInlineVisualization": { - "type": "structure", - "members": { - "DataBars": { - "target": "com.amazonaws.quicksight#DataBarsOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the inline visualization of the data bars within a chart.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The inline visualization of a specific type to display within a chart.

" - } - }, - "com.amazonaws.quicksight#TableInlineVisualizationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableInlineVisualization" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TableOptions": { - "type": "structure", - "members": { - "Orientation": { - "target": "com.amazonaws.quicksight#TableOrientation", - "traits": { - "smithy.api#documentation": "

The orientation (vertical, horizontal) for a table.

" - } - }, - "HeaderStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of a table header.

" - } - }, - "CellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

The table cell style of table cells.

" - } - }, - "RowAlternateColorOptions": { - "target": "com.amazonaws.quicksight#RowAlternateColorOptions", - "traits": { - "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors) for a table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The table options for a table visual.

" - } - }, - "com.amazonaws.quicksight#TableOrientation": { - "type": "enum", - "members": { - "VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VERTICAL" - } - }, - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - } - } - }, - "com.amazonaws.quicksight#TablePaginatedReportOptions": { - "type": "structure", - "members": { - "VerticalOverflowVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of printing table overflow across pages.

" - } - }, - "OverflowColumnHeaderVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of repeating header rows on each page.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The paginated report options for a table visual.

" - } - }, - "com.amazonaws.quicksight#TablePinnedFieldOptions": { - "type": "structure", - "members": { - "PinnedLeftFields": { - "target": "com.amazonaws.quicksight#TableFieldOrderList", - "traits": { - "smithy.api#documentation": "

A list of columns to be pinned to the left of a table visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" - } - }, - "com.amazonaws.quicksight#TableRowConditionalFormatting": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the background for a table row.

" - } - }, - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the text for a table row.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting of a table row.

" - } - }, - "com.amazonaws.quicksight#TableSideBorderOptions": { - "type": "structure", - "members": { - "InnerVertical": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the inner vertical border.

" - } - }, - "InnerHorizontal": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the inner horizontal border.

" - } - }, - "Left": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the left border.

" - } - }, - "Right": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the right border.

" - } - }, - "Top": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the top border.

" - } - }, - "Bottom": { - "target": "com.amazonaws.quicksight#TableBorderOptions", - "traits": { - "smithy.api#documentation": "

The table border options of the bottom border.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The side border options for a table.

" - } - }, - "com.amazonaws.quicksight#TableSortConfiguration": { - "type": "structure", - "members": { - "RowSort": { - "target": "com.amazonaws.quicksight#RowSortList", - "traits": { - "smithy.api#documentation": "

The field sort options for rows in the table.

" - } - }, - "PaginationConfiguration": { - "target": "com.amazonaws.quicksight#PaginationConfiguration", - "traits": { - "smithy.api#documentation": "

The pagination configuration (page size, page number) for the table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration for a TableVisual.

" - } - }, - "com.amazonaws.quicksight#TableStyleTarget": { - "type": "structure", - "members": { - "CellType": { - "target": "com.amazonaws.quicksight#StyledCellType", - "traits": { - "smithy.api#documentation": "

The cell type of the table style target.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The table style target.

" - } - }, - "com.amazonaws.quicksight#TableStyleTargetList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TableStyleTarget" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 3 - } - } - }, - "com.amazonaws.quicksight#TableTotalsPlacement": { - "type": "enum", - "members": { - "START": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "START" - } - }, - "END": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "END" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } - }, - "com.amazonaws.quicksight#TableTotalsScrollStatus": { - "type": "enum", - "members": { - "PINNED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PINNED" - } - }, - "SCROLLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SCROLLED" - } - } - } - }, - "com.amazonaws.quicksight#TableUnaggregatedFieldWells": { - "type": "structure", - "members": { - "Values": { - "target": "com.amazonaws.quicksight#UnaggregatedFieldList", - "traits": { - "smithy.api#documentation": "

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field well for the table.

" - } - }, - "com.amazonaws.quicksight#TableVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#TableConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "ConditionalFormatting": { - "target": "com.amazonaws.quicksight#TableConditionalFormatting", - "traits": { - "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#Tag": { - "type": "structure", - "members": { - "Key": { - "target": "com.amazonaws.quicksight#TagKey", - "traits": { - "smithy.api#documentation": "

Tag key.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#TagValue", - "traits": { - "smithy.api#documentation": "

Tag value.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

" - } - }, - "com.amazonaws.quicksight#TagColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The column that this operation acts on.

", - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#ColumnTagList", - "traits": { - "smithy.api#documentation": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that tags a column with additional information.

" - } - }, - "com.amazonaws.quicksight#TagKey": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } - }, - "com.amazonaws.quicksight#TagKeyList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TagKey" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TagList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Tag" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 200 - } - } - }, - "com.amazonaws.quicksight#TagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#TagResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#TagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n ", - "smithy.api#http": { - "method": "POST", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } - }, - "com.amazonaws.quicksight#TagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } - }, - "com.amazonaws.quicksight#TagResourceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } - }, - "com.amazonaws.quicksight#TagValue": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } - }, - "com.amazonaws.quicksight#TargetVisualList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 50 - } - } - }, - "com.amazonaws.quicksight#TargetVisualOptions": { - "type": "enum", - "members": { - "ALL_VISUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL_VISUALS" - } - } - } - }, - "com.amazonaws.quicksight#Template": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The display name of the template.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#TemplateVersion", - "traits": { - "smithy.api#documentation": "

A structure describing the versions of the template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time when this was last updated.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

Time when this was created.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A template object. A template is an entity in Amazon QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" - } - }, - "com.amazonaws.quicksight#TemplateAlias": { - "type": "structure", - "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The display name of the template alias.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template alias.

" - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template alias.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template alias.

" - } - }, - "com.amazonaws.quicksight#TemplateAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateAlias" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TemplateError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#TemplateErrorType", - "traits": { - "smithy.api#documentation": "

Type of error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

Description of the error type.

" - } - }, - "ViolatedEntities": { - "target": "com.amazonaws.quicksight#EntityList", - "traits": { - "smithy.api#documentation": "

An error path that shows which entities caused the template error.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

List of errors that occurred when the template version creation failed.

" - } - }, - "com.amazonaws.quicksight#TemplateErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#TemplateErrorType": { - "type": "enum", - "members": { - "SOURCE_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SOURCE_NOT_FOUND" - } - }, - "DATA_SET_NOT_FOUND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_SET_NOT_FOUND" - } - }, - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - }, - "ACCESS_DENIED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCESS_DENIED" - } - } - } - }, - "com.amazonaws.quicksight#TemplateName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#TemplateSourceAnalysis": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - }, - "DataSetReferences": { - "target": "com.amazonaws.quicksight#DataSetReferenceList", - "traits": { - "smithy.api#documentation": "

A structure containing information about the dataset references used as placeholders\n in the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source analysis of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSourceEntity": { - "type": "structure", - "members": { - "SourceAnalysis": { - "target": "com.amazonaws.quicksight#TemplateSourceAnalysis", - "traits": { - "smithy.api#documentation": "

The source analysis, if it is based on an analysis.

" - } - }, - "SourceTemplate": { - "target": "com.amazonaws.quicksight#TemplateSourceTemplate", - "traits": { - "smithy.api#documentation": "

The source template, if it is based on an template.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The source entity of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSourceTemplate": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The source template of the template.

" - } - }, - "com.amazonaws.quicksight#TemplateSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

A summary of a template.

" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

A display name for the template.

" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

A structure containing a list of version numbers for the template summary.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this template was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last time that this template was updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template summary.

" - } - }, - "com.amazonaws.quicksight#TemplateSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TemplateVersion": { - "type": "structure", - "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this template version was created.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#TemplateErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with this template version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template version.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status that is associated with the template.

\n " - } - }, - "DataSetConfigurations": { - "target": "com.amazonaws.quicksight#DataSetConfigurationList", - "traits": { - "smithy.api#documentation": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the template.

" - } - }, - "SourceEntityArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the theme associated with this version of the template.

" - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", - "traits": { - "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of a template.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionDefinition": { - "type": "structure", - "members": { - "DataSetConfigurations": { - "target": "com.amazonaws.quicksight#DataSetConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

", - "smithy.api#required": {} - } - }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetDefinitionList", - "traits": { - "smithy.api#documentation": "

An array of sheet definitions for a template.

" - } - }, - "CalculatedFields": { - "target": "com.amazonaws.quicksight#CalculatedFields", - "traits": { - "smithy.api#documentation": "

An array of calculated field definitions for the template.

" - } - }, - "ParameterDeclarations": { - "target": "com.amazonaws.quicksight#ParameterDeclarationList", - "traits": { - "smithy.api#documentation": "

An array of parameter declarations for a template.

\n

\n Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the\n Amazon QuickSight User Guide.\n

" - } - }, - "FilterGroups": { - "target": "com.amazonaws.quicksight#FilterGroupList", - "traits": { - "smithy.api#documentation": "

Filter definitions for a template.

\n

For more information, see Filtering Data in the Amazon QuickSight User Guide.\n

" - } - }, - "ColumnConfigurations": { - "target": "com.amazonaws.quicksight#ColumnConfigurationList", - "traits": { - "smithy.api#documentation": "

An array of template-level column\n configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

" - } - }, - "AnalysisDefaults": { - "target": "com.amazonaws.quicksight#AnalysisDefaults" - }, - "Options": { - "target": "com.amazonaws.quicksight#AssetOptions", - "traits": { - "smithy.api#documentation": "

An array of option definitions for a template.

" - } - }, - "QueryExecutionOptions": { - "target": "com.amazonaws.quicksight#QueryExecutionOptions" - } - }, - "traits": { - "smithy.api#documentation": "

The detailed definition of a template.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template version.

" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that this template version was created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the template version.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the template version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The template version.

" - } - }, - "com.amazonaws.quicksight#TemplateVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TemplateVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TeradataParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

Host.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

Port.

", - "smithy.api#required": {} - } - }, - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "

Database.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Teradata.

" - } - }, - "com.amazonaws.quicksight#TextAreaControlDelimiter": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#TextAreaControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "PlaceholderOptions": { - "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text area control.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#TextConditionalFormat": { - "type": "structure", - "members": { - "BackgroundColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text background color.

" - } - }, - "TextColor": { - "target": "com.amazonaws.quicksight#ConditionalFormattingColor", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text color.

" - } - }, - "Icon": { - "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", - "traits": { - "smithy.api#documentation": "

The conditional formatting for the icon.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The conditional formatting for the text.

" - } - }, - "com.amazonaws.quicksight#TextControlPlaceholderOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration of the placeholder options in a text control.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text control.

" - } - }, - "com.amazonaws.quicksight#TextFieldControlDisplayOptions": { - "type": "structure", - "members": { - "TitleOptions": { - "target": "com.amazonaws.quicksight#LabelOptions", - "traits": { - "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" - } - }, - "PlaceholderOptions": { - "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", - "traits": { - "smithy.api#documentation": "

The configuration of the placeholder options in a text field control.

" - } - }, - "InfoIconLabelOptions": { - "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", - "traits": { - "smithy.api#documentation": "

The configuration of info icon label options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options of a control.

" - } - }, - "com.amazonaws.quicksight#TextQualifier": { - "type": "enum", - "members": { - "DOUBLE_QUOTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOUBLE_QUOTE" - } - }, - "SINGLE_QUOTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SINGLE_QUOTE" - } - } - } - }, - "com.amazonaws.quicksight#TextWrap": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "WRAP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WRAP" - } - } - } - }, - "com.amazonaws.quicksight#Theme": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

The name that the user gives to the theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The identifier that the user gives to the theme.

" - } - }, - "Version": { - "target": "com.amazonaws.quicksight#ThemeVersion" - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the theme was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that the theme was last updated.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", - "traits": { - "smithy.api#documentation": "

The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT and CUSTOM.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Summary information about a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeAlias": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme alias.

" - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The display name of the theme alias.

" - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme alias.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An alias for a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeAliasList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeAlias" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThemeConfiguration": { - "type": "structure", - "members": { - "DataColorPalette": { - "target": "com.amazonaws.quicksight#DataColorPalette", - "traits": { - "smithy.api#documentation": "

Color properties that apply to chart data colors.

" - } - }, - "UIColorPalette": { - "target": "com.amazonaws.quicksight#UIColorPalette", - "traits": { - "smithy.api#documentation": "

Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.

" - } - }, - "Sheet": { - "target": "com.amazonaws.quicksight#SheetStyle", - "traits": { - "smithy.api#documentation": "

Display options related to sheets.

" - } - }, - "Typography": { - "target": "com.amazonaws.quicksight#Typography" - } - }, - "traits": { - "smithy.api#documentation": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeError": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#ThemeErrorType", - "traits": { - "smithy.api#documentation": "

The type of error.

" - } - }, - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The error message.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Theme error.

" - } - }, - "com.amazonaws.quicksight#ThemeErrorList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeError" - }, - "traits": { - "smithy.api#length": { - "min": 1 - } - } - }, - "com.amazonaws.quicksight#ThemeErrorType": { - "type": "enum", - "members": { - "INTERNAL_FAILURE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INTERNAL_FAILURE" - } - } - } - }, - "com.amazonaws.quicksight#ThemeName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } - }, - "com.amazonaws.quicksight#ThemeSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

the display name for the theme.

" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The latest version number for the theme.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The last date and time that this theme was updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme summary.

" - } - }, - "com.amazonaws.quicksight#ThemeSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThemeType": { - "type": "enum", - "members": { - "QUICKSIGHT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUICKSIGHT" - } - }, - "CUSTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CUSTOM" - } - }, - "ALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ALL" - } - } - } - }, - "com.amazonaws.quicksight#ThemeVersion": { - "type": "structure", - "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the theme.

" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme version was created.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains all the theme display properties.

" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#ThemeErrorList", - "traits": { - "smithy.api#documentation": "

Errors associated with the theme.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the theme version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A version of a theme.

" - } - }, - "com.amazonaws.quicksight#ThemeVersionSummary": { - "type": "structure", - "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme version.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme version.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

The description of the theme version.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date and time that this theme version was created.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the theme version.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme version.

" - } - }, - "com.amazonaws.quicksight#ThemeVersionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ThemeVersionSummary" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#ThousandSeparatorOptions": { - "type": "structure", - "members": { - "Symbol": { - "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", - "traits": { - "smithy.api#documentation": "

Determines the thousands separator symbol.

" - } - }, - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines the visibility of the thousands separator.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" - } - }, - "com.amazonaws.quicksight#ThrottlingException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Access is throttled.

", - "smithy.api#error": "client", - "smithy.api#httpError": 429 - } - }, - "com.amazonaws.quicksight#TileLayoutStyle": { - "type": "structure", - "members": { - "Gutter": { - "target": "com.amazonaws.quicksight#GutterStyle", - "traits": { - "smithy.api#documentation": "

The gutter settings that apply between tiles.

" - } - }, - "Margin": { - "target": "com.amazonaws.quicksight#MarginStyle", - "traits": { - "smithy.api#documentation": "

The margin settings that apply around the outside edge of sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the layout of tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#TileStyle": { - "type": "structure", - "members": { - "Border": { - "target": "com.amazonaws.quicksight#BorderStyle", - "traits": { - "smithy.api#documentation": "

The border around a tile.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Display options related to tiles on a sheet.

" - } - }, - "com.amazonaws.quicksight#TimeBasedForecastProperties": { - "type": "structure", - "members": { - "PeriodsForward": { - "target": "com.amazonaws.quicksight#PeriodsForward", - "traits": { - "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" - } - }, - "PeriodsBackward": { - "target": "com.amazonaws.quicksight#PeriodsBackward", - "traits": { - "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" - } - }, - "UpperBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" - } - }, - "LowerBoundary": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" - } - }, - "PredictionInterval": { - "target": "com.amazonaws.quicksight#PredictionInterval", - "traits": { - "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" - } - }, - "Seasonality": { - "target": "com.amazonaws.quicksight#Seasonality", - "traits": { - "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " - } - } - }, - "traits": { - "smithy.api#documentation": "

The forecast properties setup of a forecast in the line chart.

" - } - }, - "com.amazonaws.quicksight#TimeEqualityFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The value of a TimeEquality filter.

\n

This field is mutually exclusive to RollingDate and ParameterName.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to Value and RollingDate.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date input for the TimeEquality filter.

\n

This field is mutually exclusive to Value and ParameterName.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TimeEqualityFilter filters values that are equal to a given value.

" - } - }, - "com.amazonaws.quicksight#TimeGranularity": { - "type": "enum", - "members": { - "YEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YEAR" - } - }, - "QUARTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUARTER" - } - }, - "MONTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTH" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "MINUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE" - } - }, - "SECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECOND" - } - }, - "MILLISECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MILLISECOND" - } - } - } - }, - "com.amazonaws.quicksight#TimeRangeDrillDownFilter": { - "type": "structure", - "members": { - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "RangeMinimum": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

", - "smithy.api#required": {} - } - }, - "RangeMaximum": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The time range drill down filter.

" - } - }, - "com.amazonaws.quicksight#TimeRangeFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "IncludeMinimum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" - } - }, - "IncludeMaximum": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" - } - }, - "RangeMinimumValue": { - "target": "com.amazonaws.quicksight#TimeRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The minimum value for the filter value range.

" - } - }, - "RangeMaximumValue": { - "target": "com.amazonaws.quicksight#TimeRangeFilterValue", - "traits": { - "smithy.api#documentation": "

The maximum value for the filter value range.

" - } - }, - "NullOption": { - "target": "com.amazonaws.quicksight#FilterNullOption", - "traits": { - "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", - "smithy.api#required": {} - } - }, - "ExcludePeriodConfiguration": { - "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", - "traits": { - "smithy.api#documentation": "

The exclude period of the time range filter.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TimeRangeFilter filters values that are between two specified values.

" - } - }, - "com.amazonaws.quicksight#TimeRangeFilterValue": { - "type": "structure", - "members": { - "StaticValue": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The static input value.

" - } - }, - "RollingDate": { - "target": "com.amazonaws.quicksight#RollingDateConfiguration", - "traits": { - "smithy.api#documentation": "

The rolling date input value.

" - } - }, - "Parameter": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter type input value.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The value of a time range filter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#Timestamp": { - "type": "timestamp" - }, - "com.amazonaws.quicksight#TooltipItem": { - "type": "structure", - "members": { - "FieldTooltipItem": { - "target": "com.amazonaws.quicksight#FieldTooltipItem", - "traits": { - "smithy.api#documentation": "

The tooltip item for the fields.

" - } - }, - "ColumnTooltipItem": { - "target": "com.amazonaws.quicksight#ColumnTooltipItem", - "traits": { - "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The tooltip.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } - }, - "com.amazonaws.quicksight#TooltipItemList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TooltipItem" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } - }, - "com.amazonaws.quicksight#TooltipOptions": { - "type": "structure", - "members": { - "TooltipVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

Determines whether or not the tooltip is visible.

" - } - }, - "SelectedTooltipType": { - "target": "com.amazonaws.quicksight#SelectedTooltipType", - "traits": { - "smithy.api#documentation": "

The selected type for the tooltip. Choose one of the following options:

\n " - } - }, - "FieldBasedTooltip": { - "target": "com.amazonaws.quicksight#FieldBasedTooltip", - "traits": { - "smithy.api#documentation": "

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The display options for the visual tooltip.

" - } - }, - "com.amazonaws.quicksight#TooltipTarget": { - "type": "enum", - "members": { - "BOTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTH" - } - }, - "BAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BAR" - } - }, - "LINE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LINE" - } - } - } - }, - "com.amazonaws.quicksight#TooltipTitleType": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "PRIMARY_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY_VALUE" - } - } - } - }, - "com.amazonaws.quicksight#TopBottomComputationType": { - "type": "enum", - "members": { - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - } - } - }, - "com.amazonaws.quicksight#TopBottomFilter": { - "type": "structure", - "members": { - "FilterId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that the filter is applied to.

", - "smithy.api#required": {} - } - }, - "Limit": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

The number of items to include in the top bottom filter results.

" - } - }, - "AggregationSortConfigurations": { - "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", - "traits": { - "smithy.api#documentation": "

The aggregation and sort configuration of the top bottom filter.

", - "smithy.api#required": {} - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "ParameterName": { - "target": "com.amazonaws.quicksight#ParameterName", - "traits": { - "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" - } - }, - "DefaultFilterControlConfiguration": { - "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", - "traits": { - "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A TopBottomFilter filters values that are at the top or the bottom.

" - } - }, - "com.amazonaws.quicksight#TopBottomMoversComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Time": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The time field that is used in a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "MoverSize": { - "target": "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize", - "traits": { - "smithy.api#documentation": "

The mover size setup of the top and bottom movers computation.

" - } - }, - "SortOrder": { - "target": "com.amazonaws.quicksight#TopBottomSortOrder", - "traits": { - "smithy.api#documentation": "

The sort order setup of the top and bottom movers computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", - "traits": { - "smithy.api#documentation": "

The computation type. Choose from the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The top movers and bottom movers computation setup.

" - } - }, - "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#TopBottomRankedComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - }, - "ResultSize": { - "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", - "traits": { - "smithy.api#documentation": "

The result size of a top and bottom ranked computation.

" - } - }, - "Type": { - "target": "com.amazonaws.quicksight#TopBottomComputationType", - "traits": { - "smithy.api#documentation": "

The computation type. Choose one of the following options:

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" - } - }, - "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 20 - } - } - }, - "com.amazonaws.quicksight#TopBottomSortOrder": { - "type": "enum", - "members": { - "PERCENT_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PERCENT_DIFFERENCE" - } - }, - "ABSOLUTE_DIFFERENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" - } - } - } - }, - "com.amazonaws.quicksight#TopicCalculatedField": { - "type": "structure", - "members": { - "CalculatedFieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The calculated field name.

", - "smithy.api#required": {} - } - }, - "CalculatedFieldDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The calculated field description.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The calculated field expression.

", - "smithy.api#required": {} - } - }, - "CalculatedFieldSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the calculated field.

" - } - }, - "IsIncludedInTopic": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that indicates if a calculated field is included in the topic.

" - } - }, - "DisableIndexing": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates if a calculated field is visible in the autocomplete.

" - } - }, - "ColumnDataRole": { - "target": "com.amazonaws.quicksight#ColumnDataRole", - "traits": { - "smithy.api#documentation": "

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "DefaultFormatting": { - "target": "com.amazonaws.quicksight#DefaultFormatting", - "traits": { - "smithy.api#documentation": "

The default formatting definition.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#DefaultAggregation", - "traits": { - "smithy.api#documentation": "

The default aggregation. Valid values for this structure are SUM,\n MAX, MIN, COUNT,\n DISTINCT_COUNT,\n and AVERAGE.

" - } - }, - "ComparativeOrder": { - "target": "com.amazonaws.quicksight#ComparativeOrder", - "traits": { - "smithy.api#documentation": "

The order in which data is displayed for the calculated field when\n it's used in a comparative context.

" - } - }, - "SemanticType": { - "target": "com.amazonaws.quicksight#SemanticType", - "traits": { - "smithy.api#documentation": "

The semantic type.

" - } - }, - "AllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are allowed for the calculated field. Valid values\n for this structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" - } - }, - "NotAllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are not allowed for the calculated field. Valid\n values for this structure are COUNT, DISTINCT_COUNT,\n MIN, MAX, MEDIAN, SUM,\n AVERAGE, STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" - } - }, - "NeverAggregateInFilter": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether to never aggregate calculated field in filters.

" - } - }, - "CellValueSynonyms": { - "target": "com.amazonaws.quicksight#CellValueSynonyms", - "traits": { - "smithy.api#documentation": "

The other\n names or aliases for the calculated field cell value.

" - } - }, - "NonAdditive": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The non additive for the table style target.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a calculated field.

" - } - }, - "com.amazonaws.quicksight#TopicCalculatedFields": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicCalculatedField" - } - }, - "com.amazonaws.quicksight#TopicCategoryFilter": { - "type": "structure", - "members": { - "CategoryFilterFunction": { - "target": "com.amazonaws.quicksight#CategoryFilterFunction", - "traits": { - "smithy.api#documentation": "

The category filter function. Valid values for this structure are EXACT and CONTAINS.

" - } - }, - "CategoryFilterType": { - "target": "com.amazonaws.quicksight#CategoryFilterType", - "traits": { - "smithy.api#documentation": "

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicCategoryFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a category filter.

" - } - }, - "Inverse": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates if the filter is inverse.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a category filter.

" - } - }, - "com.amazonaws.quicksight#TopicCategoryFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

" - } - }, - "SingularConstant": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A singular constant used in a category filter. This element is used to specify a single value for the constant.

" - } - }, - "CollectiveConstant": { - "target": "com.amazonaws.quicksight#CollectiveConstant", - "traits": { - "smithy.api#documentation": "

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A constant used in a category filter.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#TopicColumn": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the column.

", - "smithy.api#required": {} - } - }, - "ColumnFriendlyName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A user-friendly name for the column.

" - } - }, - "ColumnDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A description of the column and its contents.

" - } - }, - "ColumnSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the column.

" - } - }, - "ColumnDataRole": { - "target": "com.amazonaws.quicksight#ColumnDataRole", - "traits": { - "smithy.api#documentation": "

The role of the column in the data. Valid values are DIMENSION and MEASURE.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#DefaultAggregation", - "traits": { - "smithy.api#documentation": "

The type of aggregation that is performed on the column data when\n it's queried.

" - } - }, - "IsIncludedInTopic": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the column is included in the query results.

" - } - }, - "DisableIndexing": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that indicates whether the column shows in the autocomplete functionality.

" - } - }, - "ComparativeOrder": { - "target": "com.amazonaws.quicksight#ComparativeOrder", - "traits": { - "smithy.api#documentation": "

The order in which data is displayed for the column when\n it's used in a comparative context.

" - } - }, - "SemanticType": { - "target": "com.amazonaws.quicksight#SemanticType", - "traits": { - "smithy.api#documentation": "

The semantic type of data contained in the column.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "AllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" - } - }, - "NotAllowedAggregations": { - "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", - "traits": { - "smithy.api#documentation": "

The list of aggregation types that are not allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" - } - }, - "DefaultFormatting": { - "target": "com.amazonaws.quicksight#DefaultFormatting", - "traits": { - "smithy.api#documentation": "

The default formatting used for values in the column.

" - } - }, - "NeverAggregateInFilter": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean\n value that indicates whether to aggregate the column data when\n it's used in a filter context.

" - } - }, - "CellValueSynonyms": { - "target": "com.amazonaws.quicksight#CellValueSynonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the column cell value.

" - } - }, - "NonAdditive": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

The non additive value for the column.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Represents a column in a dataset.

" - } - }, - "com.amazonaws.quicksight#TopicColumns": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicColumn" - } - }, - "com.amazonaws.quicksight#TopicConstantValue": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The constant type of a TopicConstantValue.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The value of the TopicConstantValue.

" - } - }, - "Minimum": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The minimum for the TopicConstantValue.

" - } - }, - "Maximum": { - "target": "com.amazonaws.quicksight#ConstantValueString", - "traits": { - "smithy.api#documentation": "

The maximum for the TopicConstantValue.

" - } - }, - "ValueList": { - "target": "com.amazonaws.quicksight#CollectiveConstantEntryList", - "traits": { - "smithy.api#documentation": "

The value list of the TopicConstantValue.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicConstantValue.

" - } - }, - "com.amazonaws.quicksight#TopicDateRangeFilter": { - "type": "structure", - "members": { - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the date range filter should include the boundary values. If\n set to true, the filter includes the start and end dates. If set to false, the filter\n excludes them.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a date range filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter used to restrict data based on a range of dates or times.

" - } - }, - "com.amazonaws.quicksight#TopicDetails": { - "type": "structure", - "members": { - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the topic.

" - } - }, - "Description": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the topic.

" - } - }, - "UserExperienceVersion": { - "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", - "traits": { - "smithy.api#documentation": "

The user experience version of a topic.

" - } - }, - "DataSets": { - "target": "com.amazonaws.quicksight#Datasets", - "traits": { - "smithy.api#documentation": "

The data sets that the topic is associated with.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that describes the details of a topic, such as its name, description, and associated data sets.

" - } - }, - "com.amazonaws.quicksight#TopicFilter": { - "type": "structure", - "members": { - "FilterDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

A description of the filter used to select items for a topic.

" - } - }, - "FilterClass": { - "target": "com.amazonaws.quicksight#FilterClass", - "traits": { - "smithy.api#documentation": "

The class of the filter. Valid values for this structure are\n ENFORCED_VALUE_FILTER,\n CONDITIONAL_VALUE_FILTER,\n and NAMED_VALUE_FILTER.

" - } - }, - "FilterName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the filter.

", - "smithy.api#required": {} - } - }, - "FilterSynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other names or aliases for the filter.

" - } - }, - "OperandFieldName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the field that the filter operates on.

", - "smithy.api#required": {} - } - }, - "FilterType": { - "target": "com.amazonaws.quicksight#NamedFilterType", - "traits": { - "smithy.api#documentation": "

The type of the filter. Valid values for this structure are\n CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER,\n NUMERIC_RANGE_FILTER,\n DATE_RANGE_FILTER,\n and RELATIVE_DATE_FILTER.

" - } - }, - "CategoryFilter": { - "target": "com.amazonaws.quicksight#TopicCategoryFilter", - "traits": { - "smithy.api#documentation": "

The category filter that is associated with this filter.

" - } - }, - "NumericEqualityFilter": { - "target": "com.amazonaws.quicksight#TopicNumericEqualityFilter", - "traits": { - "smithy.api#documentation": "

The numeric equality filter.

" - } - }, - "NumericRangeFilter": { - "target": "com.amazonaws.quicksight#TopicNumericRangeFilter", - "traits": { - "smithy.api#documentation": "

The numeric range filter.

" - } - }, - "DateRangeFilter": { - "target": "com.amazonaws.quicksight#TopicDateRangeFilter", - "traits": { - "smithy.api#documentation": "

The date range filter.

" - } - }, - "RelativeDateFilter": { - "target": "com.amazonaws.quicksight#TopicRelativeDateFilter", - "traits": { - "smithy.api#documentation": "

The relative date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" - } - }, - "com.amazonaws.quicksight#TopicFilters": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicFilter" - } - }, - "com.amazonaws.quicksight#TopicIR": { - "type": "structure", - "members": { - "Metrics": { - "target": "com.amazonaws.quicksight#TopicIRMetricList", - "traits": { - "smithy.api#documentation": "

The metrics for the TopicIR.

" - } - }, - "GroupByList": { - "target": "com.amazonaws.quicksight#TopicIRGroupByList", - "traits": { - "smithy.api#documentation": "

The GroupBy list for the TopicIR.

" - } - }, - "Filters": { - "target": "com.amazonaws.quicksight#TopicIRFilterList", - "traits": { - "smithy.api#documentation": "

The filters for the TopicIR.

" - } - }, - "Sort": { - "target": "com.amazonaws.quicksight#TopicSortClause", - "traits": { - "smithy.api#documentation": "

The sort for the TopicIR.

" - } - }, - "ContributionAnalysis": { - "target": "com.amazonaws.quicksight#TopicIRContributionAnalysis", - "traits": { - "smithy.api#documentation": "

The contribution analysis for the TopicIR.

" - } - }, - "Visual": { - "target": "com.amazonaws.quicksight#VisualOptions", - "traits": { - "smithy.api#documentation": "

The visual for the TopicIR.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIR.

" - } - }, - "com.amazonaws.quicksight#TopicIRComparisonMethod": { - "type": "structure", - "members": { - "Type": { - "target": "com.amazonaws.quicksight#ComparisonMethodType", - "traits": { - "smithy.api#documentation": "

The type for the TopicIRComparisonMethod.

" - } - }, - "Period": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The period for the TopicIRComparisonMethod.

" - } - }, - "WindowSize": { - "target": "com.amazonaws.quicksight#Integer", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The window size for the TopicIRComparisonMethod.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition of a TopicIRComparisonMethod.

" - } - }, - "com.amazonaws.quicksight#TopicIRContributionAnalysis": { - "type": "structure", - "members": { - "Factors": { - "target": "com.amazonaws.quicksight#ContributionAnalysisFactorsList", - "traits": { - "smithy.api#documentation": "

The factors for a TopicIRContributionAnalysis.

" - } - }, - "TimeRanges": { - "target": "com.amazonaws.quicksight#ContributionAnalysisTimeRanges", - "traits": { - "smithy.api#documentation": "

The time ranges for the TopicIRContributionAnalysis.

" - } - }, - "Direction": { - "target": "com.amazonaws.quicksight#ContributionAnalysisDirection", - "traits": { - "smithy.api#documentation": "

The direction for the TopicIRContributionAnalysis.

" - } - }, - "SortType": { - "target": "com.amazonaws.quicksight#ContributionAnalysisSortType", - "traits": { - "smithy.api#documentation": "

The sort type for the TopicIRContributionAnalysis.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRContributionAnalysis.

" - } - }, - "com.amazonaws.quicksight#TopicIRFilterEntry": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRFilterOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterFunction": { - "type": "enum", - "members": { - "CONTAINS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS" - } - }, - "EXACT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXACT" - } - }, - "STARTS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STARTS_WITH" - } - }, - "ENDS_WITH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENDS_WITH" - } - }, - "CONTAINS_STRING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CONTAINS_STRING" - } - }, - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRFilterEntry" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRFilterOption": { - "type": "structure", - "members": { - "FilterType": { - "target": "com.amazonaws.quicksight#TopicIRFilterType", - "traits": { - "smithy.api#documentation": "

The filter type for the TopicIRFilterOption.

" - } - }, - "FilterClass": { - "target": "com.amazonaws.quicksight#FilterClass", - "traits": { - "smithy.api#documentation": "

The filter class for the TopicIRFilterOption.

" - } - }, - "OperandField": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The operand field for the TopicIRFilterOption.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#TopicIRFilterFunction", - "traits": { - "smithy.api#documentation": "

The function for the TopicIRFilterOption.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The constant for the TopicIRFilterOption.

" - } - }, - "Inverse": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The inverse for the TopicIRFilterOption.

" - } - }, - "NullFilter": { - "target": "com.amazonaws.quicksight#NullFilterOption", - "traits": { - "smithy.api#documentation": "

The null filter for the TopicIRFilterOption.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#AggType", - "traits": { - "smithy.api#documentation": "

The aggregation for the TopicIRFilterOption.

" - } - }, - "AggregationFunctionParameters": { - "target": "com.amazonaws.quicksight#AggFunctionParamMap", - "traits": { - "smithy.api#documentation": "

The aggregation function parameters for the TopicIRFilterOption.

" - } - }, - "AggregationPartitionBy": { - "target": "com.amazonaws.quicksight#AggregationPartitionByList", - "traits": { - "smithy.api#documentation": "

The AggregationPartitionBy for the TopicIRFilterOption.

" - } - }, - "Range": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The range for the TopicIRFilterOption.

" - } - }, - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The inclusive for the TopicIRFilterOption.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity for the TopicIRFilterOption.

" - } - }, - "LastNextOffset": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The last next offset for the TopicIRFilterOption.

" - } - }, - "AggMetrics": { - "target": "com.amazonaws.quicksight#FilterAggMetricsList", - "traits": { - "smithy.api#documentation": "

The agg metrics for the TopicIRFilterOption.

" - } - }, - "TopBottomLimit": { - "target": "com.amazonaws.quicksight#TopicConstantValue", - "traits": { - "smithy.api#documentation": "

The TopBottomLimit for the TopicIRFilterOption.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for the TopicIRFilterOption.

" - } - }, - "Anchor": { - "target": "com.amazonaws.quicksight#Anchor", - "traits": { - "smithy.api#documentation": "

The anchor for the TopicIRFilterOption.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRFilterOption.

" - } - }, - "com.amazonaws.quicksight#TopicIRFilterType": { - "type": "enum", - "members": { - "CATEGORY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CATEGORY_FILTER" - } - }, - "NUMERIC_EQUALITY_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" - } - }, - "NUMERIC_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" - } - }, - "DATE_RANGE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATE_RANGE_FILTER" - } - }, - "RELATIVE_DATE_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RELATIVE_DATE_FILTER" - } - }, - "TOP_BOTTOM_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP_BOTTOM_FILTER" - } - }, - "EQUALS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EQUALS" - } - }, - "RANK_LIMIT_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RANK_LIMIT_FILTER" - } - }, - "ACCEPT_ALL_FILTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ACCEPT_ALL_FILTER" - } - } - } - }, - "com.amazonaws.quicksight#TopicIRGroupBy": { - "type": "structure", - "members": { - "FieldName": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The field name for the TopicIRGroupBy.

" - } - }, - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The time granularity for the TopicIRGroupBy.

" - } - }, - "Sort": { - "target": "com.amazonaws.quicksight#TopicSortClause", - "traits": { - "smithy.api#documentation": "

The sort for the TopicIRGroupBy.

" - } - }, - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format for the TopicIRGroupBy.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions" - }, - "NamedEntity": { - "target": "com.amazonaws.quicksight#NamedEntityRef", - "traits": { - "smithy.api#documentation": "

The named entity for the TopicIRGroupBy.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRGroupBy.

" - } - }, - "com.amazonaws.quicksight#TopicIRGroupByList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRGroupBy" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicIRMetric": { - "type": "structure", - "members": { - "MetricId": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The metric ID for the TopicIRMetric.

" - } - }, - "Function": { - "target": "com.amazonaws.quicksight#AggFunction", - "traits": { - "smithy.api#documentation": "

The function for the TopicIRMetric.

" - } - }, - "Operands": { - "target": "com.amazonaws.quicksight#OperandList", - "traits": { - "smithy.api#documentation": "

The operands for the TopicIRMetric.

" - } - }, - "ComparisonMethod": { - "target": "com.amazonaws.quicksight#TopicIRComparisonMethod", - "traits": { - "smithy.api#documentation": "

The comparison method for the TopicIRMetric.

" - } - }, - "Expression": { - "target": "com.amazonaws.quicksight#Expression", - "traits": { - "smithy.api#documentation": "

The expression for the TopicIRMetric.

" - } - }, - "CalculatedFieldReferences": { - "target": "com.amazonaws.quicksight#CalculatedFieldReferenceList", - "traits": { - "smithy.api#documentation": "

The calculated field references for the TopicIRMetric.

" - } - }, - "DisplayFormat": { - "target": "com.amazonaws.quicksight#DisplayFormat", - "traits": { - "smithy.api#documentation": "

The display format for the TopicIRMetric.

" - } - }, - "DisplayFormatOptions": { - "target": "com.amazonaws.quicksight#DisplayFormatOptions" - }, - "NamedEntity": { - "target": "com.amazonaws.quicksight#NamedEntityRef", - "traits": { - "smithy.api#documentation": "

The named entity for the TopicIRMetric.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicIRMetric.

" - } - }, - "com.amazonaws.quicksight#TopicIRMetricList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicIRMetric" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 2000 - } - } - }, - "com.amazonaws.quicksight#TopicId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 256 - }, - "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" - } - }, - "com.amazonaws.quicksight#TopicNamedEntities": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicNamedEntity" - } - }, - "com.amazonaws.quicksight#TopicNamedEntity": { - "type": "structure", - "members": { - "EntityName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the named entity.

", - "smithy.api#required": {} - } - }, - "EntityDescription": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The description of the named entity.

" - } - }, - "EntitySynonyms": { - "target": "com.amazonaws.quicksight#Synonyms", - "traits": { - "smithy.api#documentation": "

The other\n names or aliases for the named entity.

" - } - }, - "SemanticEntityType": { - "target": "com.amazonaws.quicksight#SemanticEntityType", - "traits": { - "smithy.api#documentation": "

The type of named entity that a topic represents.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#NamedEntityDefinitions", - "traits": { - "smithy.api#documentation": "

The definition of a named entity.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a named entity.

" - } - }, - "com.amazonaws.quicksight#TopicNumericEqualityFilter": { - "type": "structure", - "members": { - "Constant": { - "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a numeric equality filter.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedFilterAggType", - "traits": { - "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic. Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

" - } - }, - "com.amazonaws.quicksight#TopicNumericRangeFilter": { - "type": "structure", - "members": { - "Inclusive": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\n If set to true, topics whose numeric field value is equal to the endpoint values will be\n included in the filter. If set to false, topics whose numeric field value is equal to the\n endpoint values will be excluded from the filter.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a\n numeric range filter.

" - } - }, - "Aggregation": { - "target": "com.amazonaws.quicksight#NamedFilterAggType", - "traits": { - "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic, Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

" - } - }, - "com.amazonaws.quicksight#TopicNumericSeparatorSymbol": { - "type": "enum", - "members": { - "COMMA": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMMA" - } - }, - "DOT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DOT" - } - } - } - }, - "com.amazonaws.quicksight#TopicRangeFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

" - } - }, - "RangeConstant": { - "target": "com.amazonaws.quicksight#RangeConstant", - "traits": { - "smithy.api#documentation": "

The value of the constant that is used to specify the endpoints of a range filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A constant value that is used in a range filter to specify the endpoints of the range.

", - "smithy.api#sensitive": {} - } - }, - "com.amazonaws.quicksight#TopicRefreshDetails": { - "type": "structure", - "members": { - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RefreshId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the refresh, which occurs as a result of topic creation or topic update.

" - } - }, - "RefreshStatus": { - "target": "com.amazonaws.quicksight#TopicRefreshStatus", - "traits": { - "smithy.api#documentation": "

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The details about the refresh of a topic.

" - } - }, - "com.amazonaws.quicksight#TopicRefreshSchedule": { - "type": "structure", - "members": { - "IsEnabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A Boolean value that controls whether to schedule is enabled.

", - "smithy.api#required": {} - } - }, - "BasedOnSpiceSchedule": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that controls whether to schedule runs at the same schedule that is specified in\n SPICE dataset.

", - "smithy.api#required": {} - } - }, - "StartingAt": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The starting date and time for the refresh schedule.

" - } - }, - "Timezone": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The timezone that you want the refresh schedule to use.

" - } - }, - "RepeatAt": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The time of day when the refresh should run, for\n example, Monday-Sunday.

" - } - }, - "TopicScheduleType": { - "target": "com.amazonaws.quicksight#TopicScheduleType", - "traits": { - "smithy.api#documentation": "

The type of refresh schedule. Valid values for this structure are HOURLY,\n DAILY,\n WEEKLY,\n and MONTHLY.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a topic refresh schedule.

" - } - }, - "com.amazonaws.quicksight#TopicRefreshScheduleSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummary" - } + "smithy": "2.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.quicksight#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have access to this item. The provided credentials couldn't be\n\t\t\tvalidated. You might not be authorized to carry out the request. Make sure that your\n\t\t\taccount is authorized to use the Amazon QuickSight service, that your policies have the\n\t\t\tcorrect permissions, and that you are using the correct credentials.

", + "smithy.api#error": "client", + "smithy.api#httpError": 401 + } + }, + "com.amazonaws.quicksight#AccountCustomization": { + "type": "structure", + "members": { + "DefaultTheme": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The default theme for this Amazon QuickSight subscription.

" + } + }, + "DefaultEmailCustomizationTemplate": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The default email customization template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.

" + } + }, + "com.amazonaws.quicksight#AccountInfo": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The account name that you provided for the Amazon QuickSight subscription in your\n 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\n users sign in.

" + } + }, + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of your Amazon QuickSight account.

" + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

" + } + }, + "AuthenticationType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The way that your Amazon QuickSight account is authenticated.

" + } + }, + "AccountSubscriptionStatus": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The status of your account subscription.

" + } + }, + "IAMIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the following account information\n elements:

\n " + } + }, + "com.amazonaws.quicksight#AccountName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 62 + }, + "smithy.api#pattern": "^(?!D-|d-)([\\da-zA-Z]+)([-]*[\\da-zA-Z])*$" + } + }, + "com.amazonaws.quicksight#AccountSettings": { + "type": "structure", + "members": { + "AccountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The \"account name\" you provided for the Amazon QuickSight subscription in your Amazon Web Services account.\n You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and\n it appears only when users sign in.

" + } + }, + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of Amazon QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.

" + } + }, + "DefaultNamespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The default Amazon QuickSight namespace for your Amazon Web Services account.

" + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The main notification email for your Amazon QuickSight subscription.

" + } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight settings associated with your Amazon Web Services account.

" + } + }, + "com.amazonaws.quicksight#ActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#ActiveIAMPolicyAssignment": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

A name for the IAM policy assignment.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The active Identity and Access Management (IAM) policy assignment.

" + } + }, + "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignment" + } + }, + "com.amazonaws.quicksight#AdHocFilteringOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An ad hoc (one-time) filtering option.

" + } + }, + "com.amazonaws.quicksight#AdditionalDashboardIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#AggFunction": { + "type": "structure", + "members": { + "Aggregation": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The aggregation of an Agg function.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggFunctionParamMap", + "traits": { + "smithy.api#documentation": "

The aggregation parameters for an Agg function.

" + } + }, + "Period": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The period of an Agg function.

" + } + }, + "PeriodField": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The period field for an Agg function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an Agg function.

" + } + }, + "com.amazonaws.quicksight#AggFunctionParamKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#AggFunctionParamMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#AggFunctionParamKey" + }, + "value": { + "target": "com.amazonaws.quicksight#AggFunctionParamValue" + } + }, + "com.amazonaws.quicksight#AggFunctionParamValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#AggType": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "PTD_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_SUM" + } + }, + "PTD_MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_MIN" + } + }, + "PTD_MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_MAX" + } + }, + "PTD_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_COUNT" + } + }, + "PTD_DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_DISTINCT_COUNT" + } + }, + "PTD_AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PTD_AVERAGE" + } + }, + "COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#AggregationFunction": { + "type": "structure", + "members": { + "NumericalAggregationFunction": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for numerical values.

" + } + }, + "CategoricalAggregationFunction": { + "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for categorical values.

\n " + } + }, + "DateAggregationFunction": { + "target": "com.amazonaws.quicksight#DateAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for date values.

\n " + } + }, + "AttributeAggregationFunction": { + "target": "com.amazonaws.quicksight#AttributeAggregationFunction", + "traits": { + "smithy.api#documentation": "

Aggregation for attributes.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation function aggregates values from a dimension or measure.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AggregationFunctionParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#AggregationPartitionBy": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The field Name for an AggregationPartitionBy.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The TimeGranularity for an AggregationPartitionBy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an AggregationPartitionBy.

" + } + }, + "com.amazonaws.quicksight#AggregationPartitionByList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AggregationPartitionBy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AggregationSortConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that determines the sort order of aggregated values.

", + "smithy.api#required": {} + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction of values.

\n ", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The function that aggregates the values in Column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration options to sort aggregated values.

" + } + }, + "com.amazonaws.quicksight#AggregationSortConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AggregationSortConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AliasName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" + } + }, + "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

An empty object that represents that the AllSheets option is the chosen value for the FilterScopeConfiguration parameter. This structure applies the filter to all visuals on all sheets of an Analysis, Dashboard, or Template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AmazonElasticsearchParameters": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.quicksight#Domain", + "traits": { + "smithy.api#documentation": "

The OpenSearch domain.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "com.amazonaws.quicksight#AmazonOpenSearchParameters": { + "type": "structure", + "members": { + "Domain": { + "target": "com.amazonaws.quicksight#Domain", + "traits": { + "smithy.api#documentation": "

The OpenSearch domain.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "com.amazonaws.quicksight#Analysis": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the analysis.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the analysis.

" + } + }, + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", + "traits": { + "smithy.api#documentation": "

The ARNs of the datasets of the analysis.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the analysis.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was last updated.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata structure for an analysis in Amazon QuickSight

" + } + }, + "com.amazonaws.quicksight#AnalysisDefaults": { + "type": "structure", + "members": { + "DefaultNewSheetConfiguration": { + "target": "com.amazonaws.quicksight#DefaultNewSheetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for default new sheet settings.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for default analysis settings.

" + } + }, + "com.amazonaws.quicksight#AnalysisDefinition": { + "type": "structure", + "members": { + "DataSetIdentifierDeclarations": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead\n of dataset ARNs throughout analysis sub-structures.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about\n a sheet within this analysis.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the analysis.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of parameter declarations for an analysis.

\n

Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

Filter definitions for an analysis.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

\n An array of analysis-level column configurations. Column configurations can be used to set default\n formatting for a column to be used throughout an analysis.\n

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for an analysis.

" + } + }, + "QueryExecutionOptions": { + "target": "com.amazonaws.quicksight#QueryExecutionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#AnalysisErrorType", + "traits": { + "smithy.api#documentation": "

The type of the analysis error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The message associated with the analysis error.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

Lists the violated entities that caused the analysis error

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Analysis error.

" + } + }, + "com.amazonaws.quicksight#AnalysisErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisErrorType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "PARAMETER_VALUE_INCOMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" + } + }, + "PARAMETER_TYPE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" + } + }, + "PARAMETER_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_NOT_FOUND" + } + }, + "COLUMN_TYPE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" + } + }, + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + } + }, + "COLUMN_REPLACEMENT_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" + } + } + } + }, + "com.amazonaws.quicksight#AnalysisFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "ANALYSIS_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS_NAME" + } + } + } + }, + "com.amazonaws.quicksight#AnalysisName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"ANALYSIS_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value ANALYSIS_NAME.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example \"Value\". An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for one or more analyses.

" + } + }, + "com.amazonaws.quicksight#AnalysisSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AnalysisSourceEntity": { + "type": "structure", + "members": { + "SourceTemplate": { + "target": "com.amazonaws.quicksight#AnalysisSourceTemplate", + "traits": { + "smithy.api#documentation": "

The source template for the source entity of the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source entity of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSourceTemplate": { + "type": "structure", + "members": { + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

The dataset references of the source template of an analysis.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the source template of an analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source template of an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis. This ID displays in the URL.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The name of the analysis. This name is displayed in the Amazon QuickSight console.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The last known status for the analysis.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the analysis was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary metadata that describes an analysis.

" + } + }, + "com.amazonaws.quicksight#AnalysisSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnalysisSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#Anchor": { + "type": "structure", + "members": { + "AnchorType": { + "target": "com.amazonaws.quicksight#AnchorType", + "traits": { + "smithy.api#documentation": "

The AnchorType for the Anchor.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The TimeGranularity of the Anchor.

" + } + }, + "Offset": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The offset of the Anchor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of the Anchor.

" + } + }, + "com.amazonaws.quicksight#AnchorDateConfiguration": { + "type": "structure", + "members": { + "AnchorOption": { + "target": "com.amazonaws.quicksight#AnchorOption", + "traits": { + "smithy.api#documentation": "

The options for the date configuration. Choose one of the options below:

\n " + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is used for the anchor date configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The date configuration of the filter.

" + } + }, + "com.amazonaws.quicksight#AnchorOption": { + "type": "enum", + "members": { + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#AnchorType": { + "type": "enum", + "members": { + "TODAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TODAY" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + }, + "EnabledFeatures": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures", + "traits": { + "smithy.api#documentation": "

A list of all enabled features of a specified anonymous dashboard.

" + } + }, + "DisabledFeatures": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures", + "traits": { + "smithy.api#documentation": "

A list of all disabled features of a specified anonymous dashboard.

" + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the dashboard that you want to embed.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature": { + "type": "enum", + "members": { + "SHARED_VIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_VIEW" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationDisabledFeature" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature": { + "type": "enum", + "members": { + "SHARED_VIEW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED_VIEW" + } + } + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeatures": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfigurationEnabledFeature" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardFeatureConfigurations": { + "type": "structure", + "members": { + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight dashboards.

" + } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#AnonymousUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } + }, + "QSearchBar": { + "target": "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The Q search bar that you want to use for anonymous user embedding.

" + } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The Generative Q&A experience that you want to use for anonymous user embedding.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of experience you want to embed. For anonymous users, you can embed Amazon QuickSight dashboards.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the new reader experience 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 Generative Q&A experience with this new reader experience topic pre selected.

\n

The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings that you want to use for the Generative Q&A experience.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserQSearchBarEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight Q topic ID of the legacy 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 legacy topic pre-selected.

\n

The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings that you want to use with the Q search bar.

" + } + }, + "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult": { + "type": "structure", + "members": { + "FileGroups": { + "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroupList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the file groups that are requested for the artifact generation in a StartDashboardSnapshotJob API call.\n

" + } + }, + "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResult" + } + }, + "com.amazonaws.quicksight#AnswerId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" + } + }, + "com.amazonaws.quicksight#AnswerIds": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AnswerId" + } + }, + "com.amazonaws.quicksight#ArcAxisConfiguration": { + "type": "structure", + "members": { + "Range": { + "target": "com.amazonaws.quicksight#ArcAxisDisplayRange", + "traits": { + "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" + } + }, + "ReserveRange": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The reserved range of the arc axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcAxisDisplayRange": { + "type": "structure", + "members": { + "Min": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The minimum value of the arc axis range.

" + } + }, + "Max": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum value of the arc axis range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc axis range of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcConfiguration": { + "type": "structure", + "members": { + "ArcAngle": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The option that determines the arc angle of a GaugeChartVisual.

" + } + }, + "ArcThickness": { + "target": "com.amazonaws.quicksight#ArcThicknessOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcOptions": { + "type": "structure", + "members": { + "ArcThickness": { + "target": "com.amazonaws.quicksight#ArcThickness", + "traits": { + "smithy.api#documentation": "

The arc thickness of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the arc thickness of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#ArcThickness": { + "type": "enum", + "members": { + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + }, + "WHOLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WHOLE" + } + } + } + }, + "com.amazonaws.quicksight#ArcThicknessOptions": { + "type": "enum", + "members": { + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + } + } + }, + "com.amazonaws.quicksight#Arn": { + "type": "string" + }, + "com.amazonaws.quicksight#ArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + } + }, + "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration": { + "type": "structure", + "members": { + "ResourceIdOverrideConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.

" + } + }, + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList", + "traits": { + "smithy.api#documentation": "

An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional collection of CloudFormation property configurations that control how the export job is generated.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportFormat": { + "type": "enum", + "members": { + "CLOUDFORMATION_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLOUDFORMATION_JSON" + } + }, + "QUICKSIGHT_JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_JSON" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Analysis resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Analysis resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Analysis resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobAnalysisPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Dashboard resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Dashboard resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDashboardPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific DataSet resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of DataSet resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific DataSet resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSetPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific DataSource resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of DataSource resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific DataSource resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourceOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "DISABLE_SSL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DisableSsl" + } + }, + "SECRET_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SecretArn" + } + }, + "USERNAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Username" + } + }, + "PASSWORD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Password" + } + }, + "DOMAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Domain" + } + }, + "WORK_GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WorkGroup" + } + }, + "HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Host" + } + }, + "PORT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Port" + } + }, + "DATABASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Database" + } + }, + "DATA_SET_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DataSetName" + } + }, + "CATALOG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Catalog" + } + }, + "INSTANCE_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "InstanceId" + } + }, + "CLUSTER_ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ClusterId" + } + }, + "MANIFEST_FILE_LOCATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ManifestFileLocation" + } + }, + "WAREHOUSE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Warehouse" + } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RoleArn" + } + }, + "PRODUCT_TYPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ProductType" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobDataSourcePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobError": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific error type of the error that occurred.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred during an Asset Bundle export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobError" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific RefreshSchedule resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshScheduleOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride": { + "type": "enum", + "members": { + "START_AFTER_DATE_TIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartAfterDateTime" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobRefreshSchedulePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobResourceIdOverrideConfiguration": { + "type": "structure", + "members": { + "PrefixForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobStatus": { + "type": "enum", + "members": { + "QUEUED_FOR_IMMEDIATE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobSummary": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the export job.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the export job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the export job was created.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the export job.

" + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of resource dependencies in the returned asset bundle.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The format for the export job.

" + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of permissions associated with each resource ARN.

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The flag that determines the inclusion of tags associated with each resource ARN.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the export job that includes details of the job's configuration and its current status.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobSummary" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific Theme resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of Theme resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific Theme resource is parameterized in the returned CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemeOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemeOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobThemePropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the specific VPCConnection resource whose override properties are configured in this structure.

", + "smithy.api#required": {} + } + }, + "Properties": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList", + "traits": { + "smithy.api#documentation": "

A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Controls how a specific VPCConnection resource is parameterized in the outputted CloudFormation template.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverridePropertiesList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionOverrideProperties" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride": { + "type": "enum", + "members": { + "NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "Name" + } + }, + "DNS_RESOLVERS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DnsResolvers" + } + }, + "ROLE_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RoleArn" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverrideList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobVPCConnectionPropertyToOverride" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to export resources under strict or lenient mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option to relax the validation that is required to export each asset. When StrictModeForAllResource is set to false, validation is skipped for specific UI errors.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobWarning": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused a warning.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the warning.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle export job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleExportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarning" + } + }, + "com.amazonaws.quicksight#AssetBundleImportBodyBlob": { + "type": "blob", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20971520 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#AssetBundleImportFailureAction": { + "type": "enum", + "members": { + "DO_NOTHING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOTHING" + } + }, + "ROLLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROLLBACK" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you ant to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single analysis that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the analyses that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of analysis IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags": { + "type": "structure", + "members": { + "AnalysisIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the analyses that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of analysis IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you want to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single dashboard that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the dashboards that you want to apply overrides to.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the link sharing configurations that you want to apply overrides to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dashboard IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags": { + "type": "structure", + "members": { + "DashboardIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the dashboards that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dashboard IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single dataset that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the datasets that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of dataset IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags": { + "type": "structure", + "members": { + "DataSetIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the datasets that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of dataset IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.quicksight#DbUsername", + "traits": { + "smithy.api#documentation": "

The username for the data source connection.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.quicksight#Password", + "traits": { + "smithy.api#documentation": "

The password for the data source connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A username and password credential pair to use to import a data source resource.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials": { + "type": "structure", + "members": { + "CredentialPair": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentialPair", + "traits": { + "smithy.api#documentation": "

A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The login credentials to use to import a data source resource.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters": { + "type": "structure", + "members": { + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the data source.

" + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters" + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties" + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties" + }, + "Credentials": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceCredentials", + "traits": { + "smithy.api#documentation": "

An optional structure that provides the credentials to be used to create the imported data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single data source that is being imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the data source that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of data source IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags": { + "type": "structure", + "members": { + "DataSourceIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the data source that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of data source IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobError": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource whose processing caused an error.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The specific error type or the error that occurred.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes an error that occurred within an Asset Bundle import execution.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobError" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters": { + "type": "structure", + "members": { + "ResourceIdOverrideConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration", + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides to be applied within the import job.

" + } + }, + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideParametersList", + "traits": { + "smithy.api#documentation": "

A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of overrides that modify the asset bundle resource configuration before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverridePermissionsList", + "traits": { + "smithy.api#documentation": "

A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the override permission configurations that modify the permissions for specified resources before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags": { + "type": "structure", + "members": { + "VPCConnections": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.

" + } + }, + "DataSources": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSourceOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDataSetOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.

" + } + }, + "Themes": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.

" + } + }, + "Analyses": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobAnalysisOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.

" + } + }, + "Dashboards": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobDashboardOverrideTagsList", + "traits": { + "smithy.api#documentation": "

A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the override tag configuration that modify the tags that are assigned to specified resources before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy": { + "type": "structure", + "members": { + "StrictModeForAllResources": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional parameter that overrides the validation strategy for all analyses and dashboards before the resource is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.

", + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.

", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

An override for the StartAfterDateTime of a RefreshSchedule. Make\n sure that the StartAfterDateTime is set to a time that takes\n place in the future.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of overrides for a specific RefreshsSchedule resource that is present in the asset bundle that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobRefreshScheduleOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobResourceIdOverrideConfiguration": { + "type": "structure", + "members": { + "PrefixForAllResources": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that configures resource ID overrides for the import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobStatus": { + "type": "enum", + "members": { + "QUEUED_FOR_IMMEDIATE_EXECUTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED_FOR_IMMEDIATE_EXECUTION" + } + }, + "IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IN_PROGRESS" + } + }, + "SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUCCESSFUL" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "FAILED_ROLLBACK_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_IN_PROGRESS" + } + }, + "FAILED_ROLLBACK_COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_COMPLETED" + } + }, + "FAILED_ROLLBACK_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED_ROLLBACK_ERROR" + } + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobSummary": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", + "traits": { + "smithy.api#documentation": "

The current status of the import job.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the import job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the import job was created.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the import job that includes details of the requested job's configuration and its current status.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobSummary" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the theme.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single theme that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of permissions for the themes that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of permissions to be applied to a list of theme IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverridePermissions" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags": { + "type": "structure", + "members": { + "ThemeIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the themes that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of theme IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobThemeOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC Connection to apply overrides to.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A new name for the VPC connection.

" + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of new subnet IDs for the VPC connection you are importing. This field is\n required if you are importing the VPC connection from another Amazon Web Services account or Region.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A new security group ID for the VPC connection you are importing. This field is required\n if you are importing the VPC connection from another Amazon Web Services account or Region.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

An optional override of DNS resolvers to be used by the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

An optional override of the role ARN to be used by the VPC connection.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The override parameters for a single VPC connection that is imported.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags": { + "type": "structure", + "members": { + "VPCConnectionIds": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList", + "traits": { + "smithy.api#documentation": "

A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of tags for the VPC connections that you want to apply overrides to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains a list of tags to be assigned to a list of VPC connection IDs.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTagsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobVPCConnectionOverrideTags" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobWarning": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the resource that the warning occurred for.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A description of the warning that occurred during an Asset Bundle import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes a warning that occurred during an Asset Bundle import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportJobWarningList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarning" + } + }, + "com.amazonaws.quicksight#AssetBundleImportSource": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.quicksight#AssetBundleImportBodyBlob", + "traits": { + "smithy.api#documentation": "

The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB.

\n

If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or\n PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using\n an SDK for a different language or receiving related errors, try to base64 encode your data.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller\n has read access to. The file must be a zip format file and can't exceed 20 MB.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.

" + } + }, + "com.amazonaws.quicksight#AssetBundleImportSourceDescription": { + "type": "structure", + "members": { + "Body": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#S3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 URI that you provided at the start of the import job.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A description of the import source that you provide at the start of an import job. This value is set to either Body or S3Uri, depending on how the StartAssetBundleImportJobRequest is configured.

" + } + }, + "com.amazonaws.quicksight#AssetBundlePrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Principal" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#AssetBundleResourceArns": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AssetBundleResourceLinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#AssetBundleResourcePermissions", + "traits": { + "smithy.api#documentation": "

A list of link sharing permissions for the dashboards that you want to apply overrides to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shared link to an Amazon QuickSight dashboard.

" + } + }, + "com.amazonaws.quicksight#AssetBundleResourcePermissions": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#AssetBundlePrincipalList", + "traits": { + "smithy.api#documentation": "

A list of principals to grant permissions on.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", + "traits": { + "smithy.api#documentation": "

A list of IAM actions to grant permissions on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions for the resource that you want to override in an asset bundle import job.

" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^\\*|[\\w\\-]{1,2048}$" + } + }, + "com.amazonaws.quicksight#AssetBundleRestrictiveResourceIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AssetBundleRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#AssetOptions": { + "type": "structure", + "members": { + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Determines the timezone for the analysis.

" + } + }, + "WeekStart": { + "target": "com.amazonaws.quicksight#DayOfTheWeek", + "traits": { + "smithy.api#documentation": "

Determines the week start day for an analysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An array of analysis level configurations.

" + } + }, + "com.amazonaws.quicksight#AssignmentStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DRAFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DRAFT" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#AthenaParameters": { + "type": "structure", + "members": { + "WorkGroup": { + "target": "com.amazonaws.quicksight#WorkGroup", + "traits": { + "smithy.api#documentation": "

The workgroup that Amazon Athena uses.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Athena.

" + } + }, + "com.amazonaws.quicksight#AttributeAggregationFunction": { + "type": "structure", + "members": { + "SimpleAttributeAggregation": { + "target": "com.amazonaws.quicksight#SimpleAttributeAggregationFunction", + "traits": { + "smithy.api#documentation": "

The built-in aggregation functions for attributes.

\n " + } + }, + "ValueForMultipleValues": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregation for attributes.

" + } + }, + "com.amazonaws.quicksight#AuroraParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Aurora.

" + } + }, + "com.amazonaws.quicksight#AuroraPostgreSqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The Amazon Aurora PostgreSQL-Compatible host to connect to.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port that Amazon Aurora PostgreSQL is listening on.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

The Amazon Aurora PostgreSQL database to connect to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Parameters for Amazon Aurora PostgreSQL-Compatible Edition.

" + } + }, + "com.amazonaws.quicksight#AuthenticationMethodOption": { + "type": "enum", + "members": { + "IAM_AND_QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_AND_QUICKSIGHT" + } + }, + "IAM_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ONLY" + } + }, + "ACTIVE_DIRECTORY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTIVE_DIRECTORY" + } + }, + "IAM_IDENTITY_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_IDENTITY_CENTER" + } + } + } + }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregation": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + } + } + }, + "com.amazonaws.quicksight#AuthorSpecifiedAggregations": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregation" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsByService": { + "type": "structure", + "members": { + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service.

" + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsList", + "traits": { + "smithy.api#documentation": "

Aist of authorized targets that are represented by IAM Identity Center application ARNs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The authorized targets that are associated with a service.

" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsByServices": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsByService" + } + }, + "com.amazonaws.quicksight#AuthorizedTargetsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#AwsAccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 12, + "max": 12 + }, + "smithy.api#pattern": "^[0-9]{12}$" + } + }, + "com.amazonaws.quicksight#AwsAndAccountId": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(aws|[0-9]{12})$" + } + }, + "com.amazonaws.quicksight#AwsIotAnalyticsParameters": { + "type": "structure", + "members": { + "DataSetName": { + "target": "com.amazonaws.quicksight#DataSetName", + "traits": { + "smithy.api#documentation": "

Dataset name.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for IoT Analytics.

" + } + }, + "com.amazonaws.quicksight#AxisBinding": { + "type": "enum", + "members": { + "PRIMARY_YAXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_YAXIS" + } + }, + "SECONDARY_YAXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECONDARY_YAXIS" + } + } + } + }, + "com.amazonaws.quicksight#AxisDataOptions": { + "type": "structure", + "members": { + "NumericAxisOptions": { + "target": "com.amazonaws.quicksight#NumericAxisOptions", + "traits": { + "smithy.api#documentation": "

The options for an axis with a numeric field.

" + } + }, + "DateAxisOptions": { + "target": "com.amazonaws.quicksight#DateAxisOptions", + "traits": { + "smithy.api#documentation": "

The options for an axis with a date field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data options for an axis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayDataDrivenRange": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#documentation": "

The options that are saved for future extension.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayMinMaxRange": { + "type": "structure", + "members": { + "Minimum": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The minimum setup for an axis display range.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum setup for an axis display range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum and maximum setup for an axis display range.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayOptions": { + "type": "structure", + "members": { + "TickLabelOptions": { + "target": "com.amazonaws.quicksight#AxisTickLabelOptions", + "traits": { + "smithy.api#documentation": "

The tick label options of an axis.

" + } + }, + "AxisLineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the axis line is visible.

" + } + }, + "GridLineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the grid line is visible.

" + } + }, + "DataOptions": { + "target": "com.amazonaws.quicksight#AxisDataOptions", + "traits": { + "smithy.api#documentation": "

The data options for an axis.

" + } + }, + "ScrollbarOptions": { + "target": "com.amazonaws.quicksight#ScrollBarOptions", + "traits": { + "smithy.api#documentation": "

The scroll bar options for an axis.

" + } + }, + "AxisOffset": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The offset value that determines the starting placement of the axis within a visual's bounds.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the axis label.

" + } + }, + "com.amazonaws.quicksight#AxisDisplayRange": { + "type": "structure", + "members": { + "MinMax": { + "target": "com.amazonaws.quicksight#AxisDisplayMinMaxRange", + "traits": { + "smithy.api#documentation": "

The minimum and maximum setup of an axis display range.

" + } + }, + "DataDriven": { + "target": "com.amazonaws.quicksight#AxisDisplayDataDrivenRange", + "traits": { + "smithy.api#documentation": "

The data-driven setup of an axis display range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range setup of a numeric axis display range.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisLabelOptions": { + "type": "structure", + "members": { + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the axis label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The text for the axis label.

" + } + }, + "ApplyTo": { + "target": "com.amazonaws.quicksight#AxisLabelReferenceOptions", + "traits": { + "smithy.api#documentation": "

The options that indicate which field the label belongs to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options for a chart axis. You must specify the field that the label is targeted to.

" + } + }, + "com.amazonaws.quicksight#AxisLabelOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#AxisLabelOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#AxisLabelReferenceOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field that the axis label is targeted to.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the axis label is targeted to.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference that specifies where the axis label is applied to.

" + } + }, + "com.amazonaws.quicksight#AxisLinearScale": { + "type": "structure", + "members": { + "StepCount": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The step count setup of a linear axis.

" + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The step size setup of a linear axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The liner axis scale setup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisLogarithmicScale": { + "type": "structure", + "members": { + "Base": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The base setup of a logarithmic axis scale.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The logarithmic axis scale setup.

" + } + }, + "com.amazonaws.quicksight#AxisScale": { + "type": "structure", + "members": { + "Linear": { + "target": "com.amazonaws.quicksight#AxisLinearScale", + "traits": { + "smithy.api#documentation": "

The linear axis scale setup.

" + } + }, + "Logarithmic": { + "target": "com.amazonaws.quicksight#AxisLogarithmicScale", + "traits": { + "smithy.api#documentation": "

The logarithmic axis scale setup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scale setup\n options for a numeric axis display.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#AxisTickLabelOptions": { + "type": "structure", + "members": { + "LabelOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

Determines whether or not the axis ticks are visible.

" + } + }, + "RotationAngle": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The rotation angle of the axis tick labels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tick label options of an axis.

" + } + }, + "com.amazonaws.quicksight#BarChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category (y-axis) field well of a bar chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a bar chart. Values are aggregated by\n category.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color (group/color) field well of a bar chart.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a bar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" + } + }, + "com.amazonaws.quicksight#BarChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#BarChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#BarChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a BarChartVisual.

" + } + }, + "Orientation": { + "target": "com.amazonaws.quicksight#BarChartOrientation", + "traits": { + "smithy.api#documentation": "

The orientation of the bars in a bar chart visual. There are two valid values in this structure:

\n " + } + }, + "BarsArrangement": { + "target": "com.amazonaws.quicksight#BarsArrangement", + "traits": { + "smithy.api#documentation": "

Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for bar chart category.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart.

" + } + }, + "ValueAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) for a bar chart value.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a bar chart value.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a BarChartVisual.

" + } + }, + "com.amazonaws.quicksight#BarChartFieldWells": { + "type": "structure", + "members": { + "BarChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#BarChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a bar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a BarChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#BarChartOrientation": { + "type": "enum", + "members": { + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#BarChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories displayed in a bar chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of color fields in a bar chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of values displayed in a bar chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

sort-configuration-description

" + } + }, + "com.amazonaws.quicksight#BarChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#BarChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A bar chart.

\n

The BarChartVisual structure describes a visual that is a member of the bar chart family. The following charts can be described using this structure:

\n \n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#BarsArrangement": { + "type": "enum", + "members": { + "CLUSTERED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTERED" + } + }, + "STACKED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED" + } + }, + "STACKED_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED_PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#BaseMapStyleType": { + "type": "enum", + "members": { + "LIGHT_GRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LIGHT_GRAY" + } + }, + "DARK_GRAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DARK_GRAY" + } + }, + "STREET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STREET" + } + }, + "IMAGERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGERY" + } + } + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates new reviewed answers for a Q Topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-create-reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a reviewed answer in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Answers": { + "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of the Answers to be created.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswerResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "SucceededAnswers": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are successfully created.

" + } + }, + "InvalidAnswers": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are invalid and not created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes reviewed answers for Q Topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/batch-delete-reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete a reviewed answers in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnswerIds": { + "target": "com.amazonaws.quicksight#AnswerIds", + "traits": { + "smithy.api#documentation": "

The Answer IDs of the Answers to be deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswerResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic reviewed answer that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "SucceededAnswers": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are successfully deleted.

" + } + }, + "InvalidAnswers": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of Answers that are invalid and not deleted.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#BigQueryParameters": { + "type": "structure", + "members": { + "ProjectId": { + "target": "com.amazonaws.quicksight#ProjectId", + "traits": { + "smithy.api#documentation": "

The Google Cloud Platform project ID where your datasource was created.

", + "smithy.api#required": {} + } + }, + "DataSetRegion": { + "target": "com.amazonaws.quicksight#DataSetRegion", + "traits": { + "smithy.api#documentation": "

The storage location where you create a Google BigQuery data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" + } + }, + "com.amazonaws.quicksight#BinCountLimit": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#BinCountOptions": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#BinCountValue", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" + } + }, + "com.amazonaws.quicksight#BinCountValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#BinWidthOptions": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#BinWidthValue", + "traits": { + "smithy.api#documentation": "

The options that determine the bin width value.

" + } + }, + "BinCountLimit": { + "target": "com.amazonaws.quicksight#BinCountLimit", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count limit.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" + } + }, + "com.amazonaws.quicksight#BinWidthValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#BodySectionConfiguration": { + "type": "structure", + "members": { + "SectionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a body section.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#BodySectionContent", + "traits": { + "smithy.api#documentation": "

The configuration of content in a body section.

", + "smithy.api#required": {} + } + }, + "Style": { + "target": "com.amazonaws.quicksight#SectionStyle", + "traits": { + "smithy.api#documentation": "

The style options of a body section.

" + } + }, + "PageBreakConfiguration": { + "target": "com.amazonaws.quicksight#SectionPageBreakConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a page break for a section.

" + } + }, + "RepeatConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionRepeatConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a body section.

" + } + }, + "com.amazonaws.quicksight#BodySectionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BodySectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 28 + } + } + }, + "com.amazonaws.quicksight#BodySectionContent": { + "type": "structure", + "members": { + "Layout": { + "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The layout configuration of a body section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of content in a body section.

" + } + }, + "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "

Number of values to use from the column for repetition.

" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Category dataset column and constraints for the dynamic values used to repeat the contents of a section.

" + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnSort" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionLimit", + "traits": { + "smithy.api#documentation": "

Number of values to use from the column for repetition.

" + } + }, + "SortByMetrics": { + "target": "com.amazonaws.quicksight#BodySectionDynamicDimensionSortConfigurationList", + "traits": { + "smithy.api#documentation": "

Sort criteria on the column values that you use for repetition.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the Numeric dataset column and constraints for the dynamic values used to repeat the contents of a section.

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatConfiguration": { + "type": "structure", + "members": { + "DimensionConfigurations": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList", + "traits": { + "smithy.api#documentation": "

List of BodySectionRepeatDimensionConfiguration values that describe the dataset column and constraints for the column used to repeat the contents of a section.

" + } + }, + "PageBreakConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration", + "traits": { + "smithy.api#documentation": "

Page break configuration to apply for each repeating instance.

" + } + }, + "NonRepeatingVisuals": { + "target": "com.amazonaws.quicksight#NonRepeatingVisualsList", + "traits": { + "smithy.api#documentation": "

List of visuals to exclude from repetition in repeating sections. The visuals will render identically, and ignore the repeating configurations in all repeating instances.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configurations that are required to declare a section as repeating.

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration": { + "type": "structure", + "members": { + "DynamicCategoryDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicCategoryDimensionConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the Category dataset column and constraints around the dynamic values that will be used in repeating the section contents.

" + } + }, + "DynamicNumericDimensionConfiguration": { + "target": "com.amazonaws.quicksight#BodySectionDynamicNumericDimensionConfiguration", + "traits": { + "smithy.api#documentation": "

Describes the Numeric dataset column and constraints around the dynamic values used to repeat the contents of a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Describes the dataset column and constraints for the dynamic values used to repeat the contents of a section. The dataset column is either Category or Numeric column configuration

" + } + }, + "com.amazonaws.quicksight#BodySectionRepeatDimensionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#BodySectionRepeatDimensionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#BodySectionRepeatPageBreakConfiguration": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.quicksight#SectionAfterPageBreak" + } + }, + "traits": { + "smithy.api#documentation": "

The page break configuration to apply for each repeating instance.

" + } + }, + "com.amazonaws.quicksight#BookmarksConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that determines whether a user\n can bookmark an embedded dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The bookmarks configuration of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#Boolean": { + "type": "boolean", + "traits": { + "smithy.api#default": false + } + }, + "com.amazonaws.quicksight#BooleanObject": { + "type": "boolean" + }, + "com.amazonaws.quicksight#BorderStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The option to enable display of borders for visuals.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for tile borders for visuals.

" + } + }, + "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#BoxPlotDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a box plot chart. Values are grouped based on group by fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#BoxPlotMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field well of a box plot chart. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for a box plot.

" + } + }, + "com.amazonaws.quicksight#BoxPlotChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#BoxPlotFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#BoxPlotSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" + } + }, + "BoxPlotOptions": { + "target": "com.amazonaws.quicksight#BoxPlotOptions", + "traits": { + "smithy.api#documentation": "

The box plot chart options for a box plot visual

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort Icon visibility) of a box plot category.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a box plot category.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility and sort icon visibility) of a box plot value.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions" + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a BoxPlotVisual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#BoxPlotFieldWells": { + "type": "structure", + "members": { + "BoxPlotAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#BoxPlotAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a BoxPlotVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#BoxPlotFillStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "TRANSPARENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRANSPARENT" + } + } + } + }, + "com.amazonaws.quicksight#BoxPlotMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#BoxPlotOptions": { + "type": "structure", + "members": { + "StyleOptions": { + "target": "com.amazonaws.quicksight#BoxPlotStyleOptions", + "traits": { + "smithy.api#documentation": "

The style options of the box plot.

" + } + }, + "OutlierVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the outlier in a box plot.

" + } + }, + "AllDataPointsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of all data points of the box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options of a box plot visual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of a group by fields.

" + } + }, + "PaginationConfiguration": { + "target": "com.amazonaws.quicksight#PaginationConfiguration", + "traits": { + "smithy.api#documentation": "

The pagination configuration of a table visual or box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a BoxPlotVisual.

" + } + }, + "com.amazonaws.quicksight#BoxPlotStyleOptions": { + "type": "structure", + "members": { + "FillStyle": { + "target": "com.amazonaws.quicksight#BoxPlotFillStyle", + "traits": { + "smithy.api#documentation": "

The fill styles (solid, transparent) of the box plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The style options of the box plot.

" + } + }, + "com.amazonaws.quicksight#BoxPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#BoxPlotChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CIDR": { + "type": "string", + "traits": { + "smithy.api#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]))$" + } + }, + "com.amazonaws.quicksight#CalculatedColumn": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

Column name.

", + "smithy.api#required": {} + } + }, + "ColumnId": { + "target": "com.amazonaws.quicksight#ColumnId", + "traits": { + "smithy.api#documentation": "

A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#DataSetCalculatedFieldExpression", + "traits": { + "smithy.api#documentation": "

An expression that defines the calculated column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A calculated column for a dataset.

" + } + }, + "com.amazonaws.quicksight#CalculatedColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CalculatedColumn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#CalculatedField": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in this calculated field.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the calculated field.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#CalculatedFieldExpression", + "traits": { + "smithy.api#documentation": "

The expression of the calculated field.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The calculated field of an analysis.

" + } + }, + "com.amazonaws.quicksight#CalculatedFieldExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#CalculatedFieldReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Identifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 250 + } + } + }, + "com.amazonaws.quicksight#CalculatedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CalculatedField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#CalculatedMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression in the table calculation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The table calculation measure field for pivot tables.

" + } + }, + "com.amazonaws.quicksight#CancelIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CancelIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CancelIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Cancels an ongoing ingestion of data into SPICE.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CancelIngestionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CancelIngestionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CascadingControlConfiguration": { + "type": "structure", + "members": { + "SourceControls": { + "target": "com.amazonaws.quicksight#CascadingControlSourceList", + "traits": { + "smithy.api#documentation": "

A list of source controls that determine the values that are used in the current control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.quicksight#CascadingControlSource": { + "type": "structure", + "members": { + "SourceSheetControlId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The source sheet control ID of a CascadingControlSource.

" + } + }, + "ColumnToMatch": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column identifier that determines which column to look up for the source sheet control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source controls that are used in a CascadingControlConfiguration.

" + } + }, + "com.amazonaws.quicksight#CascadingControlSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CascadingControlSource" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#CastColumnTypeOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

Column name.

", + "smithy.api#required": {} + } + }, + "NewColumnType": { + "target": "com.amazonaws.quicksight#ColumnDataType", + "traits": { + "smithy.api#documentation": "

New column data type.

", + "smithy.api#required": {} + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" + } + }, + "Format": { + "target": "com.amazonaws.quicksight#TypeCastFormat", + "traits": { + "smithy.api#documentation": "

When casting a column from string to datetime type, you can supply a string in a\n format supported by Amazon QuickSight to denote the source data format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" + } + }, + "com.amazonaws.quicksight#Catalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#CategoricalAggregationFunction": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + } + } + }, + "com.amazonaws.quicksight#CategoricalDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the CategoricalDimensionField.

", + "smithy.api#required": {} + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with categorical type columns..

" + } + }, + "com.amazonaws.quicksight#CategoricalMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the CategoricalMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#CategoricalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with categorical type columns.

" + } + }, + "com.amazonaws.quicksight#CategoryDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

A list of the string inputs that are the values of the category drill down filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The category drill down filter.

" + } + }, + "com.amazonaws.quicksight#CategoryFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a CategoryFilter.

", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CategoryFilterConfiguration": { + "type": "structure", + "members": { + "FilterListConfiguration": { + "target": "com.amazonaws.quicksight#FilterListConfiguration", + "traits": { + "smithy.api#documentation": "

A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.

" + } + }, + "CustomFilterListConfiguration": { + "target": "com.amazonaws.quicksight#CustomFilterListConfiguration", + "traits": { + "smithy.api#documentation": "

A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.

" + } + }, + "CustomFilterConfiguration": { + "target": "com.amazonaws.quicksight#CustomFilterConfiguration", + "traits": { + "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a CategoryFilter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CategoryFilterFunction": { + "type": "enum", + "members": { + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterMatchOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "DOES_NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_EQUAL" + } + }, + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "DOES_NOT_CONTAIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_CONTAIN" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterSelectAllOptions": { + "type": "enum", + "members": { + "FILTER_ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#CategoryFilterType": { + "type": "enum", + "members": { + "CUSTOM_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER" + } + }, + "CUSTOM_FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM_FILTER_LIST" + } + }, + "FILTER_LIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_LIST" + } + } + } + }, + "com.amazonaws.quicksight#CategoryInnerFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#CategoryFilterConfiguration", + "traits": { + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" + } + }, + "com.amazonaws.quicksight#CategoryValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#CategoryValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CategoryValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100000 + } + } + }, + "com.amazonaws.quicksight#CellValueSynonym": { + "type": "structure", + "members": { + "CellValue": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The cell value.

" + } + }, + "Synonyms": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

Other names or aliases for the cell value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents the cell value synonym.

" + } + }, + "com.amazonaws.quicksight#CellValueSynonyms": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CellValueSynonym" + } + }, + "com.amazonaws.quicksight#ChartAxisLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of an axis label on a chart. Choose one of the following options:

\n " + } + }, + "SortIconVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the sort icon on a chart's axis label.

" + } + }, + "AxisLabelOptions": { + "target": "com.amazonaws.quicksight#AxisLabelOptionsList", + "traits": { + "smithy.api#documentation": "

The label options for a chart axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options for an axis on a chart.

" + } + }, + "com.amazonaws.quicksight#ClusterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ClusterMarker": { + "type": "structure", + "members": { + "SimpleClusterMarker": { + "target": "com.amazonaws.quicksight#SimpleClusterMarker", + "traits": { + "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker\n configuration.

" + } + }, + "com.amazonaws.quicksight#ClusterMarkerConfiguration": { + "type": "structure", + "members": { + "ClusterMarker": { + "target": "com.amazonaws.quicksight#ClusterMarker", + "traits": { + "smithy.api#documentation": "

The cluster marker that is a part of the cluster marker configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cluster marker configuration of the geospatial map selected point style.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstant": { + "type": "structure", + "members": { + "ValueList": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of values for the collective constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a collective constant.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstantEntry": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The ConstantType of a CollectiveConstantEntry.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The value of a CollectiveConstantEntry.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a CollectiveConstantEntry.

" + } + }, + "com.amazonaws.quicksight#CollectiveConstantEntryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CollectiveConstantEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ColorFillType": { + "type": "enum", + "members": { + "DISCRETE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISCRETE" + } + }, + "GRADIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRADIENT" + } + } + } + }, + "com.amazonaws.quicksight#ColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HexColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ColorScale": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#ColorScaleColorList", + "traits": { + "smithy.api#documentation": "

Determines the list of colors that are applied to the visual.

", + "smithy.api#required": {} + } + }, + "ColorFillType": { + "target": "com.amazonaws.quicksight#ColorFillType", + "traits": { + "smithy.api#documentation": "

Determines the color fill type.

", + "smithy.api#required": {} + } + }, + "NullValueColor": { + "target": "com.amazonaws.quicksight#DataColor", + "traits": { + "smithy.api#documentation": "

Determines the color that is applied to null values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color scale that is applied to the visual.

" + } + }, + "com.amazonaws.quicksight#ColorScaleColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#ColorsConfiguration": { + "type": "structure", + "members": { + "CustomColors": { + "target": "com.amazonaws.quicksight#CustomColorsList", + "traits": { + "smithy.api#documentation": "

A list of up to 50 custom colors.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configurations for a column.

" + } + }, + "com.amazonaws.quicksight#ColumnConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column.

", + "smithy.api#required": {} + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#FormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of a column.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#ColumnRole", + "traits": { + "smithy.api#documentation": "

The role of the column.

" + } + }, + "ColorsConfiguration": { + "target": "com.amazonaws.quicksight#ColorsConfiguration", + "traits": { + "smithy.api#documentation": "

The color configurations of the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general configuration of a column.

" + } + }, + "com.amazonaws.quicksight#ColumnConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ColumnDataRole": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDataSubType": { + "type": "enum", + "members": { + "FLOAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLOAT" + } + }, + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "DATETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATETIME" + } + } + } + }, + "com.amazonaws.quicksight#ColumnDescription": { + "type": "structure", + "members": { + "Text": { + "target": "com.amazonaws.quicksight#ColumnDescriptiveText", + "traits": { + "smithy.api#documentation": "

The text of a description for a column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata that contains a description for a column.

" + } + }, + "com.amazonaws.quicksight#ColumnDescriptiveText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#ColumnGroup": { + "type": "structure", + "members": { + "GeoSpatialColumnGroup": { + "target": "com.amazonaws.quicksight#GeoSpatialColumnGroup", + "traits": { + "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. This is\n a variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupColumnSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column group's column schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure describing the name, data type, and geographic role of the columns.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupColumnSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroupColumnSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ColumnGroupSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column group schema.

" + } + }, + "ColumnGroupColumnSchemaList": { + "target": "com.amazonaws.quicksight#ColumnGroupColumnSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of schemas for column group columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column group schema.

" + } + }, + "com.amazonaws.quicksight#ColumnGroupSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnGroupSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnHierarchy": { + "type": "structure", + "members": { + "ExplicitHierarchy": { + "target": "com.amazonaws.quicksight#ExplicitHierarchy", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "DateTimeHierarchy": { + "target": "com.amazonaws.quicksight#DateTimeHierarchy", + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" + } + }, + "PredefinedHierarchy": { + "target": "com.amazonaws.quicksight#PredefinedHierarchy", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of the fields for a visual element.

" + } + }, + "com.amazonaws.quicksight#ColumnHierarchyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnHierarchy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#ColumnId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ColumnIdentifier": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that the column belongs to.

", + "smithy.api#required": {} + } + }, + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A column of a data set.

" + } + }, + "com.amazonaws.quicksight#ColumnLevelPermissionRule": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#PrincipalList", + "traits": { + "smithy.api#documentation": "

An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.

" + } + }, + "ColumnNames": { + "target": "com.amazonaws.quicksight#ColumnNameList", + "traits": { + "smithy.api#documentation": "

An array of column names.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A rule defined to grant access on one or more restricted columns.\n Each dataset can have multiple rules.\n To create a restricted column, you add it to one or more rules.\n Each rule must contain at least one column and at least one user or group.\n To be able to see a restricted column, a user or group needs to be added\n to a rule for that column.

" + } + }, + "com.amazonaws.quicksight#ColumnLevelPermissionRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRule" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ColumnOrderingType": { + "type": "enum", + "members": { + "GREATER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GREATER_IS_BETTER" + } + }, + "LESSER_IS_BETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LESSER_IS_BETTER" + } + }, + "SPECIFIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPECIFIED" + } + } + } + }, + "com.amazonaws.quicksight#ColumnRole": { + "type": "enum", + "members": { + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#ColumnSchema": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the column schema.

" + } + }, + "DataType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The data type of the column schema.

" + } + }, + "GeographicRole": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The geographic role of the column schema.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The column schema.

" + } + }, + "com.amazonaws.quicksight#ColumnSchemaList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnSchema" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#ColumnSort": { + "type": "structure", + "members": { + "SortBy": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#required": {} + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function that is defined in the column sort.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" + } + }, + "com.amazonaws.quicksight#ColumnTag": { + "type": "structure", + "members": { + "ColumnGeographicRole": { + "target": "com.amazonaws.quicksight#GeoSpatialDataRole", + "traits": { + "smithy.api#documentation": "

A geospatial role for a column.

" + } + }, + "ColumnDescription": { + "target": "com.amazonaws.quicksight#ColumnDescription", + "traits": { + "smithy.api#documentation": "

A description for a column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tag for a column in a\n \n TagColumnOperation\n \n structure. This is a\n variant type structure. For this structure to be valid, only one of the attributes can\n be non-null.

" + } + }, + "com.amazonaws.quicksight#ColumnTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnTag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#ColumnTagName": { + "type": "enum", + "members": { + "COLUMN_GEOGRAPHIC_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE" + } + }, + "COLUMN_DESCRIPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_DESCRIPTION" + } + } + } + }, + "com.amazonaws.quicksight#ColumnTagNames": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnTagName" + } + }, + "com.amazonaws.quicksight#ColumnTooltipItem": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The target column of the tooltip item.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label of the tooltip item.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip item.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the column tooltip item.

" + } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "

Determines the target of the column tooltip item in a combo chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" + } + }, + "com.amazonaws.quicksight#ComboChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated category field wells of a combo chart.

" + } + }, + "BarValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated BarValues field well of a combo chart.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated colors field well of a combo chart.

" + } + }, + "LineValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated LineValues field well of a combo chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a combo chart.

" + } + }, + "com.amazonaws.quicksight#ComboChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ComboChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#ComboChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" + } + }, + "BarsArrangement": { + "target": "com.amazonaws.quicksight#BarsArrangement", + "traits": { + "smithy.api#documentation": "

Determines the bar arrangement in a combo chart. The following are valid values in this structure:

\n " + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The category axis of a combo chart.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.

" + } + }, + "SecondaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.

" + } + }, + "SecondaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.

" + } + }, + "SingleAxisOptions": { + "target": "com.amazonaws.quicksight#SingleAxisOptions" + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "BarDataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a bar in a combo chart.

" + } + }, + "LineDataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

\n

The data label options for a line in a combo chart.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference line setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a ComboChartVisual.

" + } + }, + "com.amazonaws.quicksight#ComboChartFieldWells": { + "type": "structure", + "members": { + "ComboChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ComboChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComboChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category field well in a combo chart.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The item limit configuration for the category field well of a combo chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the color field well in a combo chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The item limit configuration of the color field well in a combo chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a ComboChartVisual.

" + } + }, + "com.amazonaws.quicksight#ComboChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ComboChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A combo chart.

\n

The ComboChartVisual includes stacked bar combo charts and clustered bar combo charts

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ComparativeOrder": { + "type": "structure", + "members": { + "UseOrdering": { + "target": "com.amazonaws.quicksight#ColumnOrderingType", + "traits": { + "smithy.api#documentation": "

The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.

" + } + }, + "SpecifedOrder": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The list of columns to be used in the ordering.

" + } + }, + "TreatUndefinedSpecifiedValues": { + "target": "com.amazonaws.quicksight#UndefinedSpecifiedValueType", + "traits": { + "smithy.api#documentation": "

The treat of undefined specified values. Valid values for this structure are LEAST and MOST.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a comparative order.

" + } + }, + "com.amazonaws.quicksight#ComparisonConfiguration": { + "type": "structure", + "members": { + "ComparisonMethod": { + "target": "com.amazonaws.quicksight#ComparisonMethod", + "traits": { + "smithy.api#documentation": "

The method of the comparison. Choose from the following options:

\n " + } + }, + "ComparisonFormat": { + "target": "com.amazonaws.quicksight#ComparisonFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format of the comparison.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The comparison display configuration of a KPI or gauge chart.

" + } + }, + "com.amazonaws.quicksight#ComparisonFormatConfiguration": { + "type": "structure", + "members": { + "NumberDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The number display format.

" + } + }, + "PercentageDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The percentage display format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The format of the comparison.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComparisonMethod": { + "type": "enum", + "members": { + "DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFFERENCE" + } + }, + "PERCENT_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_DIFFERENCE" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#ComparisonMethodType": { + "type": "enum", + "members": { + "DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFF" + } + }, + "PERC_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERC_DIFF" + } + }, + "DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIFF_AS_PERC" + } + }, + "POP_CURRENT_DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_CURRENT_DIFF_AS_PERC" + } + }, + "POP_CURRENT_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_CURRENT_DIFF" + } + }, + "POP_OVERTIME_DIFF_AS_PERC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_OVERTIME_DIFF_AS_PERC" + } + }, + "POP_OVERTIME_DIFF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POP_OVERTIME_DIFF" + } + }, + "PERCENT_OF_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_OF_TOTAL" + } + }, + "RUNNING_SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING_SUM" + } + }, + "MOVING_AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOVING_AVERAGE" + } + } + } + }, + "com.amazonaws.quicksight#Computation": { + "type": "structure", + "members": { + "TopBottomRanked": { + "target": "com.amazonaws.quicksight#TopBottomRankedComputation", + "traits": { + "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" + } + }, + "TopBottomMovers": { + "target": "com.amazonaws.quicksight#TopBottomMoversComputation", + "traits": { + "smithy.api#documentation": "

The top movers and bottom movers computation configuration.

" + } + }, + "TotalAggregation": { + "target": "com.amazonaws.quicksight#TotalAggregationComputation", + "traits": { + "smithy.api#documentation": "

The total aggregation computation configuration.

" + } + }, + "MaximumMinimum": { + "target": "com.amazonaws.quicksight#MaximumMinimumComputation", + "traits": { + "smithy.api#documentation": "

The maximum and minimum computation configuration.

" + } + }, + "MetricComparison": { + "target": "com.amazonaws.quicksight#MetricComparisonComputation", + "traits": { + "smithy.api#documentation": "

The metric comparison computation configuration.

" + } + }, + "PeriodOverPeriod": { + "target": "com.amazonaws.quicksight#PeriodOverPeriodComputation", + "traits": { + "smithy.api#documentation": "

The period over period computation configuration.

" + } + }, + "PeriodToDate": { + "target": "com.amazonaws.quicksight#PeriodToDateComputation", + "traits": { + "smithy.api#documentation": "

The period to DataSetIdentifier computation configuration.

" + } + }, + "GrowthRate": { + "target": "com.amazonaws.quicksight#GrowthRateComputation", + "traits": { + "smithy.api#documentation": "

The growth rate computation configuration.

" + } + }, + "UniqueValues": { + "target": "com.amazonaws.quicksight#UniqueValuesComputation", + "traits": { + "smithy.api#documentation": "

The unique values computation configuration.

" + } + }, + "Forecast": { + "target": "com.amazonaws.quicksight#ForecastComputation", + "traits": { + "smithy.api#documentation": "

The forecast computation configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The computation union that is used in an insight visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ComputationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Computation" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ConcurrentUpdatingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String" + } + }, + "traits": { + "smithy.api#documentation": "

A resource is already in a state that indicates an operation is happening that must complete\n\t\t\tbefore a new update can be applied.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.quicksight#ConditionalFormattingColor": { + "type": "structure", + "members": { + "Solid": { + "target": "com.amazonaws.quicksight#ConditionalFormattingSolidColor", + "traits": { + "smithy.api#documentation": "

Formatting configuration for solid color.

" + } + }, + "Gradient": { + "target": "com.amazonaws.quicksight#ConditionalFormattingGradientColor", + "traits": { + "smithy.api#documentation": "

Formatting configuration for gradient color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for the color.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the condition of the icon set.

", + "smithy.api#required": {} + } + }, + "IconOptions": { + "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions", + "traits": { + "smithy.api#documentation": "

Custom icon options for an icon set.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the icon.

" + } + }, + "DisplayConfiguration": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration", + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the custom condition for an icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingCustomIconOptions": { + "type": "structure", + "members": { + "Icon": { + "target": "com.amazonaws.quicksight#Icon", + "traits": { + "smithy.api#documentation": "

Determines the type of icon.

" + } + }, + "UnicodeIcon": { + "target": "com.amazonaws.quicksight#UnicodeIcon", + "traits": { + "smithy.api#documentation": "

Determines the Unicode icon type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Custom icon options for an icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingGradientColor": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for gradient color.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#GradientColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for gradient color.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIcon": { + "type": "structure", + "members": { + "IconSet": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconSet", + "traits": { + "smithy.api#documentation": "

Formatting configuration for icon set.

" + } + }, + "CustomCondition": { + "target": "com.amazonaws.quicksight#ConditionalFormattingCustomIconCondition", + "traits": { + "smithy.api#documentation": "

Determines the custom condition for an icon set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for the icon.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconDisplayConfiguration": { + "type": "structure", + "members": { + "IconDisplayOption": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption", + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the icon display configuration.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconDisplayOption": { + "type": "enum", + "members": { + "ICON_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ICON_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconSet": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for the icon set.

", + "smithy.api#required": {} + } + }, + "IconSetType": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIconSetType", + "traits": { + "smithy.api#documentation": "

Determines the icon set type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for icon set.

" + } + }, + "com.amazonaws.quicksight#ConditionalFormattingIconSetType": { + "type": "enum", + "members": { + "PLUS_MINUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUS_MINUS" + } + }, + "CHECK_X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECK_X" + } + }, + "THREE_COLOR_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_COLOR_ARROW" + } + }, + "THREE_GRAY_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_GRAY_ARROW" + } + }, + "CARET_UP_MINUS_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_UP_MINUS_DOWN" + } + }, + "THREE_SHAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_SHAPE" + } + }, + "THREE_CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_CIRCLE" + } + }, + "FLAGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLAGS" + } + }, + "BARS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BARS" + } + }, + "FOUR_COLOR_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOUR_COLOR_ARROW" + } + }, + "FOUR_GRAY_ARROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOUR_GRAY_ARROW" + } + } + } + }, + "com.amazonaws.quicksight#ConditionalFormattingSolidColor": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression that determines the formatting configuration for solid color.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for solid color.

" + } + }, + "com.amazonaws.quicksight#ConflictException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Updating or deleting a resource can cause an inconsistent state.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#ConstantType": { + "type": "enum", + "members": { + "SINGULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGULAR" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + }, + "COLLECTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLECTIVE" + } + } + } + }, + "com.amazonaws.quicksight#ConstantValueString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#ContextMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The context menu options for a visual's interactions.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDefault": { + "type": "structure", + "members": { + "MeasureFieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The measure field that is used in the contribution analysis.

", + "smithy.api#required": {} + } + }, + "ContributorDimensions": { + "target": "com.amazonaws.quicksight#ContributorDimensionList", + "traits": { + "smithy.api#documentation": "

The dimensions columns that are used in the contribution analysis,\n usually a list of ColumnIdentifiers.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The contribution analysis visual display for a line, pie, or bar chart.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDefaultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefault" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisDirection": { + "type": "enum", + "members": { + "INCREASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREASE" + } + }, + "DECREASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECREASE" + } + }, + "NEUTRAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEUTRAL" + } + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisFactor": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The field name of the ContributionAnalysisFactor.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the ContributionAnalysisFactor.

" + } + }, + "com.amazonaws.quicksight#ContributionAnalysisFactorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ContributionAnalysisFactor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisSortType": { + "type": "enum", + "members": { + "ABSOLUTE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + } + }, + "CONTRIBUTION_PERCENTAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTRIBUTION_PERCENTAGE" + } + }, + "DEVIATION_FROM_EXPECTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEVIATION_FROM_EXPECTED" + } + }, + "PERCENTAGE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_DIFFERENCE" + } + } + } + }, + "com.amazonaws.quicksight#ContributionAnalysisTimeRanges": { + "type": "structure", + "members": { + "StartRange": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption", + "traits": { + "smithy.api#documentation": "

The start range for the ContributionAnalysisTimeRanges.

" + } + }, + "EndRange": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption", + "traits": { + "smithy.api#documentation": "

The end range for the ContributionAnalysisTimeRanges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the ContributionAnalysisTimeRanges.

" + } + }, + "com.amazonaws.quicksight#ContributorDimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.quicksight#CopySourceArn": { + "type": "string", + "traits": { + "smithy.api#pattern": "^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+$" + } + }, + "com.amazonaws.quicksight#CreateAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the\n CreateAccountCustomization or UpdateAccountCustomization\n API operation. To further customize Amazon QuickSight by removing Amazon QuickSight\n sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide.\n

\n

You can create customizations for your Amazon Web Services account or, if you specify a namespace, for\n a QuickSight namespace instead. Customizations that apply to a namespace always override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

\n

Before you use the CreateAccountCustomization API operation to add a theme\n as the namespace default, make sure that you first share the theme with the namespace.\n If you don't share it with the namespace, the theme isn't visible to your users\n even if you make it the default theme.\n To check if the theme is shared, view the current permissions by using the\n \n DescribeThemePermissions\n \n API operation.\n To share the theme, grant permissions by using the\n \n UpdateThemePermissions\n \n API operation.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to add customizations to.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add\n these to an Amazon Web Services account and a QuickSight namespace.

\n

For example, you can add a default theme by setting AccountCustomization\n to the midnight theme: \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }. Or, you can add a custom theme by\n specifying \"AccountCustomization\": { \"DefaultTheme\":\n \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\"\n }.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A list of the tags that you want to attach to this resource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the customization you're creating.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#TopicRefreshScheduleSummary": { - "type": "structure", - "members": { - "DatasetId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DatasetName": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The name of the dataset.

" - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A summary of the refresh schedule details for a dataset.

" - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#TopicRefreshStatus": { - "type": "enum", - "members": { - "INITIALIZED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "INITIALIZED" - } - }, - "RUNNING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RUNNING" - } - }, - "FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FAILED" - } - }, - "COMPLETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLETED" - } - }, - "CANCELLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CANCELLED" - } - } - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#TopicRelativeDateFilter": { - "type": "structure", - "members": { - "TimeGranularity": { - "target": "com.amazonaws.quicksight#TopicTimeGranularity", - "traits": { - "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" - } - }, - "RelativeDateFilterFunction": { - "target": "com.amazonaws.quicksight#TopicRelativeDateFilterFunction", - "traits": { - "smithy.api#documentation": "

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

" - } - }, - "Constant": { - "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", - "traits": { - "smithy.api#documentation": "

The constant used in a\n relative date filter.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a relative date filter.

" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#TopicRelativeDateFilterFunction": { - "type": "enum", - "members": { - "PREVIOUS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PREVIOUS" - } - }, - "THIS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "THIS" - } - }, - "LAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LAST" - } - }, - "NEXT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEXT" - } - }, - "NOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NOW" - } - } - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, - "com.amazonaws.quicksight#TopicReviewedAnswer": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reviewed answer.

" - } - }, - "AnswerId": { - "target": "com.amazonaws.quicksight#AnswerId", - "traits": { - "smithy.api#documentation": "

The answer ID of the reviewed answer.

", - "smithy.api#required": {} - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Dataset ARN for the TopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Question": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The question for the TopicReviewedAnswer.

", - "smithy.api#required": {} - } - }, - "Mir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The mir for the TopicReviewedAnswer.

" - } - }, - "PrimaryVisual": { - "target": "com.amazonaws.quicksight#TopicVisual", - "traits": { - "smithy.api#documentation": "

The primary visual for the TopicReviewedAnswer.

" - } - }, - "Template": { - "target": "com.amazonaws.quicksight#TopicTemplate", - "traits": { - "smithy.api#documentation": "

The template for the TopicReviewedAnswer.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The deinition for a TopicReviewedAnswer.

" - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#TopicReviewedAnswers": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicReviewedAnswer" - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#TopicScheduleType": { - "type": "enum", - "members": { - "HOURLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOURLY" - } - }, - "DAILY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAILY" - } - }, - "WEEKLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEKLY" - } - }, - "MONTHLY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTHLY" - } - } - } + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" }, - "com.amazonaws.quicksight#TopicSingularFilterConstant": { - "type": "structure", - "members": { - "ConstantType": { - "target": "com.amazonaws.quicksight#ConstantType", - "traits": { - "smithy.api#documentation": "

The type of the singular filter constant. Valid values for this structure are SINGULAR.

" - } - }, - "SingularConstant": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The value of the singular filter constant.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

", - "smithy.api#sensitive": {} - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q.

\n

The Amazon Web Services Region for the account is derived from what is configured in the\n CLI or SDK.

\n

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 Sign\n up for Amazon Web Services in the Amazon QuickSight User\n Guide. The person who signs up for Amazon QuickSight needs to have the\n correct Identity and Access Management (IAM) permissions. For more information,\n see IAM Policy Examples for Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

If your IAM policy includes both the Subscribe and\n CreateAccountSubscription actions, make sure that both actions are set\n to Allow. If either action is set to Deny, the\n Deny action prevails and your API call fails.

\n

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\n Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the\n Amazon QuickSight User Guide.

\n

You can't set default resource access on the new account from the Amazon QuickSight\n API. Instead, add default resource access from the Amazon QuickSight console. For more\n information about setting default resource access to Amazon Web Services services, see\n Setting default resource\n access to Amazon Web Services services in the Amazon QuickSight\n User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAccountSubscriptionRequest": { + "type": "structure", + "members": { + "Edition": { + "target": "com.amazonaws.quicksight#Edition", + "traits": { + "smithy.api#documentation": "

The edition of Amazon QuickSight that you want your account to have. Currently, you can\n choose from ENTERPRISE or\n ENTERPRISE_AND_Q.

\n

If you choose ENTERPRISE_AND_Q, the following parameters are\n required:

\n " + } + }, + "AuthenticationMethod": { + "target": "com.amazonaws.quicksight#AuthenticationMethodOption", + "traits": { + "smithy.api#documentation": "

The method that you want to use to authenticate your Amazon QuickSight account.

\n

If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName\n and an AdminGroup associated with your Active Directory.

\n

If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.

", + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AccountName": { + "target": "com.amazonaws.quicksight#AccountName", + "traits": { + "smithy.api#documentation": "

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\n AccountName value after the Amazon QuickSight account is\n created.

", + "smithy.api#required": {} + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.

", + "smithy.api#required": {} + } + }, + "ActiveDirectoryName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + } + }, + "Realm": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.

" + } + }, + "DirectoryId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the Active Directory that is associated with your Amazon QuickSight account.

" + } + }, + "AdminGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AuthorGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The author group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "ReaderGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The reader group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AdminProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "AuthorProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The author pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "ReaderProGroup": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The reader pro group associated with your Active Directory or IAM Identity Center account.

\n

For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.

" + } + }, + "FirstName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The first name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "LastName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The last name of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "EmailAddress": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the author of the Amazon QuickSight account to use for future\n communications. This field is required if ENTERPPRISE_AND_Q is the selected\n edition of the new Amazon QuickSight account.

" + } + }, + "ContactNumber": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A 10-digit phone number for the author of the Amazon QuickSight account to use for\n future communications. This field is required if ENTERPPRISE_AND_Q is the\n selected edition of the new Amazon QuickSight account.

" + } + }, + "IAMIdentityCenterInstanceArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM Identity Center instance.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAccountSubscriptionResponse": { + "type": "structure", + "members": { + "SignupResponse": { + "target": "com.amazonaws.quicksight#SignupResponse", + "traits": { + "smithy.api#documentation": "

A SignupResponse object that returns information about a newly created Amazon QuickSight account.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you are creating an analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions structure to grant permissions by\n providing a list of Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).

\n

To specify no permissions, omit Permissions.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the Amazon QuickSight console, make sure that you have access to it.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the analysis, Amazon QuickSight adds the analysis to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateAnalysisResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateColumnsOperation": { + "type": "structure", + "members": { + "Columns": { + "target": "com.amazonaws.quicksight#CalculatedColumnList", + "traits": { + "smithy.api#documentation": "

Calculated columns to create.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that creates calculated columns. Columns created in one such\n operation form a lexical closure.

" + } + }, + "com.amazonaws.quicksight#CreateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the \n \n CreateTemplate\n \n API operation.

\n

A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created\n from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can\n create scheduled email reports from them. If you have the correct permissions, you can\n create a dashboard from a template that exists in a different Amazon Web Services account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to create the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.

\n

To specify no permissions, omit the permissions list.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you create the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only create a dashboard from a template, so you use a SourceTemplate\n entity. If you need to create a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n \n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n order for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of a shareable link to the dashboard.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDashboardResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard, including the version number of the first version that is\n created.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the dashboard creation request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#TopicSortClause": { - "type": "structure", - "members": { - "Operand": { - "target": "com.amazonaws.quicksight#Identifier", - "traits": { - "smithy.api#documentation": "

The operand for a TopicSortClause.

" - } - }, - "SortDirection": { - "target": "com.amazonaws.quicksight#TopicSortDirection", - "traits": { - "smithy.api#documentation": "

The sort direction for the TopicSortClause.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicSortClause.

" - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#TopicSortDirection": { - "type": "enum", - "members": { - "ASCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ASCENDING" - } - }, - "DESCENDING": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DESCENDING" - } - } - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#TopicSummaries": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicSummary" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#TopicSummary": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The name of the topic.

" - } - }, - "UserExperienceVersion": { - "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", - "traits": { - "smithy.api#documentation": "

The user experience version of the topic.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A topic summary.

" - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#TopicTemplate": { - "type": "structure", - "members": { - "TemplateType": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The template type for the TopicTemplate.

" - } - }, - "Slots": { - "target": "com.amazonaws.quicksight#Slots", - "traits": { - "smithy.api#documentation": "

The slots for the TopicTemplate.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicTemplate.

" - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#TopicTimeGranularity": { - "type": "enum", - "members": { - "SECOND": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SECOND" - } - }, - "MINUTE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MINUTE" - } - }, - "HOUR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HOUR" - } - }, - "DAY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DAY" - } - }, - "WEEK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "WEEK" - } - }, - "MONTH": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MONTH" - } - }, - "QUARTER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "QUARTER" - } - }, - "YEAR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "YEAR" - } - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#TopicUserExperienceVersion": { - "type": "enum", - "members": { - "LEGACY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEGACY" - } - }, - "NEW_READER_EXPERIENCE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_READER_EXPERIENCE" - } - } - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#TopicVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The visual ID for the TopicVisual.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#VisualRole", - "traits": { - "smithy.api#documentation": "

The role for the TopicVisual.

" - } - }, - "Ir": { - "target": "com.amazonaws.quicksight#TopicIR", - "traits": { - "smithy.api#documentation": "

The ir for the TopicVisual.

" - } - }, - "SupportingVisuals": { - "target": "com.amazonaws.quicksight#TopicVisuals", - "traits": { - "smithy.api#documentation": "

The supporting visuals for the TopicVisual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a TopicVisual.

" - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the dataset.

", + "smithy.api#required": {} + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", + "smithy.api#required": {} + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", + "smithy.api#required": {} + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the data that you want to create.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameter declarations of the dataset.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "IngestionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#TopicVisuals": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TopicVisual" - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#TotalAggregationComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Value": { - "target": "com.amazonaws.quicksight#MeasureField", - "traits": { - "smithy.api#documentation": "

The value field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total aggregation computation configuration.

" - } + { + "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" }, - "com.amazonaws.quicksight#TotalAggregationFunction": { - "type": "structure", - "members": { - "SimpleTotalAggregationFunction": { - "target": "com.amazonaws.quicksight#SimpleTotalAggregationFunction", - "traits": { - "smithy.api#documentation": "

A built in aggregation function for total values.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

An aggregation function that aggregates the total values of a measure.

" - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#TotalAggregationOption": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The field id that's associated with the total aggregation option.

", - "smithy.api#required": {} - } - }, - "TotalAggregationFunction": { - "target": "com.amazonaws.quicksight#TotalAggregationFunction", - "traits": { - "smithy.api#documentation": "

The total aggregation function that you want to set for a specified field id.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The total aggregation settings map of a field id.

" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#TotalAggregationOptionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TotalAggregationOption" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#TotalOptions": { - "type": "structure", - "members": { - "TotalsVisibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility configuration for the total cells.

" - } - }, - "Placement": { - "target": "com.amazonaws.quicksight#TableTotalsPlacement", - "traits": { - "smithy.api#documentation": "

The placement (start, end) for the total cells.

" - } - }, - "ScrollStatus": { - "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", - "traits": { - "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" - } - }, - "CustomLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The custom label string for the total cells.

" - } - }, - "TotalCellStyle": { - "target": "com.amazonaws.quicksight#TableCellStyle", - "traits": { - "smithy.api#documentation": "

Cell styling options for the total cells.

" - } - }, - "TotalAggregationOptions": { - "target": "com.amazonaws.quicksight#TotalAggregationOptionList", - "traits": { - "smithy.api#documentation": "

The total aggregation settings for each value field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The total options for a table visual.

" - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#TransformOperation": { - "type": "union", - "members": { - "ProjectOperation": { - "target": "com.amazonaws.quicksight#ProjectOperation", - "traits": { - "smithy.api#documentation": "

An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

" - } - }, - "FilterOperation": { - "target": "com.amazonaws.quicksight#FilterOperation", - "traits": { - "smithy.api#documentation": "

An operation that filters rows based on some condition.

" - } - }, - "CreateColumnsOperation": { - "target": "com.amazonaws.quicksight#CreateColumnsOperation", - "traits": { - "smithy.api#documentation": "

An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.

" - } - }, - "RenameColumnOperation": { - "target": "com.amazonaws.quicksight#RenameColumnOperation", - "traits": { - "smithy.api#documentation": "

An operation that renames a column.

" - } - }, - "CastColumnTypeOperation": { - "target": "com.amazonaws.quicksight#CastColumnTypeOperation", - "traits": { - "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" - } - }, - "TagColumnOperation": { - "target": "com.amazonaws.quicksight#TagColumnOperation", - "traits": { - "smithy.api#documentation": "

An operation that tags a column with additional information.

" - } - }, - "UntagColumnOperation": { - "target": "com.amazonaws.quicksight#UntagColumnOperation" - }, - "OverrideDatasetParameterOperation": { - "target": "com.amazonaws.quicksight#OverrideDatasetParameterOperation" - } - }, - "traits": { - "smithy.api#documentation": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

" - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#TransformOperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#TransformOperation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a data source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sources", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source. To return a\n\t\t\tlist of all data sources, use ListDataSources.

\n

Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.

", + "smithy.api#required": {} + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + } + }, + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", + "traits": { + "smithy.api#documentation": "

The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.

" + } + }, + "FolderArns": { + "target": "com.amazonaws.quicksight#FolderArnList", + "traits": { + "smithy.api#documentation": "

When you create the data source, Amazon QuickSight adds the data source to these folders.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of creating the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#TreeMapAggregatedFieldWells": { - "type": "structure", - "members": { - "Groups": { - "target": "com.amazonaws.quicksight#TreeMapDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a tree map. Values are grouped based on group by fields.

" - } - }, - "Sizes": { - "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a tree map. Values are aggregated based on group by fields.

" - } - }, - "Colors": { - "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Aggregated field wells of a tree map.

" - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#TreeMapConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#TreeMapFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#TreeMapSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a tree map.

" - } - }, - "GroupLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) of the groups that are displayed in a tree map.

" - } - }, - "SizeLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

" - } - }, - "ColorLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility) for the colors displayed in a tree map.

" - } - }, - "ColorScale": { - "target": "com.amazonaws.quicksight#ColorScale", - "traits": { - "smithy.api#documentation": "

The color options (gradient color, point of divergence) of a tree map.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend display setup of the visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" - } - }, - "Tooltip": { - "target": "com.amazonaws.quicksight#TooltipOptions", - "traits": { - "smithy.api#documentation": "

The tooltip display setup of the visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a tree map.

" - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#TreeMapDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#TreeMapFieldWells": { - "type": "structure", - "members": { - "TreeMapAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#TreeMapAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a tree map.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a tree map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#TreeMapMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#TreeMapSortConfiguration": { - "type": "structure", - "members": { - "TreeMapSort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of group by fields.

" - } - }, - "TreeMapGroupItemsLimitConfiguration": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of groups that are displayed.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a tree map.

" - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#TreeMapVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#TreeMapConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#TrendArrowOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the trend arrows.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an empty shared folder.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateFolderMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an asset, such as a dashboard, analysis, or dataset into a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset that you want to add to the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The member type of the asset that you want to add to a folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateFolderMembershipResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "FolderMember": { + "target": "com.amazonaws.quicksight#FolderMember", + "traits": { + "smithy.api#documentation": "

Information about the member in the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account where you want to create the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder. By default, folderType is SHARED.

" + } + }, + "ParentFolderArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the parent folder.

\n

\n ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions of a folder.

\n

To specify no permissions, omit Permissions.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Tags for the folder.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the newly created folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The folder ID for the newly created folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The request ID for the newly created folder.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#TrinoParameters": { - "type": "structure", - "members": { - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "

The host name of the Trino data source.

", - "smithy.api#required": {} - } - }, - "Port": { - "target": "com.amazonaws.quicksight#Port", - "traits": { - "smithy.api#documentation": "

The port for the Trino data source.

", - "smithy.api#required": {} - } - }, - "Catalog": { - "target": "com.amazonaws.quicksight#Catalog", - "traits": { - "smithy.api#documentation": "

The catalog name for the Trino data source.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#TwitterParameters": { - "type": "structure", - "members": { - "Query": { - "target": "com.amazonaws.quicksight#Query", - "traits": { - "smithy.api#documentation": "

Twitter query string.

", - "smithy.api#required": {} - } - }, - "MaxRows": { - "target": "com.amazonaws.quicksight#PositiveInteger", - "traits": { - "smithy.api#documentation": "

Maximum number of rows to query Twitter.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The parameters for Twitter.

" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#TypeCastFormat": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 32 - } - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#TypeParameters": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#LimitedString" - }, - "value": { - "target": "com.amazonaws.quicksight#LimitedString" - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, - "com.amazonaws.quicksight#Typography": { - "type": "structure", - "members": { - "FontFamilies": { - "target": "com.amazonaws.quicksight#FontList", - "traits": { - "smithy.api#documentation": "

Determines the list of font families.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Determines the typography options.

" - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the CreateGroup 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 Amazon Web Services Support.

\n

The permissions resource is\n\t\t\t\t\tarn:aws:quicksight:::group/default/\n .

\n

The response is a group object.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds an Amazon QuickSight user to an Amazon QuickSight group.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to add to the group membership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to add the user to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want the user to be a part of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateGroupMembershipResponse": { + "type": "structure", + "members": { + "GroupMember": { + "target": "com.amazonaws.quicksight#GroupMember", + "traits": { + "smithy.api#documentation": "

The group member.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

A name for the group that you want to create.

", + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

A description for the group that you want to create.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want the group to be a part of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The request object for this operation.

", + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The response object for this operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an assignment with one specified IAM policy, identified by its\n\t\t\tAmazon Resource Name (ARN). This policy assignment is attached to the specified groups\n\t\t\tor users of Amazon QuickSight. Assignment names are unique per Amazon Web Services\n\t\t\taccount. To avoid overwriting rules in other namespaces, use assignment names that are\n\t\t\tunique.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname\n\t\t\tmust be unique within the\n\t\t\tAmazon Web Services account.

", + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n ", + "smithy.api#required": {} + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.\n\t\t\tThe\n\t\t\tname must be unique within the Amazon Web Services account.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID for the assignment.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy that is applied to the Amazon QuickSight\n\t\t\tusers and groups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in\n\t\t\tan Enterprise edition account 32 times in a 24-hour period. You can manually refresh\n\t\t\tdatasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period\n\t\t\tis measured starting 24 hours before the current date and time.

\n

Any ingestions operating on tagged datasets inherit the same tags automatically for use in\n\t\t\taccess control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using\n\t\t\t\ttags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateIngestionRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionType": { + "target": "com.amazonaws.quicksight#IngestionType", + "traits": { + "smithy.api#documentation": "

The type of ingestion that you want to create.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateIngestionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data ingestion.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", + "traits": { + "smithy.api#documentation": "

The ingestion status.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UIColorPalette": { - "type": "structure", - "members": { - "PrimaryForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

" - } - }, - "PrimaryBackground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color that applies to visuals and other high emphasis UI.

" - } - }, - "SecondaryForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

" - } - }, - "SecondaryBackground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The background color that applies to the sheet background and sheet controls.

" - } - }, - "Accent": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

This color is that applies to selected states and buttons.

" - } - }, - "AccentForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

" - } - }, - "Danger": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to error messages.

" - } - }, - "DangerForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n error color.

" - } - }, - "Warning": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

This color that applies to warning and informational messages.

" - } - }, - "WarningForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

" - } - }, - "Success": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to success messages, for example the check mark for a\n successful download.

" - } - }, - "SuccessForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n success color.

" - } - }, - "Dimension": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to the names of fields that are identified as\n dimensions.

" - } - }, - "DimensionForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

" - } - }, - "Measure": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The color that applies to the names of fields that are identified as measures.

" - } - }, - "MeasureForeground": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

" - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#URLOperationTemplate": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2048 - } - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#URLTargetConfiguration": { - "type": "enum", - "members": { - "NEW_TAB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_TAB" - } - }, - "NEW_WINDOW": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NEW_WINDOW" - } - }, - "SAME_TAB": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SAME_TAB" - } - } - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UnaggregatedField": { - "type": "structure", - "members": { - "FieldId": { - "target": "com.amazonaws.quicksight#FieldId", - "traits": { - "smithy.api#documentation": "

The custom field ID.

", - "smithy.api#required": {} - } - }, - "Column": { - "target": "com.amazonaws.quicksight#ColumnIdentifier", - "traits": { - "smithy.api#documentation": "

The column that is used in the UnaggregatedField.

", - "smithy.api#required": {} - } - }, - "FormatConfiguration": { - "target": "com.amazonaws.quicksight#FormatConfiguration", - "traits": { - "smithy.api#documentation": "

The format configuration of the field.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unaggregated field for a table.

" - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#UnaggregatedFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#UnaggregatedField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 200 - } - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, - "com.amazonaws.quicksight#UndefinedSpecifiedValueType": { - "type": "enum", - "members": { - "LEAST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LEAST" - } - }, - "MOST": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MOST" - } - } - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#UnicodeIcon": { - "type": "string", - "traits": { - "smithy.api#pattern": "^[^\\u0000-\\u00FF]$" - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UniqueValuesComputation": { - "type": "structure", - "members": { - "ComputationId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for a computation.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The name of a computation.

" - } - }, - "Category": { - "target": "com.amazonaws.quicksight#DimensionField", - "traits": { - "smithy.api#documentation": "

The category field that is used in a computation.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The unique values computation configuration.

" - } + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" }, - "com.amazonaws.quicksight#UnlimitedPixelLength": { - "type": "string", - "traits": { - "smithy.api#documentation": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.

\n

A namespace allows you to isolate the Amazon QuickSight users and groups that are registered\n for that namespace. Users that access the namespace can share assets only with other\n users or groups in the same namespace. They can't see users and groups in other\n namespaces. You can create a namespace after your Amazon Web Services account is subscribed to\n Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a\n limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with\n Amazon Web Services Support.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name that you want to use to describe the new namespace.

", + "smithy.api#required": {} + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

The tags that you want to associate with the namespace that you're creating.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateNamespaceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the Amazon QuickSight namespace you created.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name of the new namespace that you created.

" + } + }, + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable or non-retryable. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.

" + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateRoleMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateRoleMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateRoleMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to add to the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that the role belongs to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to add a group to.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UnsupportedPricingPlanException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#UnsupportedUserEditionException": { - "type": "structure", - "members": { - "Message": { - "target": "com.amazonaws.quicksight#String" - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tAmazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", - "smithy.api#error": "client", - "smithy.api#httpError": 403 - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UntagColumnOperation": { - "type": "structure", - "members": { - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", - "traits": { - "smithy.api#documentation": "

The column that this operation acts on.

", - "smithy.api#required": {} - } - }, - "TagNames": { - "target": "com.amazonaws.quicksight#ColumnTagNames", - "traits": { - "smithy.api#documentation": "

The column tags to remove from this column.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A transform operation that removes tags associated with a column.

" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UntagResource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UntagResourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UntagResourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Removes a tag or tags from a resource.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/resources/{ResourceArn}/tags", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#UntagResourceRequest": { - "type": "structure", - "members": { - "ResourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TagKeys": { - "target": "com.amazonaws.quicksight#TagKeyList", - "traits": { - "smithy.api#documentation": "

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

", - "smithy.api#httpQuery": "keys", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#UntagResourceResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UpdateAccountCustomization": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAccountCustomizationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAccountCustomizationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/customizations", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that you want to update Amazon QuickSight customizations for.

", - "smithy.api#httpQuery": "namespace" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create additional dashboards, templates, or analyses.

\n

A template is an entity in Amazon QuickSight that encapsulates the metadata\n\t\t\trequired to create an analysis and that you can use to create s dashboard. A template adds\n\t\t\ta layer of abstraction by using placeholders to replace the dataset associated with the\n\t\t\tanalysis. You can use templates to create dashboards by replacing dataset placeholders\n\t\t\twith datasets that follow the same schema that was used to create the source analysis\n\t\t\tand template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a template alias for a template.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you creating an alias for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name that you want to give to the template alias that you're creating. Don't start the\n\t\t\talias name with the $ character. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

Information about the template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in\n\t\t\teach Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

A display name for the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription field.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

\n

Either a SourceEntity or a Definition must be provided in \n\t\t\torder for the request to be valid.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTemplateResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template, including the version information of\n\t\t\tthe first version.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The template creation status.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a theme.

\n

A theme is set of configuration options for color and layout.\n\t\t\tThemes apply to analyses and dashboards. For more information, see Using\n\t\t\tThemes in Amazon QuickSight in the Amazon QuickSight User Guide.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a theme alias for a theme.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme for the new theme alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme alias.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name that you want to give to the theme alias that you are creating. The\n\t\t\talias name can't begin with a $. Alias names that start with $\n\t\t\tare reserved by Amazon QuickSight.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to store the new theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in\n\t\t\teach Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

A display name for the theme.

", + "smithy.api#required": {} + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes or choose Themes from\n\t\t\twithin an analysis.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the first version of the theme that you're creating. Every time\n\t\t\t\tUpdateTheme is called, a new version is created. Each version of the\n\t\t\ttheme has a description of the version in the VersionDescription\n\t\t\tfield.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

", + "smithy.api#required": {} + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A valid grouping of resource permissions to apply to the new theme.\n\t\t\t

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateThemeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The theme creation status.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new Q topic.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a topic refresh schedule.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic\n you're creating a refresh schedule for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to create a topic in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of a topic to create.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags that are assigned to\n the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region\n for each Amazon Web Services account.

" + } + }, + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CreateTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the CreateTopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Dataset arn for the CreateTopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Question": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The Question to be created.

", + "smithy.api#required": {} + } + }, + "Mir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The Mir for the CreateTopicReviewedAnswer.

" + } + }, + "PrimaryVisual": { + "target": "com.amazonaws.quicksight#TopicVisual", + "traits": { + "smithy.api#documentation": "

The PrimaryVisual for the CreateTopicReviewedAnswer.

" + } + }, + "Template": { + "target": "com.amazonaws.quicksight#TopicTemplate", + "traits": { + "smithy.api#documentation": "

The template for the CreateTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a CreateTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#CreateTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CreateTopicReviewedAnswer" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#CreateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#CreateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates a new VPC connection.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to create a new VPC\n\t\t\tconnection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

The IAM role to associate with the VPC connection.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

A map of the key-value pairs for the resource tag or tags assigned to the VPC\n\t\t\tconnection.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#CreateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted", + "traits": { + "smithy.api#documentation": "

The ID for the VPC connection that\n\t\t\tyou're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services\n\t\t\taccount.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the creation of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#CredentialPair": { + "type": "structure", + "members": { + "Username": { + "target": "com.amazonaws.quicksight#DbUsername", + "traits": { + "smithy.api#documentation": "

User name.

", + "smithy.api#required": {} + } + }, + "Password": { + "target": "com.amazonaws.quicksight#Password", + "traits": { + "smithy.api#documentation": "

Password.

", + "smithy.api#required": {} + } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters structure that's in the request with the\n structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters list is\n null, the DataSourceParameters originally used with these\n Credentials is automatically allowed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The combination of user name and password that are used as credentials.

" + } + }, + "com.amazonaws.quicksight#CrossDatasetTypes": { + "type": "enum", + "members": { + "ALL_DATASETS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_DATASETS" + } + }, + "SINGLE_DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_DATASET" + } + } + } + }, + "com.amazonaws.quicksight#CurrencyCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[A-Z]{3}$" + } + }, + "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the currency format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the currency format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "Symbol": { + "target": "com.amazonaws.quicksight#CurrencyCode", + "traits": { + "smithy.api#documentation": "

Determines the symbol for the currency format.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NumberScale": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

Determines the number scale value for the currency format.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the currency display format configuration.

" + } + }, + "com.amazonaws.quicksight#CustomActionColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#CustomActionFilterOperation": { + "type": "structure", + "members": { + "SelectedFieldsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the fields to be filtered.

", + "smithy.api#required": {} + } + }, + "TargetVisualsConfiguration": { + "target": "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the target visuals to be filtered.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" + } + }, + "com.amazonaws.quicksight#CustomActionNavigationOperation": { + "type": "structure", + "members": { + "LocalNavigationConfiguration": { + "target": "com.amazonaws.quicksight#LocalNavigationConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that chooses the navigation target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CustomActionSetParametersOperation": { + "type": "structure", + "members": { + "ParameterValueConfigurations": { + "target": "com.amazonaws.quicksight#SetParameterValueConfigurationList", + "traits": { + "smithy.api#documentation": "

The parameter that determines the value configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" + } + }, + "com.amazonaws.quicksight#CustomActionURLOperation": { + "type": "structure", + "members": { + "URLTemplate": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "

THe URL link of the CustomActionURLOperation.

", + "smithy.api#required": {} + } + }, + "URLTarget": { + "target": "com.amazonaws.quicksight#URLTargetConfiguration", + "traits": { + "smithy.api#documentation": "

The target of the CustomActionURLOperation.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" + } + }, + "com.amazonaws.quicksight#CustomColor": { + "type": "structure", + "members": { + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The data value that the color is applied to.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that is applied to the data value.

", + "smithy.api#required": {} + } + }, + "SpecialValue": { + "target": "com.amazonaws.quicksight#SpecialValue", + "traits": { + "smithy.api#documentation": "

The value of a special data value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color that's applied to a particular data value in a column.

" + } + }, + "com.amazonaws.quicksight#CustomColorsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#CustomColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#CustomContentConfiguration": { + "type": "structure", + "members": { + "ContentUrl": { + "target": "com.amazonaws.quicksight#URLOperationTemplate", + "traits": { + "smithy.api#documentation": "

The input URL that links to the custom content that you want in the custom visual.

" + } + }, + "ContentType": { + "target": "com.amazonaws.quicksight#CustomContentType", + "traits": { + "smithy.api#documentation": "

The content type of the custom content visual. You can use this to have the visual render as an image.

" + } + }, + "ImageScaling": { + "target": "com.amazonaws.quicksight#CustomContentImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" + } + }, + "com.amazonaws.quicksight#CustomContentImageScalingConfiguration": { + "type": "enum", + "members": { + "FIT_TO_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_HEIGHT" + } + }, + "FIT_TO_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_WIDTH" + } + }, + "DO_NOT_SCALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOT_SCALE" + } + }, + "SCALE_TO_VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCALE_TO_VISUAL" + } + } + } + }, + "com.amazonaws.quicksight#CustomContentType": { + "type": "enum", + "members": { + "IMAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IMAGE" + } + }, + "OTHER_EMBEDDED_CONTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER_EMBEDDED_CONTENT" + } + } + } + }, + "com.amazonaws.quicksight#CustomContentVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#CustomContentConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a CustomContentVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used to create the custom content visual. You can't create a visual without a dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#CustomFilterConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValue": { + "target": "com.amazonaws.quicksight#CategoryValue", + "traits": { + "smithy.api#documentation": "

The category value for the filter.

\n

This field is mutually exclusive to ParameterName.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to CategoryValue.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom filter that filters based on a single value. This filter can be partially matched.

" + } + }, + "com.amazonaws.quicksight#CustomFilterListConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

The list of category values for the filter.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of custom filter values.

" + } + }, + "com.amazonaws.quicksight#CustomLabel": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#CustomNarrativeOptions": { + "type": "structure", + "members": { + "Narrative": { + "target": "com.amazonaws.quicksight#NarrativeString", + "traits": { + "smithy.api#documentation": "

The string input of custom narrative.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom narrative options.

" + } + }, + "com.amazonaws.quicksight#CustomParameterValues": { + "type": "structure", + "members": { + "StringValues": { + "target": "com.amazonaws.quicksight#StringDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of string-type parameter values.

" + } + }, + "IntegerValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of integer-type parameter values.

" + } + }, + "DecimalValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of decimal-type parameter values.

" + } + }, + "DateTimeValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", + "traits": { + "smithy.api#documentation": "

A list of datetime-type parameter values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The customized parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#CustomSql": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#CustomSqlName", + "traits": { + "smithy.api#documentation": "

A display name for the SQL query result.

", + "smithy.api#required": {} + } + }, + "SqlQuery": { + "target": "com.amazonaws.quicksight#SqlQuery", + "traits": { + "smithy.api#documentation": "

The SQL query.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

The column schema from the SQL query result set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" + } + }, + "com.amazonaws.quicksight#CustomSqlName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#CustomValuesConfiguration": { + "type": "structure", + "members": { + "IncludeNullValue": { + "target": "com.amazonaws.quicksight#BooleanObject", + "traits": { + "smithy.api#documentation": "

Includes the null value in custom action parameter values.

" + } + }, + "CustomValues": { + "target": "com.amazonaws.quicksight#CustomParameterValues", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of custom values for the destination parameter in DestinationParameterValueConfiguration.

" + } + }, + "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The customer managed key that is registered to your Amazon QuickSight account is unavailable.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#Dashboard": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

Dashboard ID.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

A display name for the dashboard.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#DashboardVersion", + "traits": { + "smithy.api#documentation": "

Version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard was created.

" + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was published.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was updated.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard.

" + } + }, + "com.amazonaws.quicksight#DashboardBehavior": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#DashboardError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#DashboardErrorType", + "traits": { + "smithy.api#documentation": "

Type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Message.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

Lists the violated entities that caused the dashboard error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard error.

" + } + }, + "com.amazonaws.quicksight#DashboardErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#DashboardErrorType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "PARAMETER_VALUE_INCOMPATIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_VALUE_INCOMPATIBLE" + } + }, + "PARAMETER_TYPE_INVALID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_TYPE_INVALID" + } + }, + "PARAMETER_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_NOT_FOUND" + } + }, + "COLUMN_TYPE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_TYPE_MISMATCH" + } + }, + "COLUMN_GEOGRAPHIC_ROLE_MISMATCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" + } + }, + "COLUMN_REPLACEMENT_MISSING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN_REPLACEMENT_MISSING" + } + } + } + }, + "com.amazonaws.quicksight#DashboardFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_USER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DASHBOARD_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHBOARD_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DashboardName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#DashboardPublishOptions": { + "type": "structure", + "members": { + "AdHocFilteringOption": { + "target": "com.amazonaws.quicksight#AdHocFilteringOption", + "traits": { + "smithy.api#documentation": "

Ad hoc (one-time) filtering option.

" + } + }, + "ExportToCSVOption": { + "target": "com.amazonaws.quicksight#ExportToCSVOption", + "traits": { + "smithy.api#documentation": "

Export to .csv option.

" + } + }, + "SheetControlsOption": { + "target": "com.amazonaws.quicksight#SheetControlsOption", + "traits": { + "smithy.api#documentation": "

Sheet controls option.

" + } + }, + "VisualPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardVisualPublishOptions", + "traits": { + "smithy.api#deprecated": { + "message": "VisualPublishOptions property will reach its end of standard support in a future release. To perform this action, use ExportWithHiddenFields." + }, + "smithy.api#documentation": "

The visual publish options of a visual in a dashboard.

" + } + }, + "SheetLayoutElementMaximizationOption": { + "target": "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption", + "traits": { + "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" + } + }, + "VisualMenuOption": { + "target": "com.amazonaws.quicksight#VisualMenuOption", + "traits": { + "smithy.api#documentation": "

The menu options of a visual in a dashboard.

" + } + }, + "VisualAxisSortOption": { + "target": "com.amazonaws.quicksight#VisualAxisSortOption", + "traits": { + "smithy.api#documentation": "

The axis sort options of a dashboard.

" + } + }, + "ExportWithHiddenFieldsOption": { + "target": "com.amazonaws.quicksight#ExportWithHiddenFieldsOption", + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are exported with a dashboard.

" + } + }, + "DataPointDrillUpDownOption": { + "target": "com.amazonaws.quicksight#DataPointDrillUpDownOption", + "traits": { + "smithy.api#documentation": "

The drill-down options of data points in a dashboard.

" + } + }, + "DataPointMenuLabelOption": { + "target": "com.amazonaws.quicksight#DataPointMenuLabelOption", + "traits": { + "smithy.api#documentation": "

The data point menu label options of a dashboard.

" + } + }, + "DataPointTooltipOption": { + "target": "com.amazonaws.quicksight#DataPointTooltipOption", + "traits": { + "smithy.api#documentation": "

The data point tool tip options of a dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard publish options.

" + } + }, + "com.amazonaws.quicksight#DashboardSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"DASHBOARD_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DASHBOARD_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_USER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for dashboards.

" + } + }, + "com.amazonaws.quicksight#DashboardSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DashboardSourceEntity": { + "type": "structure", + "members": { + "SourceTemplate": { + "target": "com.amazonaws.quicksight#DashboardSourceTemplate", + "traits": { + "smithy.api#documentation": "

Source template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard source entity.

" + } + }, + "com.amazonaws.quicksight#DashboardSourceTemplate": { + "type": "structure", + "members": { + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

Dataset references.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard source template.

" + } + }, + "com.amazonaws.quicksight#DashboardSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

Dashboard ID.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

A display name for the dashboard.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was updated.

" + } + }, + "PublishedVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Published version number.

" + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dashboard was published.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard summary.

" + } + }, + "com.amazonaws.quicksight#DashboardSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DashboardUIState": { + "type": "enum", + "members": { + "EXPANDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPANDED" + } + }, + "COLLAPSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLAPSED" + } + } + } + }, + "com.amazonaws.quicksight#DashboardVersion": { + "type": "structure", + "members": { + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard version was created.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this dashboard version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Version number for this version of the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Source entity ARN.

" + } + }, + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

Description.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme associated with a version of the dashboard.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard version.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionDefinition": { + "type": "structure", + "members": { + "DataSetIdentifierDeclarations": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of dataset identifier declarations. With\n this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for a dashboard.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the dashboard.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

The filter definitions for a dashboard.

\n

For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of dashboard-level column configurations. Column configurations\n are used to set the default formatting for a column that\n is used throughout a dashboard.

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for a dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The contents of a dashboard.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dashboard version was created.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Version number.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Source entity ARN.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

Description.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dashboard version summary.

" + } + }, + "com.amazonaws.quicksight#DashboardVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DashboardVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DashboardVisualId": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

", + "smithy.api#required": {} + } + }, + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the following elements:

\n \n

The DashboardId, SheetId, and VisualId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.

" + } + }, + "com.amazonaws.quicksight#DashboardVisualPublishOptions": { + "type": "structure", + "members": { + "ExportHiddenFieldsOption": { + "target": "com.amazonaws.quicksight#ExportHiddenFieldsOption", + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual publish options of a visual in a dashboard

" + } + }, + "com.amazonaws.quicksight#DataAggregation": { + "type": "structure", + "members": { + "DatasetRowDateGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultDateColumnName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The column name for the default date.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a data aggregation.

" + } + }, + "com.amazonaws.quicksight#DataBarsOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for the data bars options.

", + "smithy.api#required": {} + } + }, + "PositiveColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the positive data bar.

" + } + }, + "NegativeColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the negative data bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for data bars.

" + } + }, + "com.amazonaws.quicksight#DataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that is applied to the data value.

" + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The data value that the color is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the color that is applied to a particular data value.

" + } + }, + "com.amazonaws.quicksight#DataColorPalette": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#ColorList", + "traits": { + "smithy.api#documentation": "

The hexadecimal codes for the colors.

" + } + }, + "MinMaxGradient": { + "target": "com.amazonaws.quicksight#ColorList", + "traits": { + "smithy.api#documentation": "

The minimum and maximum hexadecimal codes that describe a color gradient.

" + } + }, + "EmptyFillColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hexadecimal code of a color that applies to charts where a lack of data is\n highlighted.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme colors that are used for data colors in charts. The colors description is a\n hexadecimal color code that consists of six alphanumerical characters, prefixed with\n #, for example #37BFF5.

" + } + }, + "com.amazonaws.quicksight#DataFieldSeriesItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that you are setting the axis binding to.

", + "smithy.api#required": {} + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The field value of the field that you are setting the axis binding to.

" + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis that you are binding the field to.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.quicksight#LineChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data field series item configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#DataLabelContent": { + "type": "enum", + "members": { + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + }, + "VALUE_AND_PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENT" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the data labels.

" + } + }, + "CategoryLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the category field labels.

" + } + }, + "MeasureLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the measure field labels.

" + } + }, + "DataLabelTypes": { + "target": "com.amazonaws.quicksight#DataLabelTypes", + "traits": { + "smithy.api#documentation": "

The option that determines the data label type.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#DataLabelPosition", + "traits": { + "smithy.api#documentation": "

Determines the position of the data labels.

" + } + }, + "LabelContent": { + "target": "com.amazonaws.quicksight#DataLabelContent", + "traits": { + "smithy.api#documentation": "

Determines the content of the data labels.

" + } + }, + "LabelFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

Determines the font configuration of the data labels.

" + } + }, + "LabelColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the data labels.

" + } + }, + "Overlap": { + "target": "com.amazonaws.quicksight#DataLabelOverlap", + "traits": { + "smithy.api#documentation": "

Determines whether overlap is enabled or disabled for the data labels.

" + } + }, + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the total.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "com.amazonaws.quicksight#DataLabelOverlap": { + "type": "enum", + "members": { + "DISABLE_OVERLAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLE_OVERLAP" + } + }, + "ENABLE_OVERLAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLE_OVERLAP" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelPosition": { + "type": "enum", + "members": { + "INSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIDE" + } + }, + "OUTSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTSIDE" + } + }, + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#DataLabelType": { + "type": "structure", + "members": { + "FieldLabelType": { + "target": "com.amazonaws.quicksight#FieldLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the entire field.

" + } + }, + "DataPathLabelType": { + "target": "com.amazonaws.quicksight#DataPathLabelType", + "traits": { + "smithy.api#documentation": "

The option that specifies individual data values for labels.

" + } + }, + "RangeEndsLabelType": { + "target": "com.amazonaws.quicksight#RangeEndsLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for range end value in a visual.

" + } + }, + "MinimumLabelType": { + "target": "com.amazonaws.quicksight#MinimumLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the minimum value in a visual.

" + } + }, + "MaximumLabelType": { + "target": "com.amazonaws.quicksight#MaximumLabelType", + "traits": { + "smithy.api#documentation": "

Determines the label configuration for the maximum value in a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the data label type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DataLabelTypes": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataLabelType" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DataPathColor": { + "type": "structure", + "members": { + "Element": { + "target": "com.amazonaws.quicksight#DataPathValue", + "traits": { + "smithy.api#documentation": "

The element that the color needs to be applied to.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that needs to be applied to the element.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the field that the color needs to be applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color map that determines the color options for a particular element.

" + } + }, + "com.amazonaws.quicksight#DataPathColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataPathColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.quicksight#DataPathLabelType": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that the data label needs to be applied to.

" + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The actual value of the field that is labeled.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the data label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that specifies individual data values for labels.

" + } + }, + "com.amazonaws.quicksight#DataPathSort": { + "type": "structure", + "members": { + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

Determines the sort direction.

", + "smithy.api#required": {} + } + }, + "SortPaths": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The list of data paths that need to be sorted.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Allows data paths to be sorted by a specific data value.

" + } + }, + "com.amazonaws.quicksight#DataPathType": { + "type": "structure", + "members": { + "PivotTableDataPathType": { + "target": "com.amazonaws.quicksight#PivotTableDataPathType", + "traits": { + "smithy.api#documentation": "

The type of data path value utilized in a pivot table. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of the data path value.

" + } + }, + "com.amazonaws.quicksight#DataPathValue": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field that needs to be sorted.

" + } + }, + "FieldValue": { + "target": "com.amazonaws.quicksight#FieldValue", + "traits": { + "smithy.api#documentation": "

The actual value of the field that needs to be sorted.

" + } + }, + "DataPathType": { + "target": "com.amazonaws.quicksight#DataPathType", + "traits": { + "smithy.api#documentation": "

The type configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data path that needs to be sorted.

" + } + }, + "com.amazonaws.quicksight#DataPathValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataPathValue" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#DataPointDrillUpDownOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the drill down options of data points.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The drill down options for data points in a dashbaord.

" + } + }, + "com.amazonaws.quicksight#DataPointMenuLabelOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the data point menu options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data point menu options of a dashboard.

" + } + }, + "com.amazonaws.quicksight#DataPointTooltipOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the data point tool tip options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data point tooltip options.

" + } + }, + "com.amazonaws.quicksight#DataSet": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the dataset.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dataset was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dataset was updated.

" + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

" + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical\n tables.

" + } + }, + "OutputColumns": { + "target": "com.amazonaws.quicksight#OutputColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" + } + }, + "ConsumedSpiceCapacityInBytes": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.

" + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the dataset.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The element you can use to define tags for row-level security.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration", + "traits": { + "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" + } + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that are declared in a dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset.

" + } + }, + "com.amazonaws.quicksight#DataSetArnsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DataSetCalculatedFieldExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 250000 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#DataSetConfiguration": { + "type": "structure", + "members": { + "Placeholder": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Placeholder.

" + } + }, + "DataSetSchema": { + "target": "com.amazonaws.quicksight#DataSetSchema", + "traits": { + "smithy.api#documentation": "

Dataset schema.

" + } + }, + "ColumnGroupSchemaList": { + "target": "com.amazonaws.quicksight#ColumnGroupSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of column group schemas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset configuration.

" + } + }, + "com.amazonaws.quicksight#DataSetConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 30 + } + } + }, + "com.amazonaws.quicksight#DataSetFilterAttribute": { + "type": "enum", + "members": { + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DATASET_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DataSetIdentifier": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#DataSetIdentifierDeclaration": { + "type": "structure", + "members": { + "Identifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The identifier of the data set, typically the data set's name.

", + "smithy.api#required": {} + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data set.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A data set.

" + } + }, + "com.amazonaws.quicksight#DataSetIdentifierDeclarationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetIdentifierDeclaration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DataSetImportMode": { + "type": "enum", + "members": { + "SPICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPICE" + } + }, + "DIRECT_QUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUERY" + } + } + } + }, + "com.amazonaws.quicksight#DataSetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DataSetReference": { + "type": "structure", + "members": { + "DataSetPlaceholder": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Dataset placeholder.

", + "smithy.api#required": {} + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

Dataset Amazon Resource Name (ARN).

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset reference.

" + } + }, + "com.amazonaws.quicksight#DataSetReferenceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetReference" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#DataSetRefreshProperties": { + "type": "structure", + "members": { + "RefreshConfiguration": { + "target": "com.amazonaws.quicksight#RefreshConfiguration", + "traits": { + "smithy.api#documentation": "

The refresh configuration for a dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh properties of a dataset.

" + } + }, + "com.amazonaws.quicksight#DataSetRegion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#DataSetSchema": { + "type": "structure", + "members": { + "ColumnSchemaList": { + "target": "com.amazonaws.quicksight#ColumnSchemaList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of column schemas.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset schema.

" + } + }, + "com.amazonaws.quicksight#DataSetSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose datasets you want to search in the \"Value\" field. For example, \"Name\":\"QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east- 1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the datasets you are searching for. For example, \"Name\":\"DATASET_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASET_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DataSetFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for datasets.

" + } + }, + "com.amazonaws.quicksight#DataSetSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DataSetSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the dataset.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this dataset was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this dataset was updated.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

A value that indicates whether you want to import the data into SPICE.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the dataset.

" + } + }, + "RowLevelPermissionTagConfigurationApplied": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Whether or not the row level permission tags are applied.

" + } + }, + "ColumnLevelPermissionRulesApplied": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A value that indicates if the dataset has column level permission configured.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Dataset summary.

" + } + }, + "com.amazonaws.quicksight#DataSetSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSetSummary" + } + }, + "com.amazonaws.quicksight#DataSetUsageConfiguration": { + "type": "structure", + "members": { + "DisableUseAsDirectQuerySource": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option that controls whether a child dataset of a direct query can use this dataset as a source.

" + } + }, + "DisableUseAsImportedSource": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The usage configuration to apply to child datasets that reference this dataset as a source.

" + } + }, + "com.amazonaws.quicksight#DataSource": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each\n Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source. This type indicates which database engine the data source\n connects to.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this data source was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this data source was updated.

" + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.

" + } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "

A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters structure that's in the request\n with the structures in the AlternateDataSourceParameters allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters list is null,\n the Credentials originally used with this DataSourceParameters\n are automatically allowed.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

The VPC connection information. You need to use this parameter only when you want\n Amazon QuickSight to use a VPC connection when connecting to your underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying source.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfo", + "traits": { + "smithy.api#documentation": "

Error information from the last update or the creation of the data source.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure of a data source.

" + } + }, + "com.amazonaws.quicksight#DataSourceCredentials": { + "type": "structure", + "members": { + "CredentialPair": { + "target": "com.amazonaws.quicksight#CredentialPair", + "traits": { + "smithy.api#documentation": "

Credential pair. For more information, see\n \n CredentialPair\n .

" + } + }, + "CopySourceArn": { + "target": "com.amazonaws.quicksight#CopySourceArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials structure.

" + } + }, + "SecretArn": { + "target": "com.amazonaws.quicksight#SecretArn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Data source credentials. This is a variant type structure. For this structure to be\n valid, only one of the attributes can be non-null.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#DataSourceErrorInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfoType", + "traits": { + "smithy.api#documentation": "

Error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error information for the data source creation or update.

" + } + }, + "com.amazonaws.quicksight#DataSourceErrorInfoType": { + "type": "enum", + "members": { + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + }, + "COPY_SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COPY_SOURCE_NOT_FOUND" + } + }, + "TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMEOUT" + } + }, + "ENGINE_VERSION_NOT_SUPPORTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENGINE_VERSION_NOT_SUPPORTED" + } + }, + "UNKNOWN_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN_HOST" + } + }, + "GENERIC_SQL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GENERIC_SQL_FAILURE" + } + }, + "CONFLICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONFLICT" + } + }, + "UNKNOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNKNOWN" + } + } + } + }, + "com.amazonaws.quicksight#DataSourceFilterAttribute": { + "type": "enum", + "members": { + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DATASOURCE_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASOURCE_NAME" + } + } + } + }, + "com.amazonaws.quicksight#DataSourceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSource" + } + }, + "com.amazonaws.quicksight#DataSourceParameters": { + "type": "union", + "members": { + "AmazonElasticsearchParameters": { + "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "AthenaParameters": { + "target": "com.amazonaws.quicksight#AthenaParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Athena.

" + } + }, + "AuroraParameters": { + "target": "com.amazonaws.quicksight#AuroraParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Aurora MySQL.

" + } + }, + "AuroraPostgreSqlParameters": { + "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Aurora.

" + } + }, + "AwsIotAnalyticsParameters": { + "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", + "traits": { + "smithy.api#documentation": "

The parameters for IoT Analytics.

" + } + }, + "JiraParameters": { + "target": "com.amazonaws.quicksight#JiraParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Jira.

" + } + }, + "MariaDbParameters": { + "target": "com.amazonaws.quicksight#MariaDbParameters", + "traits": { + "smithy.api#documentation": "

The parameters for MariaDB.

" + } + }, + "MySqlParameters": { + "target": "com.amazonaws.quicksight#MySqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for MySQL.

" + } + }, + "OracleParameters": { + "target": "com.amazonaws.quicksight#OracleParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Oracle.

" + } + }, + "PostgreSqlParameters": { + "target": "com.amazonaws.quicksight#PostgreSqlParameters", + "traits": { + "smithy.api#documentation": "

The parameters for PostgreSQL.

" + } + }, + "PrestoParameters": { + "target": "com.amazonaws.quicksight#PrestoParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Presto.

" + } + }, + "RdsParameters": { + "target": "com.amazonaws.quicksight#RdsParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon RDS.

" + } + }, + "RedshiftParameters": { + "target": "com.amazonaws.quicksight#RedshiftParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Redshift.

" + } + }, + "S3Parameters": { + "target": "com.amazonaws.quicksight#S3Parameters", + "traits": { + "smithy.api#documentation": "

The parameters for S3.

" + } + }, + "ServiceNowParameters": { + "target": "com.amazonaws.quicksight#ServiceNowParameters", + "traits": { + "smithy.api#documentation": "

The parameters for ServiceNow.

" + } + }, + "SnowflakeParameters": { + "target": "com.amazonaws.quicksight#SnowflakeParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Snowflake.

" + } + }, + "SparkParameters": { + "target": "com.amazonaws.quicksight#SparkParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Spark.

" + } + }, + "SqlServerParameters": { + "target": "com.amazonaws.quicksight#SqlServerParameters", + "traits": { + "smithy.api#documentation": "

The parameters for SQL Server.

" + } + }, + "TeradataParameters": { + "target": "com.amazonaws.quicksight#TeradataParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Teradata.

" + } + }, + "TwitterParameters": { + "target": "com.amazonaws.quicksight#TwitterParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Twitter.

" + } + }, + "AmazonOpenSearchParameters": { + "target": "com.amazonaws.quicksight#AmazonOpenSearchParameters", + "traits": { + "smithy.api#documentation": "

The parameters for OpenSearch.

" + } + }, + "ExasolParameters": { + "target": "com.amazonaws.quicksight#ExasolParameters", + "traits": { + "smithy.api#documentation": "

The parameters for Exasol.

" + } + }, + "DatabricksParameters": { + "target": "com.amazonaws.quicksight#DatabricksParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" + } + }, + "StarburstParameters": { + "target": "com.amazonaws.quicksight#StarburstParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" + } + }, + "TrinoParameters": { + "target": "com.amazonaws.quicksight#TrinoParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" + } + }, + "BigQueryParameters": { + "target": "com.amazonaws.quicksight#BigQueryParameters", + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Google BigQuery data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying data source.\n This is a variant type structure. For this structure to be valid, only one of the\n attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#DataSourceParametersList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceParameters" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DataSourceSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose data sources you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the data sources you are searching for. For example, \"Name\":\"DATASOURCE_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value DATASOURCE_NAME.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DataSourceFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example, \"Name\":\n \"DIRECT_QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that you apply when searching for data sources.

" + } + }, + "com.amazonaws.quicksight#DataSourceSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DataSourceSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The arn of the datasource.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The unique ID of the data source.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the data source.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", + "traits": { + "smithy.api#documentation": "

The type of the data source.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A DataSourceSummary object that returns a summary of a data source.

" + } + }, + "com.amazonaws.quicksight#DataSourceSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DataSourceSummary" + } + }, + "com.amazonaws.quicksight#DataSourceType": { + "type": "enum", + "members": { + "ADOBE_ANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADOBE_ANALYTICS" + } + }, + "AMAZON_ELASTICSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_ELASTICSEARCH" + } + }, + "ATHENA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATHENA" + } + }, + "AURORA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AURORA" + } + }, + "AURORA_POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AURORA_POSTGRESQL" + } + }, + "AWS_IOT_ANALYTICS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AWS_IOT_ANALYTICS" + } + }, + "GITHUB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GITHUB" + } + }, + "JIRA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIRA" + } + }, + "MARIADB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MARIADB" + } + }, + "MYSQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MYSQL" + } + }, + "ORACLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ORACLE" + } + }, + "POSTGRESQL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTGRESQL" + } + }, + "PRESTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRESTO" + } + }, + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + }, + "S3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3" + } + }, + "SALESFORCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SALESFORCE" + } + }, + "SERVICENOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SERVICENOW" + } + }, + "SNOWFLAKE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SNOWFLAKE" + } + }, + "SPARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPARK" + } + }, + "SQLSERVER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQLSERVER" + } + }, + "TERADATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TERADATA" + } + }, + "TWITTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TWITTER" + } + }, + "TIMESTREAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TIMESTREAM" + } + }, + "AMAZON_OPENSEARCH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AMAZON_OPENSEARCH" + } + }, + "EXASOL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXASOL" + } + }, + "DATABRICKS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATABRICKS" + } + }, + "STARBURST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARBURST" + } + }, + "TRINO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRINO" + } + }, + "BIGQUERY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIGQUERY" + } + } + } + }, + "com.amazonaws.quicksight#Database": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DatabaseGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DatabaseGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatabaseGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#DatabaseUser": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DatabricksParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Databricks data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Databricks data source.

", + "smithy.api#required": {} + } + }, + "SqlEndpointPath": { + "target": "com.amazonaws.quicksight#SqlEndpointPath", + "traits": { + "smithy.api#documentation": "

The HTTP path of the Databricks data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Databricks data source.

" + } + }, + "com.amazonaws.quicksight#DatasetMetadata": { + "type": "structure", + "members": { + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

", + "smithy.api#required": {} + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "DatasetDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the dataset.

" + } + }, + "DataAggregation": { + "target": "com.amazonaws.quicksight#DataAggregation", + "traits": { + "smithy.api#documentation": "

The definition of a data aggregation.

" + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicFilters", + "traits": { + "smithy.api#documentation": "

The list of filter definitions.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#TopicColumns", + "traits": { + "smithy.api#documentation": "

The list of column definitions.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#TopicCalculatedFields", + "traits": { + "smithy.api#documentation": "

The list of calculated field definitions.

" + } + }, + "NamedEntities": { + "target": "com.amazonaws.quicksight#TopicNamedEntities", + "traits": { + "smithy.api#documentation": "

The list of named entities definitions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a dataset.

" + } + }, + "com.amazonaws.quicksight#DatasetParameter": { + "type": "structure", + "members": { + "StringDatasetParameter": { + "target": "com.amazonaws.quicksight#StringDatasetParameter", + "traits": { + "smithy.api#documentation": "

A string parameter that is created in the dataset.

" + } + }, + "DecimalDatasetParameter": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameter", + "traits": { + "smithy.api#documentation": "

A decimal parameter that is created in the dataset.

" + } + }, + "IntegerDatasetParameter": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameter", + "traits": { + "smithy.api#documentation": "

An integer parameter that is created in the dataset.

" + } + }, + "DateTimeDatasetParameter": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameter", + "traits": { + "smithy.api#documentation": "

A date time parameter that is created in the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter that is created in a dataset. The parameter can be a string, integer, decimal, or datetime data type.

" + } + }, + "com.amazonaws.quicksight#DatasetParameterId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetParameter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DatasetParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.quicksight#DatasetParameterValueType": { + "type": "enum", + "members": { + "MULTI_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_VALUED" + } + }, + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value type of the parameter. The value type is used to validate the parameter before it is evaluated.

" + } + }, + "com.amazonaws.quicksight#Datasets": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DatasetMetadata" + } + }, + "com.amazonaws.quicksight#DateAggregationFunction": { + "type": "enum", + "members": { + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + } + } + }, + "com.amazonaws.quicksight#DateAxisOptions": { + "type": "structure", + "members": { + "MissingDateVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not missing dates are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine how a date axis is displayed.

" + } + }, + "com.amazonaws.quicksight#DateDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the DateDimensionField.

", + "smithy.api#required": {} + } + }, + "DateGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The date granularity of the DateDimensionField. Choose one of the following options:

\n " + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with date type columns.

" + } + }, + "com.amazonaws.quicksight#DateMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the DateMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#DateAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with date type columns.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the date time parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity of the date time parameter.

" + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given date time parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A date time parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue": { + "type": "timestamp", + "traits": { + "smithy.api#documentation": "

The default value for the date time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a date time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DateTimeDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#DateTimeDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DataTimeDefaultValues.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the DateTimeParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#DateTimeFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#DateTimeFormatConfiguration": { + "type": "structure", + "members": { + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Determines the DateTime format.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "NumericFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The formatting configuration for numeric DateTime fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" + } + }, + "com.amazonaws.quicksight#DateTimeHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the DateTime hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the\n DateTime hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the hierarchy of any DateTime fields.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for the date-time parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveTimestampList", + "traits": { + "smithy.api#documentation": "

The values for the date-time parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A date-time parameter.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameterDeclaration": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DateTimeDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" + } + }, + "com.amazonaws.quicksight#DateTimeParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DateTimeParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Customize how dates are formatted in controls.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + }, + "HelperTextVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The helper text visibility of the DateTimePickerControlDisplayOptions.

" + } + }, + "DateIconVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The date icon visibility of the DateTimePickerControlDisplayOptions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#DateTimeValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp", + "traits": { + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a DateTime parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#DayOfMonth": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 17 + }, + "smithy.api#pattern": "^(?:LAST_DAY_OF_MONTH|1[0-9]|2[0-8]|[12]|[3-9])$" + } + }, + "com.amazonaws.quicksight#DayOfTheWeek": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.quicksight#DayOfWeek": { + "type": "enum", + "members": { + "SUNDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUNDAY" + } + }, + "MONDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONDAY" + } + }, + "TUESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TUESDAY" + } + }, + "WEDNESDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEDNESDAY" + } + }, + "THURSDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THURSDAY" + } + }, + "FRIDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRIDAY" + } + }, + "SATURDAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SATURDAY" + } + } + } + }, + "com.amazonaws.quicksight#DbUsername": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the decimal parameter created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the decimal parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given decimal parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A decimal parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The default value for the decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#DecimalDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveDoubleObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#DecimalDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the DecimalParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#DecimalParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for the decimal parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveDoubleList", + "traits": { + "smithy.api#documentation": "

The values for the decimal parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A decimal parameter.

" + } + }, + "com.amazonaws.quicksight#DecimalParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#DecimalDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" + } + }, + "com.amazonaws.quicksight#DecimalParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DecimalParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#DecimalPlaces": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#DecimalPlacesConfiguration": { + "type": "structure", + "members": { + "DecimalPlaces": { + "target": "com.amazonaws.quicksight#DecimalPlaces", + "traits": { + "smithy.api#documentation": "

The values of the decimal places.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "com.amazonaws.quicksight#DecimalValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveDouble", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a Decimal parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#DefaultAggregation": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + } + } + }, + "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", + "traits": { + "smithy.api#documentation": "

The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options:

\n " + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterControlConfiguration": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.

", + "smithy.api#required": {} + } + }, + "ControlOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterControlOptions", + "traits": { + "smithy.api#documentation": "

The control option for the DefaultFilterControlConfiguration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The default configuration for all dependent controls of the filter.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterControlOptions": { + "type": "structure", + "members": { + "DefaultDateTimePickerOptions": { + "target": "com.amazonaws.quicksight#DefaultDateTimePickerControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the filter control type of a DateTimePicker.

" + } + }, + "DefaultListOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterListControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" + } + }, + "DefaultDropdownOptions": { + "target": "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" + } + }, + "DefaultTextFieldOptions": { + "target": "com.amazonaws.quicksight#DefaultTextFieldControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" + } + }, + "DefaultTextAreaOptions": { + "target": "com.amazonaws.quicksight#DefaultTextAreaControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" + } + }, + "DefaultSliderOptions": { + "target": "com.amazonaws.quicksight#DefaultSliderControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" + } + }, + "DefaultRelativeDateTimeOptions": { + "target": "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions", + "traits": { + "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that corresponds to the control type of the filter.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterDropDownControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Dropdown filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultFilterListControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the DefaultFilterListControlOptions. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the List filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultFormatting": { + "type": "structure", + "members": { + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format. Valid values for this structure are AUTO,\n PERCENT, CURRENCY, NUMBER, DATE, and\n STRING.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions", + "traits": { + "smithy.api#documentation": "

The additional options for display formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a default formatting definition.

" + } + }, + "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a free-form layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultGridLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a grid layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration": { + "type": "structure", + "members": { + "Grid": { + "target": "com.amazonaws.quicksight#DefaultGridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a grid layout configuration.

" + } + }, + "FreeForm": { + "target": "com.amazonaws.quicksight#DefaultFreeFormLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings of a free-form layout configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultNewSheetConfiguration": { + "type": "structure", + "members": { + "InteractiveLayoutConfiguration": { + "target": "com.amazonaws.quicksight#DefaultInteractiveLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for interactive layout configuration.

" + } + }, + "PaginatedLayoutConfiguration": { + "target": "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" + } + }, + "SheetContentType": { + "target": "com.amazonaws.quicksight#SheetContentType", + "traits": { + "smithy.api#documentation": "

The option that determines the sheet content type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for default new sheet settings.

" + } + }, + "com.amazonaws.quicksight#DefaultPaginatedLayoutConfiguration": { + "type": "structure", + "members": { + "SectionBased": { + "target": "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a paginated layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultRelativeDateTimeControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the RelativeDateTime filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultSectionBasedLayoutConfiguration": { + "type": "structure", + "members": { + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

Determines the screen canvas size options for a section-based layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default settings for a section-based layout configuration.

" + } + }, + "com.amazonaws.quicksight#DefaultSliderControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlSliderType", + "traits": { + "smithy.api#documentation": "

The type of the DefaultSliderControlOptions. Choose one of the following options:

\n " + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the Slider filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultTextAreaControlOptions": { + "type": "structure", + "members": { + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextArea filter control type.

" + } + }, + "com.amazonaws.quicksight#DefaultTextFieldControlOptions": { + "type": "structure", + "members": { + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default options that correspond to the TextField filter control type.

" + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UpdateAccountCustomizationResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace associated with the customization that you're updating.

" - } - }, - "AccountCustomization": { - "target": "com.amazonaws.quicksight#AccountCustomization", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ConflictException" }, - "com.amazonaws.quicksight#UpdateAccountSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAccountSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAccountSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the Amazon QuickSight settings in your Amazon Web Services account.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/settings", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UpdateAccountSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to\n list.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DefaultNamespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with Amazon QuickSight provide an email address that becomes\n associated with the default namespace.\n

", - "smithy.api#required": {} - } - }, - "NotificationEmail": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.

" - } - }, - "TerminationProtectionEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#UpdateAnalysis": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAnalysisRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAnalysisResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an analysis in Amazon QuickSight

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, - "com.amazonaws.quicksight#UpdateAnalysisPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the read and write permissions for an analysis.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n updating. You must be using the Amazon Web Services account that the analysis is in.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the permissions to add and the principal to add them\n to.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the permissions to remove and the principal to remove them\n from.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" }, - "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { - "type": "structure", - "members": { - "AnalysisArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you updated.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis that you updated permissions for.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified\n Amazon Web Services account and Amazon QuickSight namespace.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in\n this Amazon Web Services Region.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you're deleting the customizations from.

", + "smithy.api#httpQuery": "namespace" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DeleteAccountSubscription 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 True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscriptionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAccountSubscriptionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during\n which you can restore the analysis. If you don't specify a recovery window value, the\n operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to\n the response that specifies the end of the recovery window. At the end of the recovery\n window, Amazon QuickSight deletes the analysis permanently.

\n

At any time before recovery window ends, you can use the RestoreAnalysis\n API operation to remove the DeletionTime stamp and cancel the deletion of\n the analysis. The analysis remains visible in the API until it's deleted, so you can\n describe it but you can't make a template from it.

\n

An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console.\n To access it in the console, restore it. Deleting an analysis doesn't delete the\n dashboards that you publish from it.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account where you want to delete an analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecoveryWindowInDays": { + "target": "com.amazonaws.quicksight#RecoveryWindowInDays", + "traits": { + "smithy.api#documentation": "

A value that specifies the number of days that Amazon QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery\n option in the same API call. The default value is 30.

", + "smithy.api#httpQuery": "recovery-window-in-days" + } + }, + "ForceDeleteWithoutRecovery": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

This option defaults to the value NoForceDeleteWithoutRecovery. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery option.\n You can't restore an analysis after it's deleted.

", + "smithy.api#httpQuery": "force-delete-without-recovery" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteAnalysisResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted analysis.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the deleted analysis.

" + } + }, + "DeletionTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the analysis is scheduled to be deleted.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dashboard.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDashboardResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Secure Socket Layer (SSL) properties that apply for the resource.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the dataset refresh properties of the dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the data source permanently. This operation breaks \n\t\t\tall the datasets that reference the deleted data source.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source that you deleted.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an empty folder.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteFolderMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteFolderMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteFolderMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes an asset, such as a dashboard, analysis, or dataset, from a folder.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members/{MemberType}/{MemberId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteFolderMembershipRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Folder ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the asset that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The member type of the asset that you want to delete from a folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderMembershipResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name of the deleted folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user group from Amazon QuickSight.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a user from a group so that the user is no longer a member of the group.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to delete from the group membership.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete the user from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to remove a user from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteGroupResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes an existing IAM policy assignment.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespace/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID where you want to delete the IAM\n\t\t\tpolicy assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfigRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteIdentityPropagationConfigResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a namespace and the users and groups that are associated with the namespace.\n This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not \n deleted. To delete these assets, you use the API operations for the relevant asset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteNamespaceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a refresh schedule from a dataset.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes custom permissions from the role.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to remove permissions from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteRoleMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteRoleMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a group from a role.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteRoleMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The role that you want to remove permissions from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteRoleMembershipResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a template.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the item that the specified template alias points to. If you provide a specific\n\t\t\talias, you delete the version of the template that the alias points to.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the item to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template that the specified alias is for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the template alias. To delete a specific alias, you delete the version that the\n\t\t\talias points to. You can specify the alias name, or specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template associated with the deletion.

" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the template alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template you want to delete.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

Specifies the version of the template that you want to delete.\n\t\t\tIf you don't provide a version number, DeleteTemplate deletes all versions of the template.\n\t

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTemplateResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the template.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a theme.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the version of the theme that the specified theme alias points to. \n\t\t\tIf you provide a specific alias, you delete the version of the theme \n\t\t\tthat the alias points to.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme that the specified alias is for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The unique name for the theme alias to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeAliasResponse": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name for the theme alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme associated with the deletion.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're deleting.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version of the theme that you want to delete.

\n

\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme to delete all versions of the theme.

", + "smithy.api#httpQuery": "version-number" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteThemeResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the theme.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic refresh schedule.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes the Amazon QuickSight user that is associated with the identity of the\n\t\t\tIAM user or role that's making the call. The IAM user\n\t\t\tisn't deleted as a result of this call.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalId": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a user identified by its principal ID.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/user-principals/{PrincipalId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest": { + "type": "structure", + "members": { + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

", + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteUserByPrincipalIdResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to delete.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteUserResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DeleteVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DeleteVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a VPC connection.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account where you want to delete a VPC\n\t\t\tconnection.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DeleteVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the deleted VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

" + } + }, + "DeletionStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The deletion status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Delimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the customizations associated with the provided Amazon Web Services account and Amazon\n Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.

\n

To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations\n for.

", + "smithy.api#httpQuery": "namespace" + } + }, + "Resolved": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The Resolved flag works with the other parameters to determine which view\n of Amazon QuickSight customizations is returned. You can add this flag to your command to use\n the same view that Amazon QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved, to reveal customizations\n that are configured at different levels.

", + "smithy.api#httpQuery": "resolved" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you're describing.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that you're describing.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the settings that were used when your Amazon QuickSight subscription was first\n created in this Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the settings that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { + "type": "structure", + "members": { + "AccountSettings": { + "target": "com.amazonaws.quicksight#AccountSettings", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight settings for this Amazon Web Services account. This information\n includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or\n Enterprise) and the notification email for the Amazon QuickSight subscription.

\n

In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to\n as a QuickSight \"account\" even though it's technically not an account by\n itself. Instead, it's a subscription to the Amazon QuickSight service for your\n Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscription": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

", + "smithy.api#http": { + "method": "GET", + "uri": "/account/{AwsAccountId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscriptionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAccountSubscriptionResponse": { + "type": "structure", + "members": { + "AccountInfo": { + "target": "com.amazonaws.quicksight#AccountInfo", + "traits": { + "smithy.api#documentation": "

A structure that contains the following elements:

\n " + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary of the metadata for an analysis.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of an analysis.

\n \n

If you do not need to know details about the content of an Analysis, for instance if you\n are trying to check the status of a recently created or updated Analysis, use the\n \n DescribeAnalysis\n instead.\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the\n Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisDefinitionResponse": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis described.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the analysis.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the analysis.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the analysis.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the analysis.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides the read and write permissions for an analysis.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n describing. You must be using the Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { + "type": "structure", + "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're describing.

" + } + }, + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis whose permissions you're\n describing.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis. You must be using the \n Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're describing. The ID is part of the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAnalysisResponse": { + "type": "structure", + "members": { + "Analysis": { + "target": "com.amazonaws.quicksight#Analysis", + "traits": { + "smithy.api#documentation": "

A metadata structure that contains summary information for the analysis that you're\n describing.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing export job.

\n

Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed.

\n

Job descriptions are available for 14 days after the job starts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/{AssetBundleExportJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the export job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleExportJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.

" + } + }, + "DownloadUrl": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

The URL to download the exported asset bundle data from.

\n

This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed.

\n

The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension.

\n

This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the export job was created.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export job was executed in.

" + } + }, + "ResourceArns": { + "target": "com.amazonaws.quicksight#AssetBundleResourceArns", + "traits": { + "smithy.api#documentation": "

A list of resource ARNs that exported with the job.

" + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include dependencies flag.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.

" + } + }, + "CloudFormationOverridePropertyConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", + "traits": { + "smithy.api#documentation": "

The CloudFormation override property configuration for the export job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include permissions flag.

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The include tags flag.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", + "traits": { + "smithy.api#documentation": "

The validation strategy that is used to export the analysis or dashboard.

" + } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobWarningList", + "traits": { + "smithy.api#documentation": "

An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process.

\n

This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing import job.

\n

Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/{AssetBundleImportJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeAssetBundleImportJobResponse": { + "type": "structure", + "members": { + "JobStatus": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job through its queuing and execution.

\n

Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values:

\n " + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred during the export job processing.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" + } + }, + "RollbackErrors": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobErrorList", + "traits": { + "smithy.api#documentation": "

An array of error records that describes any failures that occurred while an import job was attempting a rollback.

\n

Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the import job was created.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account the import job was executed in.

" + } + }, + "AssetBundleImportSource": { + "target": "com.amazonaws.quicksight#AssetBundleImportSourceDescription", + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that is imported by the job.

" + } + }, + "OverrideParameters": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", + "traits": { + "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + }, + "OverridePermissions": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", + "traits": { + "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideTags": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.

" + } + }, + "Warnings": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobWarningList", + "traits": { + "smithy.api#documentation": "

An array of warning records that describe all permitted errors that are encountered during the import job.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary for a dashboard.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of a dashboard.

\n \n

If you do not need to know details about the content of a dashboard, for instance if you\n are trying to check the status of a recently created or updated dashboard, use the\n \n DescribeDashboard\n instead.\n

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardDefinitionResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard described.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this dashboard version.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the dashboard version.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard:

\n " + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes read and write permissions for a dashboard.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're describing\n permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the IAM policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions for the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shareable link that grants access to\n the dashboard. Your users can use the link to view and interact with the dashboard, if\n the dashboard has been shared with them. For more information about sharing dashboards,\n see Sharing Dashboards.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias name.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardResponse": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#Dashboard", + "traits": { + "smithy.api#documentation": "

Information about the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of this request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing snapshot job.

\n

Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

\n The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.\n

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

" + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "UserConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted", + "traits": { + "smithy.api#documentation": "

The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.

" + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.quicksight#SnapshotJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job. The status updates as the job executes. This shows one of the following values.

\n " + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The time that the snapshot job was created.\n

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

\n The time that the snapshot job status was last updated.\n

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the result of an existing snapshot job that has finished running.

\n

A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call.

\n

If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id has not reached a terminal state..

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs/{SnapshotJobId}/result", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you have started a snapshot job for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResultResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "JobStatus": { + "target": "com.amazonaws.quicksight#SnapshotJobStatus", + "traits": { + "smithy.api#documentation": "

Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a snapshot job was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that a snapshot job status was last updated.

" + } + }, + "Result": { + "target": "com.amazonaws.quicksight#SnapshotJobResult", + "traits": { + "smithy.api#documentation": "

The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#SnapshotJobErrorInfo", + "traits": { + "smithy.api#documentation": "

Displays information for the error that caused a job to fail.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { + "type": "structure", + "members": { + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the dataset.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the refresh properties of a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSetResponse": { + "type": "structure", + "members": { + "DataSet": { + "target": "com.amazonaws.quicksight#DataSet", + "traits": { + "smithy.api#documentation": "

Information on the dataset.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the resource permissions for a data source.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeDataSourceResponse": { + "type": "structure", + "members": { + "DataSource": { + "target": "com.amazonaws.quicksight#DataSource", + "traits": { + "smithy.api#documentation": "

The information on the data source.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes permissions for a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The pagination token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/resolved-permissions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Permissions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the folder whose permissions you want described.

", + "smithy.api#httpQuery": "namespace" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResolvedPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions for the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Folder": { + "target": "com.amazonaws.quicksight#Folder", + "traits": { + "smithy.api#documentation": "

Information about the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembership": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeGroupMembershipResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the DescribeGroupMembership operation to determine if a user is a\n\t\t\tmember of the specified group. If the user exists and is a member of the specified\n\t\t\tgroup, an associated GroupMember object is returned.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipRequest": { + "type": "structure", + "members": { + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The user name of the user that you want to search for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the \n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the group you are searching within.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupMembershipResponse": { + "type": "structure", + "members": { + "GroupMember": { + "target": "com.amazonaws.quicksight#GroupMember" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes an existing IAM policy assignment, as specified by the\n\t\t\tassignment name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignment that you want to\n\t\t\tdescribe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "IAMPolicyAssignment": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignment", + "traits": { + "smithy.api#documentation": "

Information describing the IAM policy assignment.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIngestionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIngestionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a SPICE ingestion.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIngestionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

An ID for the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIngestionResponse": { + "type": "structure", + "members": { + "Ingestion": { + "target": "com.amazonaws.quicksight#Ingestion", + "traits": { + "smithy.api#documentation": "

Information about the ingestion.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary and status of IP rules.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map that describes the IP rules with CIDR range and description.

" + } + }, + "VpcIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC IDs and their rule descriptions.

" + } + }, + "VpcEndpointIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their rule descriptions.

" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.\n\t\t\t

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeKeyRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeKeyRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes all customer managed key registrations in a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/key-registration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistrationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultKeyOnly": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines whether the request returns the default key only.

", + "smithy.api#httpQuery": "default-key-only" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeKeyRegistrationResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration specified in the request.

" + } + }, + "KeyRegistration": { + "target": "com.amazonaws.quicksight#KeyRegistration", + "traits": { + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects in a Amazon QuickSight account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeNamespace": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeNamespaceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeNamespaceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the current namespace.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeNamespaceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeNamespaceResponse": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2", + "traits": { + "smithy.api#documentation": "

The information about the namespace that you're describing. The response includes \n the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a summary of a refresh schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules/{ScheduleId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRefreshScheduleResponse": { + "type": "structure", + "members": { + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes all custom permissions that are mapped to a role.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of the role whose permissions you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The name of the custom permission that is described.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a template's metadata.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the template alias for a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're\n\t\t\tdescribing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the template alias that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

Information about the template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinition": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Provides a detailed description of the definition of a template.

\n \n

If you do not need to know details about the content of a template, for instance if you\n\t\t\t\tare trying to check the status of a recently created or updated template, use the\n\t\t\t\t\n DescribeTemplate\n instead.\n\t\t\t

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/definition", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinitionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template. You must be using the\n\t\t\t Amazon Web Services account that the template is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\t describe the version that the alias points to. You can specify the latest version of the\n\t\t\t template by providing the keyword $LATEST in the AliasName\n\t\t\t parameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateDefinitionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The descriptive name of the template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template described.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#TemplateErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the template version.

" + } + }, + "ResourceStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

Status associated with the template.

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme of the template.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of the template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes read and write permissions on a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

(Optional) The number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the template is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttemplate by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTemplateResponse": { + "type": "structure", + "members": { + "Template": { + "target": "com.amazonaws.quicksight#Template", + "traits": { + "smithy.api#documentation": "

The template structure for the object you want to describe.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the alias for a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're\n\t\t\tdescribing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the theme alias that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeThemePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeThemePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeThemePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the read and write permissions for a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeThemePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme that you want to describe permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions set on the theme.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAndAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're describing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number for the version to describe. If a VersionNumber parameter\n\t\t\tvalue isn't provided, the latest version of the theme is described.

", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST in the AliasName\n\t\t\tparameter. The keyword $PUBLISHED doesn't apply to themes.

", + "smithy.api#httpQuery": "alias-name" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeThemeResponse": { + "type": "structure", + "members": { + "Theme": { + "target": "com.amazonaws.quicksight#Theme", + "traits": { + "smithy.api#documentation": "

The information about the theme that you are describing.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the permissions of a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want\n described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicPermissionsResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that are configured to the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefresh": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes the status of a topic refresh.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/refresh/{RefreshId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh you want\n to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the refresh, which is performed when the topic is created or updated.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshResponse": { + "type": "structure", + "members": { + "RefreshDetails": { + "target": "com.amazonaws.quicksight#TopicRefreshDetails", + "traits": { + "smithy.api#documentation": "

Details of the refresh, which is performed when the topic is created or updated.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Deletes a topic refresh schedule.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that contains the refresh schedule that you want to describe. This\n ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeTopicResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of a topic.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns information about a user, given the user name.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user that you want to describe.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The user name.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DescribeVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#DescribeVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Describes a VPC connection.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#DescribeVPCConnectionResponse": { + "type": "structure", + "members": { + "VPCConnection": { + "target": "com.amazonaws.quicksight#VPCConnection", + "traits": { + "smithy.api#documentation": "

A response object that provides information for the specified VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#DestinationParameterValueConfiguration": { + "type": "structure", + "members": { + "CustomValuesConfiguration": { + "target": "com.amazonaws.quicksight#CustomValuesConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.

" + } + }, + "SelectAllValueOptions": { + "target": "com.amazonaws.quicksight#SelectAllValueOptions", + "traits": { + "smithy.api#documentation": "

The configuration that selects all options.

" + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The source parameter name of the destination parameter.

" + } + }, + "SourceField": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The source field ID of the destination parameter.

" + } + }, + "SourceColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of destination parameter values.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DimensionField": { + "type": "structure", + "members": { + "NumericalDimensionField": { + "target": "com.amazonaws.quicksight#NumericalDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with numerical type columns.

" + } + }, + "CategoricalDimensionField": { + "target": "com.amazonaws.quicksight#CategoricalDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with categorical type columns.

" + } + }, + "DateDimensionField": { + "target": "com.amazonaws.quicksight#DateDimensionField", + "traits": { + "smithy.api#documentation": "

The dimension type field with date type columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field.

" + } + }, + "com.amazonaws.quicksight#DimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#DisplayFormat": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "PERCENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT" + } + }, + "CURRENCY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURRENCY" + } + }, + "NUMBER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMBER" + } + }, + "DATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE" + } + }, + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + } + } + }, + "com.amazonaws.quicksight#DisplayFormatOptions": { + "type": "structure", + "members": { + "UseBlankCellFormat": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to use blank cell format.

" + } + }, + "BlankCellFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the blank cell format.

" + } + }, + "DateFormat": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the DateTime format.

" + } + }, + "DecimalSeparator": { + "target": "com.amazonaws.quicksight#TopicNumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the decimal separator.

" + } + }, + "GroupingSeparator": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

Determines the grouping separator.

" + } + }, + "UseGrouping": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to use grouping.

" + } + }, + "FractionDigits": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Determines the number of fraction digits.

" + } + }, + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The prefix value for a display format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The suffix value for a display format.

" + } + }, + "UnitScaler": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

The unit scaler. Valid values for this structure are: NONE,\n AUTO, THOUSANDS, MILLIONS,\n BILLIONS,\n and TRILLIONS.

" + } + }, + "NegativeFormat": { + "target": "com.amazonaws.quicksight#NegativeFormat", + "traits": { + "smithy.api#documentation": "

The negative format.

" + } + }, + "CurrencySymbol": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The currency symbol, such as USD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents additional options for display formatting.

" + } + }, + "com.amazonaws.quicksight#DnsResolverList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IPv4Address" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#Domain": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#DomainNotWhitelistedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The domain specified isn't on the allow list. All domains for embedded dashboards must be\n\t\t\tadded to the approved list by an Amazon QuickSight admin.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#DonutCenterOptions": { + "type": "structure", + "members": { + "LabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" + } + }, + "com.amazonaws.quicksight#DonutOptions": { + "type": "structure", + "members": { + "ArcOptions": { + "target": "com.amazonaws.quicksight#ArcOptions", + "traits": { + "smithy.api#documentation": "

The option for define the arc of the chart shape. Valid values are as follows:

\n " + } + }, + "DonutCenterOptions": { + "target": "com.amazonaws.quicksight#DonutCenterOptions", + "traits": { + "smithy.api#documentation": "

The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for configuring a donut chart or pie chart.

" + } + }, + "com.amazonaws.quicksight#Double": { + "type": "double", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#DrillDownFilter": { + "type": "structure", + "members": { + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#NumericEqualityDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The numeric equality type drill down filter. This filter is used for number type columns.

" + } + }, + "CategoryFilter": { + "target": "com.amazonaws.quicksight#CategoryDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The category type drill down filter. This filter is used for string type columns.

" + } + }, + "TimeRangeFilter": { + "target": "com.amazonaws.quicksight#TimeRangeDrillDownFilter", + "traits": { + "smithy.api#documentation": "

The time range drill down filter. This filter is used for date time columns.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The drill down filter for the column hierarchies.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#DrillDownFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DrillDownFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#DropDownControlDisplayOptions": { + "type": "structure", + "members": { + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a\n dropdown control.

" + } + }, + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#DynamicDefaultValue": { + "type": "structure", + "members": { + "UserNameColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the username.

" + } + }, + "GroupNameColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the group name.

" + } + }, + "DefaultValueColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that contains the default value of each user or group.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Defines different defaults to the users or groups based on mapping.

" + } + }, + "com.amazonaws.quicksight#Edition": { + "type": "enum", + "members": { + "STANDARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STANDARD" + } + }, + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + }, + "ENTERPRISE_AND_Q": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE_AND_Q" + } + } + } + }, + "com.amazonaws.quicksight#EmbeddingIdentityType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "ANONYMOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANONYMOUS" + } + } + } + }, + "com.amazonaws.quicksight#EmbeddingUrl": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#EmptyVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in the empty visual. Every visual requires a dataset to render.

", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An empty visual.

\n

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 EmptyVisual until a visual type is selected.

" + } + }, + "com.amazonaws.quicksight#Entity": { + "type": "structure", + "members": { + "Path": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The hierarchical path of the entity within the analysis, template, or dashboard definition tree.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object, structure, or sub-structure of an analysis, template, or dashboard.

" + } + }, + "com.amazonaws.quicksight#EntityList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Entity" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#EntryPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#EntryPoint": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#ErrorInfo": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#IngestionErrorType", + "traits": { + "smithy.api#documentation": "

Error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Error information for the SPICE ingestion of a dataset.

" + } + }, + "com.amazonaws.quicksight#ExasolParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The hostname or IP address of the Exasol data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Exasol data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The required parameters for connecting to an Exasol data source.

" + } + }, + "com.amazonaws.quicksight#ExceptionResourceType": { + "type": "enum", + "members": { + "USER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "USER" + } + }, + "GROUP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + }, + "ACCOUNT_SETTINGS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_SETTINGS" + } + }, + "IAMPOLICY_ASSIGNMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAMPOLICY_ASSIGNMENT" + } + }, + "DATA_SOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE" + } + }, + "DATA_SET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET" + } + }, + "VPC_CONNECTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VPC_CONNECTION" + } + }, + "INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION" + } + } + } + }, + "com.amazonaws.quicksight#ExcludePeriodConfiguration": { + "type": "structure", + "members": { + "Amount": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The amount or number of the exclude period.

", + "smithy.api#required": {} + } + }, + "Granularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The granularity or unit (day, month, year) of the exclude period.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the exclude period. Choose from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The exclude period of TimeRangeFilter or RelativeDatesFilter.

" + } + }, + "com.amazonaws.quicksight#ExplicitHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the explicit hierarchy.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#ExplicitHierarchyColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns that define the explicit hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the explicit hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.quicksight#ExplicitHierarchyColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ExportHiddenFieldsOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the export hidden fields options of a dashbaord.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines if hidden fields are included in an exported dashboard.

" + } + }, + "com.amazonaws.quicksight#ExportToCSVOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

Availability status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Export to .csv option.

" + } + }, + "com.amazonaws.quicksight#ExportWithHiddenFieldsOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the export with hidden fields options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines whether or not hidden fields are visible on exported dashbaords.

" + } + }, + "com.amazonaws.quicksight#Expression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#FailedKeyRegistrationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntry" + } + }, + "com.amazonaws.quicksight#FailedKeyRegistrationEntry": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that failed to update.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A message that provides information about why a FailedKeyRegistrationEntry error occurred.

", + "smithy.api#required": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of a FailedKeyRegistrationEntry error.

", + "smithy.api#required": {} + } + }, + "SenderFault": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean that indicates whether a FailedKeyRegistrationEntry resulted from user error. If the value of this property is True, the error was caused by user error. If the value of this property is False, the error occurred on the backend. If your job continues fail and with a False\n SenderFault value, contact Amazon Web Services Support.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An entry that appears when a KeyRegistration update to Amazon QuickSight fails.

" + } + }, + "com.amazonaws.quicksight#FieldBasedTooltip": { + "type": "structure", + "members": { + "AggregationVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of Show aggregations.

" + } + }, + "TooltipTitleType": { + "target": "com.amazonaws.quicksight#TooltipTitleType", + "traits": { + "smithy.api#documentation": "

The type for the >tooltip title. Choose one of the following options:

\n " + } + }, + "TooltipFields": { + "target": "com.amazonaws.quicksight#TooltipItemList", + "traits": { + "smithy.api#documentation": "

The fields configuration in the\n tooltip.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The setup for the detailed tooltip.

" + } + }, + "com.amazonaws.quicksight#FieldFolder": { + "type": "structure", + "members": { + "description": { + "target": "com.amazonaws.quicksight#FieldFolderDescription", + "traits": { + "smithy.api#documentation": "

The description for a field folder.

" + } + }, + "columns": { + "target": "com.amazonaws.quicksight#FolderColumnList", + "traits": { + "smithy.api#documentation": "

A folder has a list of columns. A column can only be in one folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A FieldFolder element is a folder that contains fields and nested subfolders.

" + } + }, + "com.amazonaws.quicksight#FieldFolderDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#FieldFolderMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#FieldFolderPath" + }, + "value": { + "target": "com.amazonaws.quicksight#FieldFolder" + } + }, + "com.amazonaws.quicksight#FieldFolderPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#FieldId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#FieldLabelType": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

Indicates the field that is targeted by the field\n label.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the field label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field label type.

" + } + }, + "com.amazonaws.quicksight#FieldOrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FieldSeriesItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the field for which you are setting the axis binding.

", + "smithy.api#required": {} + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis that you are binding the field to.

", + "smithy.api#required": {} + } + }, + "Settings": { + "target": "com.amazonaws.quicksight#LineChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of line series associated to the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field series item configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#FieldSort": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The sort configuration target field.

", + "smithy.api#required": {} + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#SortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction. Choose one of the following\n options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a field in a\n field well.

" + } + }, + "com.amazonaws.quicksight#FieldSortOptions": { + "type": "structure", + "members": { + "FieldSort": { + "target": "com.amazonaws.quicksight#FieldSort", + "traits": { + "smithy.api#documentation": "

The sort configuration for a field in a field well.

" + } + }, + "ColumnSort": { + "target": "com.amazonaws.quicksight#ColumnSort", + "traits": { + "smithy.api#documentation": "

The sort configuration for a column that is not used in a field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field sort options in a chart configuration.

" + } + }, + "com.amazonaws.quicksight#FieldSortOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FieldTooltipItem": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The unique ID of the field that is targeted by the tooltip.

", + "smithy.api#required": {} + } + }, + "Label": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The label of the tooltip item.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the tooltip item.

" + } + }, + "TooltipTarget": { + "target": "com.amazonaws.quicksight#TooltipTarget", + "traits": { + "smithy.api#documentation": "

Determines the target of the field tooltip item in a combo chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip item for the fields.

" + } + }, + "com.amazonaws.quicksight#FieldValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2048 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#FileFormat": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "TSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TSV" + } + }, + "CLF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLF" + } + }, + "ELF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELF" + } + }, + "XLSX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "XLSX" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.quicksight#FilledMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Geospatial": { + "target": "com.amazonaws.quicksight#FilledMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated location field well of the filled map. Values are grouped by location fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#FilledMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated color field well of a filled map. Values are aggregated based on location fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well of the filled map.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormattingOption": { + "type": "structure", + "members": { + "Shape": { + "target": "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FilledMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#FilledMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#FilledMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "WindowOptions": { + "target": "com.amazonaws.quicksight#GeospatialWindowOptions", + "traits": { + "smithy.api#documentation": "

The window options of the filled map visual.

" + } + }, + "MapStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", + "traits": { + "smithy.api#documentation": "

The map style options of the filled map visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FilledMapFieldWells": { + "type": "structure", + "members": { + "FilledMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#FilledMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well of the filled map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a FilledMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilledMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FilledMapShapeConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the filled map shape.

", + "smithy.api#required": {} + } + }, + "Format": { + "target": "com.amazonaws.quicksight#ShapeConditionalFormat", + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the background color of a filled map's shape.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting that determines the shape of the filled map.

" + } + }, + "com.amazonaws.quicksight#FilledMapSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the location fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a FilledMapVisual.

" + } + }, + "com.amazonaws.quicksight#FilledMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#FilledMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#FilledMapConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a FilledMapVisual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#Filter": { + "type": "structure", + "members": { + "CategoryFilter": { + "target": "com.amazonaws.quicksight#CategoryFilter", + "traits": { + "smithy.api#documentation": "

A CategoryFilter filters text values.

\n

For more information, see Adding text filters in the Amazon QuickSight User Guide.

" + } + }, + "NumericRangeFilter": { + "target": "com.amazonaws.quicksight#NumericRangeFilter", + "traits": { + "smithy.api#documentation": "

A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.

" + } + }, + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#NumericEqualityFilter", + "traits": { + "smithy.api#documentation": "

A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.

" + } + }, + "TimeEqualityFilter": { + "target": "com.amazonaws.quicksight#TimeEqualityFilter", + "traits": { + "smithy.api#documentation": "

A TimeEqualityFilter filters date-time values that equal or do not equal\n a given date/time value.

" + } + }, + "TimeRangeFilter": { + "target": "com.amazonaws.quicksight#TimeRangeFilter", + "traits": { + "smithy.api#documentation": "

A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.

" + } + }, + "RelativeDatesFilter": { + "target": "com.amazonaws.quicksight#RelativeDatesFilter", + "traits": { + "smithy.api#documentation": "

A RelativeDatesFilter filters date values that are relative to a given date.

" + } + }, + "TopBottomFilter": { + "target": "com.amazonaws.quicksight#TopBottomFilter", + "traits": { + "smithy.api#documentation": "

A TopBottomFilter filters data to the top or bottom values for a given column.

" + } + }, + "NestedFilter": { + "target": "com.amazonaws.quicksight#NestedFilter", + "traits": { + "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

With a Filter, you can remove portions of data from a particular visual or view.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterAggMetrics": { + "type": "structure", + "members": { + "MetricOperand": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The metric operand of the FilterAggMetrics.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The function for the FilterAggMetrics.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for FilterAggMetrics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the FilterAggMetrics.

" + } + }, + "com.amazonaws.quicksight#FilterAggMetricsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterAggMetrics" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FilterClass": { + "type": "enum", + "members": { + "ENFORCED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENFORCED_VALUE_FILTER" + } + }, + "CONDITIONAL_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONDITIONAL_VALUE_FILTER" + } + }, + "NAMED_VALUE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMED_VALUE_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#FilterControl": { + "type": "structure", + "members": { + "DateTimePicker": { + "target": "com.amazonaws.quicksight#FilterDateTimePickerControl", + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" + } + }, + "List": { + "target": "com.amazonaws.quicksight#FilterListControl", + "traits": { + "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" + } + }, + "Dropdown": { + "target": "com.amazonaws.quicksight#FilterDropDownControl", + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "TextField": { + "target": "com.amazonaws.quicksight#FilterTextFieldControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "TextArea": { + "target": "com.amazonaws.quicksight#FilterTextAreaControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "Slider": { + "target": "com.amazonaws.quicksight#FilterSliderControl", + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "RelativeDateTime": { + "target": "com.amazonaws.quicksight#FilterRelativeDateTimeControl", + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" + } + }, + "CrossSheet": { + "target": "com.amazonaws.quicksight#FilterCrossSheetControl", + "traits": { + "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The control of a filter that is used to interact with a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterControlList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterControl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FilterCrossSheetControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterCrossSheetControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterCrossSheetControl.

", + "smithy.api#required": {} + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet

" + } + }, + "com.amazonaws.quicksight#FilterDateTimePickerControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlDateTimePickerType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify date and time.

" + } + }, + "com.amazonaws.quicksight#FilterDropDownControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterDropDownControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of the FilterDropDownControl.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterDropDownControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "com.amazonaws.quicksight#FilterGroup": { + "type": "structure", + "members": { + "FilterGroupId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.

", + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#FilterList", + "traits": { + "smithy.api#documentation": "

The list of filters that are present in a FilterGroup.

", + "smithy.api#required": {} + } + }, + "ScopeConfiguration": { + "target": "com.amazonaws.quicksight#FilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that specifies what scope to apply to a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the FilterGroup.

" + } + }, + "CrossDataset": { + "target": "com.amazonaws.quicksight#CrossDatasetTypes", + "traits": { + "smithy.api#documentation": "

The filter new feature which can apply filter group to all data sets. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A grouping of individual filters. Filter groups are applied to the same group of visuals.

\n

For more information, see Adding filter conditions (group filters) with AND and OR operators in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#FilterGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FilterGroup" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#FilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Filter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#FilterListConfiguration": { + "type": "structure", + "members": { + "MatchOperator": { + "target": "com.amazonaws.quicksight#CategoryFilterMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "CategoryValues": { + "target": "com.amazonaws.quicksight#CategoryValueList", + "traits": { + "smithy.api#documentation": "

The list of category values for the filter.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#CategoryFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of filter configurations.

" + } + }, + "com.amazonaws.quicksight#FilterListControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterListControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of the FilterListControl. Choose one of the following options:

\n " + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#FilterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.

" + } + }, + "com.amazonaws.quicksight#FilterNullOption": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + }, + "NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULLS_ONLY" + } + }, + "NON_NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_NULLS_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#FilterOperation": { + "type": "structure", + "members": { + "ConditionExpression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

An expression that must evaluate to a Boolean value. Rows for which the expression\n evaluates to true are kept in the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that filters rows based on a condition.

" + } + }, + "com.amazonaws.quicksight#FilterOperationSelectedFieldsConfiguration": { + "type": "structure", + "members": { + "SelectedFields": { + "target": "com.amazonaws.quicksight#SelectedFieldList", + "traits": { + "smithy.api#documentation": "

Chooses the fields that are filtered in CustomActionFilterOperation.

" + } + }, + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#SelectedFieldOptions", + "traits": { + "smithy.api#documentation": "

A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation.

\n

Valid values are defined as follows:

\n " + } + }, + "SelectedColumns": { + "target": "com.amazonaws.quicksight#CustomActionColumnList", + "traits": { + "smithy.api#documentation": "

The selected columns of a dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of selected fields in theCustomActionFilterOperation.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterOperationTargetVisualsConfiguration": { + "type": "structure", + "members": { + "SameSheetTargetVisualConfiguration": { + "target": "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterOperator": { + "type": "enum", + "members": { + "StringEquals": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringEquals" + } + }, + "StringLike": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StringLike" + } + } + } + }, + "com.amazonaws.quicksight#FilterRelativeDateTimeControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date filter that is used to specify the relative date.

" + } + }, + "com.amazonaws.quicksight#FilterScopeConfiguration": { + "type": "structure", + "members": { + "SelectedSheets": { + "target": "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for applying a filter to specific sheets.

" + } + }, + "AllSheets": { + "target": "com.amazonaws.quicksight#AllSheetsFilterScopeConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scope configuration for a FilterGroup.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FilterSelectableValues": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#ParameterSelectableValueList", + "traits": { + "smithy.api#documentation": "

The values that are used in the FilterSelectableValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "com.amazonaws.quicksight#FilterSliderControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterSliderControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlSliderType", + "traits": { + "smithy.api#documentation": "

The type of the FilterSliderControl. Choose one of the following options:

\n " + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "com.amazonaws.quicksight#FilterTextAreaControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "com.amazonaws.quicksight#FilterTextFieldControl": { + "type": "structure", + "members": { + "FilterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "SourceFilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The source filter ID of the FilterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "com.amazonaws.quicksight#FilterVisualScope": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + }, + "SELECTED_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTED_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#FilteredVisualsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#Folder": { + "type": "structure", + "members": { + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the folder.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

A display name for the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder it is.

" + } + }, + "FolderPath": { + "target": "com.amazonaws.quicksight#Path", + "traits": { + "smithy.api#documentation": "

An array of ancestor ARN strings for the folder.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

The sharing scope of the folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A folder in Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#FolderArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FolderColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5000 + } + } + }, + "com.amazonaws.quicksight#FolderFilterAttribute": { + "type": "enum", + "members": { + "PARENT_FOLDER_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARENT_FOLDER_ARN" + } + }, + "DIRECT_QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_OWNER" + } + }, + "DIRECT_QUICKSIGHT_SOLE_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_SOLE_OWNER" + } + }, + "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "QUICKSIGHT_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_OWNER" + } + }, + "QUICKSIGHT_VIEWER_OR_OWNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT_VIEWER_OR_OWNER" + } + }, + "FOLDER_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FOLDER_NAME" + } + } + } + }, + "com.amazonaws.quicksight#FolderMember": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of an asset in the folder.

" + } + }, + "MemberType": { + "target": "com.amazonaws.quicksight#MemberType", + "traits": { + "smithy.api#documentation": "

The type of asset that it is.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An asset in a Amazon QuickSight folder, such as a dashboard, analysis, or dataset.

" + } + }, + "com.amazonaws.quicksight#FolderMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MemberIdArnPair" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#FolderSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#FilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\": \"StringEquals\". Valid values are \"StringEquals\" and \"StringLike\".

\n

If you set the operator value to \"StringEquals\", you need to provide an ownership related filter in the \"NAME\" field and the arn of the user or group whose folders you want to search in the \"Value\" field. For example, \"Name\":\"DIRECT_QUICKSIGHT_OWNER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

\n

If you set the value to \"StringLike\", you need to provide the name of the folders you are searching for. For example, \"Name\":\"FOLDER_NAME\", \"Operator\": \"StringLike\", \"Value\": \"Test\". The \"StringLike\" operator only supports the NAME value FOLDER_NAME.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of a value that you want to use in the filter. For example, \"Name\": \"QUICKSIGHT_OWNER\".

\n

Valid values are defined as follows:

\n " + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\".

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter to use to search an Amazon QuickSight folder.

" + } + }, + "com.amazonaws.quicksight#FolderSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FolderSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The display name of the folder.

" + } + }, + "FolderType": { + "target": "com.amazonaws.quicksight#FolderType", + "traits": { + "smithy.api#documentation": "

The type of folder.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the folder was last updated.

" + } + }, + "SharingModel": { + "target": "com.amazonaws.quicksight#SharingModel", + "traits": { + "smithy.api#documentation": "

The sharing scope of the folder.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of information about an existing Amazon QuickSight folder.

" + } + }, + "com.amazonaws.quicksight#FolderSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FolderSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#FolderType": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "RESTRICTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED" + } + } + } + }, + "com.amazonaws.quicksight#Font": { + "type": "structure", + "members": { + "FontFamily": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Determines the font family settings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the font settings.

" + } + }, + "com.amazonaws.quicksight#FontConfiguration": { + "type": "structure", + "members": { + "FontSize": { + "target": "com.amazonaws.quicksight#FontSize", + "traits": { + "smithy.api#documentation": "

The option that determines the text display size.

" + } + }, + "FontDecoration": { + "target": "com.amazonaws.quicksight#FontDecoration", + "traits": { + "smithy.api#documentation": "

Determines the appearance of decorative lines on the text.

" + } + }, + "FontColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color of the text.

" + } + }, + "FontWeight": { + "target": "com.amazonaws.quicksight#FontWeight", + "traits": { + "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" + } + }, + "FontStyle": { + "target": "com.amazonaws.quicksight#FontStyle", + "traits": { + "smithy.api#documentation": "

Determines the text display face that is inherited by the given font family.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the display properties of the given text.

" + } + }, + "com.amazonaws.quicksight#FontDecoration": { + "type": "enum", + "members": { + "UNDERLINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNDERLINE" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.quicksight#FontList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Font" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#FontSize": { + "type": "structure", + "members": { + "Relative": { + "target": "com.amazonaws.quicksight#RelativeFontSize", + "traits": { + "smithy.api#documentation": "

The lexical name for the text size, proportional to its surrounding context.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the text display size.

" + } + }, + "com.amazonaws.quicksight#FontStyle": { + "type": "enum", + "members": { + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + }, + "ITALIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ITALIC" + } + } + } + }, + "com.amazonaws.quicksight#FontWeight": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#FontWeightName", + "traits": { + "smithy.api#documentation": "

The lexical name for the level of boldness of the text display.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The option that determines the text display weight, or boldness.

" + } + }, + "com.amazonaws.quicksight#FontWeightName": { + "type": "enum", + "members": { + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + }, + "BOLD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOLD" + } + } + } + }, + "com.amazonaws.quicksight#ForecastComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodsForward": { + "target": "com.amazonaws.quicksight#PeriodsForward", + "traits": { + "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" + } + }, + "PeriodsBackward": { + "target": "com.amazonaws.quicksight#PeriodsBackward", + "traits": { + "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" + } + }, + "UpperBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" + } + }, + "LowerBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" + } + }, + "PredictionInterval": { + "target": "com.amazonaws.quicksight#PredictionInterval", + "traits": { + "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" + } + }, + "Seasonality": { + "target": "com.amazonaws.quicksight#ForecastComputationSeasonality", + "traits": { + "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " + } + }, + "CustomSeasonalityValue": { + "target": "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue", + "traits": { + "smithy.api#documentation": "

The custom seasonality value setup of a forecast computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast computation configuration.

" + } + }, + "com.amazonaws.quicksight#ForecastComputationCustomSeasonalityValue": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 180 + } + } + }, + "com.amazonaws.quicksight#ForecastComputationSeasonality": { + "type": "enum", + "members": { + "AUTOMATIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTOMATIC" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#ForecastConfiguration": { + "type": "structure", + "members": { + "ForecastProperties": { + "target": "com.amazonaws.quicksight#TimeBasedForecastProperties", + "traits": { + "smithy.api#documentation": "

The forecast properties setup of a forecast in the line\n chart.

" + } + }, + "Scenario": { + "target": "com.amazonaws.quicksight#ForecastScenario", + "traits": { + "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast configuration that is used in a line chart's display properties.

" + } + }, + "com.amazonaws.quicksight#ForecastConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ForecastConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ForecastScenario": { + "type": "structure", + "members": { + "WhatIfPointScenario": { + "target": "com.amazonaws.quicksight#WhatIfPointScenario", + "traits": { + "smithy.api#documentation": "

The what-if analysis forecast setup with the target date.

" + } + }, + "WhatIfRangeScenario": { + "target": "com.amazonaws.quicksight#WhatIfRangeScenario", + "traits": { + "smithy.api#documentation": "

The what-if analysis forecast setup with the date range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast scenario of a forecast in the line chart.

" + } + }, + "com.amazonaws.quicksight#FormatConfiguration": { + "type": "structure", + "members": { + "StringFormatConfiguration": { + "target": "com.amazonaws.quicksight#StringFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for string fields.

" + } + }, + "NumberFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for number fields.

" + } + }, + "DateTimeFormatConfiguration": { + "target": "com.amazonaws.quicksight#DateTimeFormatConfiguration", + "traits": { + "smithy.api#documentation": "

Formatting configuration for DateTime fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The formatting configuration for all types of field.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "ScreenCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for the canvas of a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in a free-form layout.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#FreeFormLayoutCanvasSizeOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElement": { + "type": "structure", + "members": { + "ElementId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

A unique identifier for an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "ElementType": { + "target": "com.amazonaws.quicksight#LayoutElementType", + "traits": { + "smithy.api#documentation": "

The type of element.

", + "smithy.api#required": {} + } + }, + "XAxisLocation": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The x-axis coordinate of the element.

", + "smithy.api#required": {} + } + }, + "YAxisLocation": { + "target": "com.amazonaws.quicksight#UnlimitedPixelLength", + "traits": { + "smithy.api#documentation": "

The y-axis coordinate of the element.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of an element within a free-form layout.

", + "smithy.api#required": {} + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of an element within a free-form layout.

" + } + }, + "RenderingRules": { + "target": "com.amazonaws.quicksight#SheetElementRenderingRuleList", + "traits": { + "smithy.api#documentation": "

The rendering rules that determine when an element should be displayed within a free-form layout.

" + } + }, + "BorderStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", + "traits": { + "smithy.api#documentation": "

The border style configuration of a free-form layout element.

" + } + }, + "SelectedBorderStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle", + "traits": { + "smithy.api#documentation": "

The border style configuration of a free-form layout element. This border style is used when the element is selected.

" + } + }, + "BackgroundStyle": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle", + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "LoadingAnimation": { + "target": "com.amazonaws.quicksight#LoadingAnimation", + "traits": { + "smithy.api#documentation": "

The loading animation configuration of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An element within a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElementBackgroundStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The background visibility of a free-form layout element.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The background color of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutElementBorderStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The border visibility of a free-form layout element.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

The border color of a free-form layout element.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The background style configuration of a free-form layout element.

" + } + }, + "com.amazonaws.quicksight#FreeFormLayoutScreenCanvasSizeOptions": { + "type": "structure", + "members": { + "OptimizedViewPortWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a free-form layout.

" + } + }, + "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#FreeFromLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in the free-form layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The free-form layout configuration of a section.

" + } + }, + "com.amazonaws.quicksight#FreeFromLayoutElementList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FreeFormLayoutElement" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 430 + } + } + }, + "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#FunnelChartDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a funnel chart. Values are grouped by category fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#FunnelChartMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a funnel chart. Values are aggregated based on categories.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#FunnelChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#FunnelChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the categories that are displayed in a FunnelChartVisual.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options for the values that are displayed in a FunnelChartVisual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a FunnelChartVisual.

" + } + }, + "DataLabelOptions": { + "target": "com.amazonaws.quicksight#FunnelChartDataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a FunnelChartVisual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartDataLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility option that determines if data labels are displayed.

" + } + }, + "CategoryLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the category labels within the data labels.

" + } + }, + "MeasureLabelVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the measure labels within the data labels.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#DataLabelPosition", + "traits": { + "smithy.api#documentation": "

Determines the positioning of the data label relative to a section of the funnel.

" + } + }, + "LabelFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration for the data labels.

\n

Only the FontSize attribute of the font configuration is used for data labels.

" + } + }, + "LabelColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the data label text.

" + } + }, + "MeasureDataLabelStyle": { + "target": "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle", + "traits": { + "smithy.api#documentation": "

Determines the style of the metric labels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the data labels.

" + } + }, + "com.amazonaws.quicksight#FunnelChartDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FunnelChartFieldWells": { + "type": "structure", + "members": { + "FunnelChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#FunnelChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a FunnelChartVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#FunnelChartMeasureDataLabelStyle": { + "type": "enum", + "members": { + "VALUE_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_ONLY" + } + }, + "PERCENTAGE_BY_FIRST_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_BY_FIRST_STAGE" + } + }, + "PERCENTAGE_BY_PREVIOUS_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTAGE_BY_PREVIOUS_STAGE" + } + }, + "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_FIRST_STAGE" + } + }, + "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE" + } + } + } + }, + "com.amazonaws.quicksight#FunnelChartMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#FunnelChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a FunnelChartVisual.

" + } + }, + "com.amazonaws.quicksight#FunnelChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#FunnelChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a FunnelChartVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the arc foreground color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartColorConfiguration": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color configuration of a GaugeChartVisual.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color configuration of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption": { + "type": "structure", + "members": { + "PrimaryValue": { + "target": "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" + } + }, + "Arc": { + "target": "com.amazonaws.quicksight#GaugeChartArcConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the arc of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#GaugeChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#GaugeChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" + } + }, + "GaugeChartOptions": { + "target": "com.amazonaws.quicksight#GaugeChartOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a GaugeChartVisual.

" + } + }, + "TooltipOptions": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a GaugeChartVisual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a GaugeChartVisual.

" + } + }, + "ColorConfiguration": { + "target": "com.amazonaws.quicksight#GaugeChartColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration of a GaugeChartVisual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a GaugeChartVisual.

" + } + }, + "TargetValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The target value field wells of a GaugeChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartOptions": { + "type": "structure", + "members": { + "PrimaryValueDisplayType": { + "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value display type.

" + } + }, + "Comparison": { + "target": "com.amazonaws.quicksight#ComparisonConfiguration", + "traits": { + "smithy.api#documentation": "

The comparison configuration of a GaugeChartVisual.

" + } + }, + "ArcAxis": { + "target": "com.amazonaws.quicksight#ArcAxisConfiguration", + "traits": { + "smithy.api#documentation": "

The arc axis configuration of a GaugeChartVisual.

" + } + }, + "Arc": { + "target": "com.amazonaws.quicksight#ArcConfiguration", + "traits": { + "smithy.api#documentation": "

The arc configuration of a GaugeChartVisual.

" + } + }, + "PrimaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value font configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartPrimaryValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a GaugeChartVisual.

" + } + }, + "com.amazonaws.quicksight#GaugeChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GaugeChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a GaugeChartVisual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#GaugeChartConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a GaugeChartVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/embed-url/anonymous-user", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.

", + "smithy.api#required": {} + } + }, + "SessionTags": { + "target": "com.amazonaws.quicksight#SessionTagList", + "traits": { + "smithy.api#documentation": "

The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security.

\n

These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" + } + }, + "AuthorizedResourceArns": { + "target": "com.amazonaws.quicksight#ArnList", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user\n is authorized to access during the lifetime of the session.

\n

If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the\n account that you want the user to be able to view.

\n

If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to.

\n

Currently, you can pass up to 25 theme ARNs in each API call.

", + "smithy.api#required": {} + } + }, + "ExperienceConfiguration": { + "target": "com.amazonaws.quicksight#AnonymousUserEmbeddingExperienceConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of the experience that you are embedding.

", + "smithy.api#required": {} + } + }, + "AllowedDomains": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that\n is then embedded. This optional parameter overrides the static domains that are\n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it\n allows only the domains that you include in this parameter. You can list up to three\n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUserResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

The embed URL for the dashboard.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", + "smithy.api#required": {} + } + }, + "AnonymousUserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UpdateAnalysisRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the analysis that you're updating. This ID displays in the URL of the\n analysis.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the Amazon QuickSight console.

", - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", - "traits": { - "smithy.api#documentation": "

A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the Amazon QuickSight console, make sure that you have access to\n it.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#AnalysisDefinition", - "traits": { - "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UpdateAnalysisResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the analysis that you're updating.

" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the analysis.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the last update that was made to the analysis.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UpdateDashboard": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a dashboard in an Amazon Web Services account.

\n \n

Updating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the \n UpdateDashboardPublishedVersion\n API operation.

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" }, - "com.amazonaws.quicksight#UpdateDashboardLinks": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardLinksRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardLinksResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the linked analyses on a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UpdateDashboardLinksRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" }, - "com.amazonaws.quicksight#UpdateDashboardLinksResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "LinkEntities": { - "target": "com.amazonaws.quicksight#LinkEntityArnList", - "traits": { - "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#UpdateDashboardPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates read and write permissions on a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" }, - "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to grant on this resource.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to revoke from this resource.

" - } - }, - "GrantLinkPermissions": { - "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", - "traits": { - "smithy.api#documentation": "

Grants link permissions to all users in a defined namespace.

" - } - }, - "RevokeLinkPermissions": { - "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", - "traits": { - "smithy.api#documentation": "

Revokes link permissions from all users in a defined namespace.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

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. \n Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions.

\n

The following rules apply to the generated URL:

\n \n

For more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/embed-url/registered-user", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.

" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name for the registered user.

", + "smithy.api#required": {} + } + }, + "ExperienceConfiguration": { + "target": "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration", + "traits": { + "smithy.api#documentation": "

The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&A experience, or the entire Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "AllowedDomains": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

The domains that you want to add to the allow list for access to the generated URL that \n is then embedded. This optional parameter overrides the static domains that are \n configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it \n allows only the domains that you include in this parameter. You can list up to three \n domains or subdomains in each API call.

\n

To include all subdomains under a specific domain to the allow list, use *.\n For example, https://*.sapp.amazon.com includes all subdomains under\n https://sapp.amazon.com.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUserResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&A experience, or console.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {}, + "smithy.api#required": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GeoSpatialColumnGroup": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnGroupName", + "traits": { + "smithy.api#documentation": "

A display name for the hierarchy.

", + "smithy.api#required": {} + } + }, + "CountryCode": { + "target": "com.amazonaws.quicksight#GeoSpatialCountryCode", + "traits": { + "smithy.api#documentation": "

Country code.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#ColumnList", + "traits": { + "smithy.api#documentation": "

Columns in this hierarchy.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Geospatial column group that denotes a hierarchy.

" + } + }, + "com.amazonaws.quicksight#GeoSpatialCountryCode": { + "type": "enum", + "members": { + "US": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US" + } + } + } + }, + "com.amazonaws.quicksight#GeoSpatialDataRole": { + "type": "enum", + "members": { + "COUNTRY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNTRY" + } + }, + "STATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STATE" + } + }, + "COUNTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNTY" + } + }, + "CITY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CITY" + } + }, + "POSTCODE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSTCODE" + } + }, + "LONGITUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LONGITUDE" + } + }, + "LATITUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LATITUDE" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialCoordinateBounds": { + "type": "structure", + "members": { + "North": { + "target": "com.amazonaws.quicksight#Latitude", + "traits": { + "smithy.api#documentation": "

The latitude of the north bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "South": { + "target": "com.amazonaws.quicksight#Latitude", + "traits": { + "smithy.api#documentation": "

The latitude of the south bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "West": { + "target": "com.amazonaws.quicksight#Longitude", + "traits": { + "smithy.api#documentation": "

The longitude of the west bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + }, + "East": { + "target": "com.amazonaws.quicksight#Longitude", + "traits": { + "smithy.api#documentation": "

The longitude of the east bound of the geospatial coordinate bounds.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The bound\n options (north, south, west, east) of the geospatial window options.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapColorScale": { + "type": "structure", + "members": { + "Colors": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColorList", + "traits": { + "smithy.api#documentation": "

The list of colors to be used in heatmap point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapConfiguration": { + "type": "structure", + "members": { + "HeatmapColor": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapColorScale", + "traits": { + "smithy.api#documentation": "

The color scale specification for the heatmap point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapDataColor": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hex color to be used in the heatmap point style.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The color to be used in the heatmap point style.

" + } + }, + "com.amazonaws.quicksight#GeospatialHeatmapDataColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapDataColor" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Geospatial": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field wells of a geospatial map. Values are aggregated based on geospatial fields.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color field wells of a geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells for a geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#GeospatialMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "WindowOptions": { + "target": "com.amazonaws.quicksight#GeospatialWindowOptions", + "traits": { + "smithy.api#documentation": "

The window options of the geospatial map.

" + } + }, + "MapStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialMapStyleOptions", + "traits": { + "smithy.api#documentation": "

The map style options of the geospatial map.

" + } + }, + "PointStyleOptions": { + "target": "com.amazonaws.quicksight#GeospatialPointStyleOptions", + "traits": { + "smithy.api#documentation": "

The point style options of the geospatial map.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette" + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a GeospatialMapVisual.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapFieldWells": { + "type": "structure", + "members": { + "GeospatialMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#GeospatialMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for a geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a GeospatialMapVisual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapStyleOptions": { + "type": "structure", + "members": { + "BaseMapStyle": { + "target": "com.amazonaws.quicksight#BaseMapStyleType", + "traits": { + "smithy.api#documentation": "

The base map style of the geospatial map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The map style options of the geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#GeospatialPointStyleOptions": { + "type": "structure", + "members": { + "SelectedPointStyle": { + "target": "com.amazonaws.quicksight#GeospatialSelectedPointStyle", + "traits": { + "smithy.api#documentation": "

The selected point styles (point, cluster) of the geospatial map.

" + } + }, + "ClusterMarkerConfiguration": { + "target": "com.amazonaws.quicksight#ClusterMarkerConfiguration", + "traits": { + "smithy.api#documentation": "

The cluster marker configuration of the geospatial point style.

" + } + }, + "HeatmapConfiguration": { + "target": "com.amazonaws.quicksight#GeospatialHeatmapConfiguration", + "traits": { + "smithy.api#documentation": "

The heatmap configuration of the geospatial point style.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The point style of the geospatial map.

" + } + }, + "com.amazonaws.quicksight#GeospatialSelectedPointStyle": { + "type": "enum", + "members": { + "POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POINT" + } + }, + "CLUSTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLUSTER" + } + }, + "HEATMAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HEATMAP" + } + } + } + }, + "com.amazonaws.quicksight#GeospatialWindowOptions": { + "type": "structure", + "members": { + "Bounds": { + "target": "com.amazonaws.quicksight#GeospatialCoordinateBounds", + "traits": { + "smithy.api#documentation": "

The bounds options (north, south, west, east) of the geospatial window options.

" + } + }, + "MapZoomMode": { + "target": "com.amazonaws.quicksight#MapZoomMode", + "traits": { + "smithy.api#documentation": "

The map zoom modes (manual, auto) of the geospatial window options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The window options of the geospatial map visual.

" + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse": { - "type": "structure", - "members": { - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions on the dashboard.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "LinkSharingConfiguration": { - "target": "com.amazonaws.quicksight#LinkSharingConfiguration", - "traits": { - "smithy.api#documentation": "

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DomainNotWhitelistedException" }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersion": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the published version of a dashboard.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#IdentityTypeNotSupportedException" }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { - "type": "structure", - "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UpdateDashboardRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", - "traits": { - "smithy.api#documentation": "

The display name of the dashboard.

", - "smithy.api#required": {} - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#DashboardSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "

A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" - } - }, - "DashboardPublishOptions": { - "target": "com.amazonaws.quicksight#DashboardPublishOptions", - "traits": { - "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#DashboardVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" }, - "com.amazonaws.quicksight#UpdateDashboardResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN of the dashboard, including the version number.

" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dashboard.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the request.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#UpdateDataSet": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSetRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSetResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UpdateDataSetPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" }, - "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to grant to the dataset.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to revoke from the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse": { - "type": "structure", - "members": { - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" }, - "com.amazonaws.quicksight#UpdateDataSetRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each\n\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the dataset.

", - "smithy.api#required": {} - } - }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", - "traits": { - "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", - "smithy.api#required": {} - } - }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", - "smithy.api#required": {} - } - }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" - } - }, - "FieldFolders": { - "target": "com.amazonaws.quicksight#FieldFolderMap", - "traits": { - "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" - } - }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "

The row-level security configuration for the data you want to create.

" - } - }, - "RowLevelPermissionTagConfiguration": { - "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" - } - }, - "ColumnLevelPermissionRules": { - "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", - "traits": { - "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" - } - }, - "DataSetUsageConfiguration": { - "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" - }, - "DatasetParameters": { - "target": "com.amazonaws.quicksight#DatasetParameterList", - "traits": { - "smithy.api#documentation": "

The parameter declarations of the dataset.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

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.

\n

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL:

\n \n

For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User\n Guide.

\n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the dashboard that you're embedding.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard, also added to the Identity and Access Management (IAM)\n policy.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentityType": { + "target": "com.amazonaws.quicksight#EmbeddingIdentityType", + "traits": { + "smithy.api#documentation": "

The authentication method that the user uses to sign in.

", + "smithy.api#httpQuery": "creds-type", + "smithy.api#required": {} + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", + "smithy.api#httpQuery": "session-lifetime" + } + }, + "UndoRedoDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.

", + "smithy.api#httpQuery": "undo-redo-disabled" + } + }, + "ResetDisabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.

", + "smithy.api#httpQuery": "reset-disabled" + } + }, + "StatePersistenceEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Adds persistence of state for the user session in an embedded dashboard. Persistence\n applies to the sheet and the parameter settings. These are control settings that the\n dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is\n set to TRUE, the settings are the same when the subscriber reopens the same\n dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is\n set to FALSE, the state of the user session is not persisted. The default is\n FALSE.

", + "smithy.api#httpQuery": "state-persistence-enabled" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:

\n \n

Omit this parameter for users in the third group – IAM users and IAM\n role-based sessions.

", + "smithy.api#httpQuery": "user-arn" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set Namespace = default.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AdditionalDashboardIds": { + "target": "com.amazonaws.quicksight#AdditionalDashboardIdList", + "traits": { + "smithy.api#documentation": "

A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session can access all three dashboards.

", + "smithy.api#httpQuery": "additional-dashboard-ids" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output returned from the GetDashboardEmbedUrl operation.

", + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrl": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrlRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrlResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UpdateDataSetResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

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.

" - } - }, - "IngestionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "IngestionId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UpdateDataSource": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSourceRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSourceResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a data source.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UpdateDataSourcePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions to a data source.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#QuickSightUserNotFoundException" }, - "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that you want to grant on the data source.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions that you want to revoke on the data source.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { - "type": "structure", - "members": { - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#UpdateDataSourceRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

A display name for the data source.

", - "smithy.api#required": {} - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", - "traits": { - "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" - } - }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", - "traits": { - "smithy.api#documentation": "

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" - } - }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", - "traits": { - "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" - } - }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying\n\t\t\tsource.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException" }, - "com.amazonaws.quicksight#UpdateDataSourceResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the data source's last update.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Generates a session URL and authorization code that you can use to embed the Amazon\n Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console\n need belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use \n RegisterUser\n \n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n ", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/session-embed-url", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrlRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "EntryPoint": { + "target": "com.amazonaws.quicksight#EntryPoint", + "traits": { + "smithy.api#documentation": "

The URL you use to access the embedded session. The entry point URL is constrained to\n the following paths:

\n ", + "smithy.api#httpQuery": "entry-point" + } + }, + "SessionLifetimeInMinutes": { + "target": "com.amazonaws.quicksight#SessionLifetimeInMinutes", + "traits": { + "smithy.api#documentation": "

How many minutes the session is valid. The session lifetime must be 15-600 minutes.

", + "smithy.api#httpQuery": "session-lifetime" + } + }, + "UserArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type.\n\t\t\tYou can use this for any type of Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins). They need to be authenticated as one of the following:

\n
    \n
  1. \n

    Active Directory (AD) users or group members

    \n
    2. \n
  2. \n

    Invited nonfederated users

    \n
    3. \n
  3. \n

    IAM users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation

    \n
    4. \n
\n

Omit this parameter for users in the third group, IAM users and IAM role-based\n sessions.

", + "smithy.api#httpQuery": "user-arn" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#GetSessionEmbedUrlResponse": { + "type": "structure", + "members": { + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", + "traits": { + "smithy.api#documentation": "

A single-use URL that you can put into your server-side web page to embed your\n\t\t\tAmazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#GlobalTableBorderOptions": { + "type": "structure", + "members": { + "UniformBorder": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

Determines the options for uniform border.

" + } + }, + "SideSpecificBorder": { + "target": "com.amazonaws.quicksight#TableSideBorderOptions", + "traits": { + "smithy.api#documentation": "

Determines the options for side specific border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the border options for a table visual.

" + } + }, + "com.amazonaws.quicksight#GradientColor": { + "type": "structure", + "members": { + "Stops": { + "target": "com.amazonaws.quicksight#GradientStopList", + "traits": { + "smithy.api#documentation": "

The list of gradient color stops.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the gradient color settings.

" + } + }, + "com.amazonaws.quicksight#GradientStop": { + "type": "structure", + "members": { + "GradientOffset": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Determines gradient offset value.

", + "smithy.api#required": {} + } + }, + "DataValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines the data value.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Determines the color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the gradient stop configuration.

" + } + }, + "com.amazonaws.quicksight#GradientStopList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GradientStop" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "ScreenCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configuration options for the canvas of a grid layout.

" + } + }, + "com.amazonaws.quicksight#GridLayoutConfiguration": { + "type": "structure", + "members": { + "Elements": { + "target": "com.amazonaws.quicksight#GridLayoutElementList", + "traits": { + "smithy.api#documentation": "

The elements that are included in a grid layout.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#GridLayoutCanvasSizeOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a grid layout. Also called a tiled layout.

\n

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.

" + } + }, + "com.amazonaws.quicksight#GridLayoutElement": { + "type": "structure", + "members": { + "ElementId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

A unique identifier for an element within a grid layout.

", + "smithy.api#required": {} + } + }, + "ElementType": { + "target": "com.amazonaws.quicksight#LayoutElementType", + "traits": { + "smithy.api#documentation": "

The type of element.

", + "smithy.api#required": {} + } + }, + "ColumnIndex": { + "target": "com.amazonaws.quicksight#GridLayoutElementColumnIndex", + "traits": { + "smithy.api#documentation": "

The column index for the upper left corner of an element.

" + } + }, + "ColumnSpan": { + "target": "com.amazonaws.quicksight#GridLayoutElementColumnSpan", + "traits": { + "smithy.api#documentation": "

The width of a grid element expressed as a number of grid columns.

", + "smithy.api#required": {} + } + }, + "RowIndex": { + "target": "com.amazonaws.quicksight#GridLayoutElementRowIndex", + "traits": { + "smithy.api#documentation": "

The row index for the upper left corner of an element.

" + } + }, + "RowSpan": { + "target": "com.amazonaws.quicksight#GridLayoutElementRowSpan", + "traits": { + "smithy.api#documentation": "

The height of a grid element expressed as a number of grid rows.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An element within a grid layout.

" + } + }, + "com.amazonaws.quicksight#GridLayoutElementColumnIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 35 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementColumnSpan": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 36 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GridLayoutElement" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 430 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementRowIndex": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 9009 + } + } + }, + "com.amazonaws.quicksight#GridLayoutElementRowSpan": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 21 + } + } + }, + "com.amazonaws.quicksight#GridLayoutScreenCanvasSizeOptions": { + "type": "structure", + "members": { + "ResizeOption": { + "target": "com.amazonaws.quicksight#ResizeOption", + "traits": { + "smithy.api#documentation": "

This value determines the layout behavior when the viewport is resized.

\n ", + "smithy.api#required": {} + } + }, + "OptimizedViewPortWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width that the view port will be optimized for when the layout renders.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the sizing of the canvas used in a grid layout.

" + } + }, + "com.amazonaws.quicksight#Group": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group.

" + } + }, + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

The group description.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the group.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A group in Amazon QuickSight consists of a set of users. You can\n use groups to make it easier to manage access and security.

" + } + }, + "com.amazonaws.quicksight#GroupDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#GroupFilterAttribute": { + "type": "enum", + "members": { + "GROUP_NAME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GROUP_NAME" + } + } + } + }, + "com.amazonaws.quicksight#GroupFilterOperator": { + "type": "enum", + "members": { + "StartsWith": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "StartsWith" + } + } + } + }, + "com.amazonaws.quicksight#GroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Group" + } + }, + "com.amazonaws.quicksight#GroupMember": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the group member (user).

" + } + }, + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "

The name of the group member (user).

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A member of an Amazon QuickSight group. Currently, group members must be users. Groups\n can't be members of another group. .

" + } + }, + "com.amazonaws.quicksight#GroupMemberList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GroupMember" + } + }, + "com.amazonaws.quicksight#GroupMemberName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#GroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#GroupSearchFilter": { + "type": "structure", + "members": { + "Operator": { + "target": "com.amazonaws.quicksight#GroupFilterOperator", + "traits": { + "smithy.api#documentation": "

The comparison operator that you want to use as a filter, for example \"Operator\":\n \"StartsWith\". Currently, the only supported operator is\n StartsWith.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#GroupFilterAttribute", + "traits": { + "smithy.api#documentation": "

The name of the value that you want to use as a filter, for example \"Name\":\n \"GROUP_NAME\". Currently, the only supported name is\n GROUP_NAME.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The value of the named item, in this case GROUP_NAME, that you want to use as a filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A GroupSearchFilter object that you want to apply to your search.

" + } + }, + "com.amazonaws.quicksight#GroupSearchFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#GroupSearchFilter" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#GroupsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#GrowthRateComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodSize": { + "target": "com.amazonaws.quicksight#GrowthRatePeriodSize", + "traits": { + "smithy.api#documentation": "

The period size setup of a growth rate computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The growth rate computation configuration.

" + } + }, + "com.amazonaws.quicksight#GrowthRatePeriodSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 2, + "max": 52 + } + } + }, + "com.amazonaws.quicksight#GutterStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

This Boolean value controls whether to display a gutter space between sheet tiles.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for gutter spacing between tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#HeaderFooterSectionConfiguration": { + "type": "structure", + "members": { + "SectionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of the header or footer section.

", + "smithy.api#required": {} + } + }, + "Layout": { + "target": "com.amazonaws.quicksight#SectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The layout configuration of the header or footer section.

", + "smithy.api#required": {} + } + }, + "Style": { + "target": "com.amazonaws.quicksight#SectionStyle", + "traits": { + "smithy.api#documentation": "

The style options of a header or footer section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a header or footer section.

" + } + }, + "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Rows": { + "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The rows field well of a heat map.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#HeatMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The columns field well of a heat map.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#HeatMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well of a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#HeatMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#HeatMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a heat map.

" + } + }, + "RowLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the row that is displayed in a heat map.

" + } + }, + "ColumnLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the column that is displayed in a heat map.

" + } + }, + "ColorScale": { + "target": "com.amazonaws.quicksight#ColorScale", + "traits": { + "smithy.api#documentation": "

The color options (gradient color, point of divergence) in a heat map.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapFieldWells": { + "type": "structure", + "members": { + "HeatMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#HeatMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a heat map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#HeatMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HeatMapSortConfiguration": { + "type": "structure", + "members": { + "HeatMapRowSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The field sort configuration of the rows fields.

" + } + }, + "HeatMapColumnSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The column sort configuration for heat map for columns that aren't a part of a field well.

" + } + }, + "HeatMapRowItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of rows that are displayed in a heat map.

" + } + }, + "HeatMapColumnItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of columns that are displayed in a heat map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a heat map.

" + } + }, + "com.amazonaws.quicksight#HeatMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#HeatMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a heat map.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#HexColor": { + "type": "string", + "traits": { + "smithy.api#pattern": "^#[A-F0-9]{6}$" + } + }, + "com.amazonaws.quicksight#HexColorWithTransparency": { + "type": "string", + "traits": { + "smithy.api#pattern": "^#[A-F0-9]{6}(?:[A-F0-9]{2})?$" + } + }, + "com.amazonaws.quicksight#HierarchyId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#HistogramAggregatedFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#HistogramMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "com.amazonaws.quicksight#HistogramBinOptions": { + "type": "structure", + "members": { + "SelectedBinType": { + "target": "com.amazonaws.quicksight#HistogramBinType", + "traits": { + "smithy.api#documentation": "

The options that determine the selected bin type.

" + } + }, + "BinCount": { + "target": "com.amazonaws.quicksight#BinCountOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the bin count of a histogram.

" + } + }, + "BinWidth": { + "target": "com.amazonaws.quicksight#BinWidthOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the bin width of a histogram.

" + } + }, + "StartValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The options that determine the bin start value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" + } + }, + "com.amazonaws.quicksight#HistogramBinType": { + "type": "enum", + "members": { + "BIN_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIN_COUNT" + } + }, + "BIN_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIN_WIDTH" + } + } + } + }, + "com.amazonaws.quicksight#HistogramConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#HistogramFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" + } + }, + "BinOptions": { + "target": "com.amazonaws.quicksight#HistogramBinOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of histogram bins.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a histogram.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a histogram.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a histogram.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a HistogramVisual.

" + } + }, + "com.amazonaws.quicksight#HistogramFieldWells": { + "type": "structure", + "members": { + "HistogramAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#HistogramAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a histogram.

" + } + }, + "com.amazonaws.quicksight#HistogramMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#HistogramVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#HistogramConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a HistogramVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#HorizontalTextAlignment": { + "type": "enum", + "members": { + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTER" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#Host": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignment": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

Assignment ID.

" + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

Assignment name.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the IAM policy.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

Identities.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

Assignment status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An Identity and Access Management (IAM) policy assignment.

" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^(?=^.{2,256}$)(?!.*\\s)[0-9a-zA-Z-_.:=+@]*$" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentSummary": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

Assignment name.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

Assignment status.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

IAM policy assignment summary.

" + } + }, + "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummary" + } + }, + "com.amazonaws.quicksight#IPv4Address": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 7, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#Icon": { + "type": "enum", + "members": { + "CARET_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_UP" + } + }, + "CARET_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CARET_DOWN" + } + }, + "PLUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PLUS" + } + }, + "MINUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUS" + } + }, + "ARROW_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP" + } + }, + "ARROW_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN" + } + }, + "ARROW_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_LEFT" + } + }, + "ARROW_UP_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP_LEFT" + } + }, + "ARROW_DOWN_LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN_LEFT" + } + }, + "ARROW_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_RIGHT" + } + }, + "ARROW_UP_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_UP_RIGHT" + } + }, + "ARROW_DOWN_RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ARROW_DOWN_RIGHT" + } + }, + "FACE_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_UP" + } + }, + "FACE_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_DOWN" + } + }, + "FACE_FLAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FACE_FLAT" + } + }, + "ONE_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ONE_BAR" + } + }, + "TWO_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TWO_BAR" + } + }, + "THREE_BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THREE_BAR" + } + }, + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "TRIANGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIANGLE" + } + }, + "SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQUARE" + } + }, + "FLAG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLAG" + } + }, + "THUMBS_UP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THUMBS_UP" + } + }, + "THUMBS_DOWN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THUMBS_DOWN" + } + }, + "CHECKMARK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CHECKMARK" + } + }, + "X": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "X" + } + } + } + }, + "com.amazonaws.quicksight#Identifier": { + "type": "structure", + "members": { + "Identity": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The identity of the identifier.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the identifier.

" + } + }, + "com.amazonaws.quicksight#IdentityCenterConfiguration": { + "type": "structure", + "members": { + "EnableIdentityPropagation": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A Boolean option that controls whether Trusted Identity Propagation should be used.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for an IAM Identity Center configuration.

" + } + }, + "com.amazonaws.quicksight#IdentityMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#String" + }, + "value": { + "target": "com.amazonaws.quicksight#IdentityNameList" + } + }, + "com.amazonaws.quicksight#IdentityName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#IdentityNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IdentityName" + } + }, + "com.amazonaws.quicksight#IdentityStore": { + "type": "enum", + "members": { + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + } + } + }, + "com.amazonaws.quicksight#IdentityType": { + "type": "enum", + "members": { + "IAM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM" + } + }, + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "IAM_IDENTITY_CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_IDENTITY_CENTER" + } + } + } + }, + "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The identity type specified isn't supported. Supported identity types include\n\t\t\t\tIAM and QUICKSIGHT.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#IncrementalRefresh": { + "type": "structure", + "members": { + "LookbackWindow": { + "target": "com.amazonaws.quicksight#LookbackWindow", + "traits": { + "smithy.api#documentation": "

The lookback window setup for an incremental refresh configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The incremental refresh configuration for a dataset.

" + } + }, + "com.amazonaws.quicksight#Ingestion": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", + "traits": { + "smithy.api#documentation": "

Ingestion ID.

" + } + }, + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", + "traits": { + "smithy.api#documentation": "

Ingestion status.

", + "smithy.api#required": {} + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#ErrorInfo", + "traits": { + "smithy.api#documentation": "

Error information for this ingestion.

" + } + }, + "RowInfo": { + "target": "com.amazonaws.quicksight#RowInfo" + }, + "QueueInfo": { + "target": "com.amazonaws.quicksight#QueueInfo" + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this ingestion started.

", + "smithy.api#required": {} + } + }, + "IngestionTimeInSeconds": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The time that this ingestion took, measured in seconds.

" + } + }, + "IngestionSizeInBytes": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The size of the data ingested, in bytes.

" + } + }, + "RequestSource": { + "target": "com.amazonaws.quicksight#IngestionRequestSource", + "traits": { + "smithy.api#documentation": "

Event source for this ingestion.

" + } + }, + "RequestType": { + "target": "com.amazonaws.quicksight#IngestionRequestType", + "traits": { + "smithy.api#documentation": "

Type of this ingestion.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the SPICE ingestion for a dataset.

" + } + }, + "com.amazonaws.quicksight#IngestionErrorType": { + "type": "enum", + "members": { + "FAILURE_TO_ASSUME_ROLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE_TO_ASSUME_ROLE" + } + }, + "INGESTION_SUPERSEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_SUPERSEDED" + } + }, + "INGESTION_CANCELED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INGESTION_CANCELED" + } + }, + "DATA_SET_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_DELETED" + } + }, + "DATA_SET_NOT_SPICE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_SPICE" + } + }, + "S3_UPLOADED_FILE_DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_UPLOADED_FILE_DELETED" + } + }, + "S3_MANIFEST_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_MANIFEST_ERROR" + } + }, + "DATA_TOLERANCE_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_TOLERANCE_EXCEPTION" + } + }, + "SPICE_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPICE_TABLE_NOT_FOUND" + } + }, + "DATA_SET_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_SIZE_LIMIT_EXCEEDED" + } + }, + "ROW_SIZE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROW_SIZE_LIMIT_EXCEEDED" + } + }, + "ACCOUNT_CAPACITY_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" + } + }, + "CUSTOMER_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOMER_ERROR" + } + }, + "DATA_SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_NOT_FOUND" + } + }, + "IAM_ROLE_NOT_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IAM_ROLE_NOT_AVAILABLE" + } + }, + "CONNECTION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONNECTION_FAILURE" + } + }, + "SQL_TABLE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_TABLE_NOT_FOUND" + } + }, + "PERMISSION_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_DENIED" + } + }, + "SSL_CERTIFICATE_VALIDATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SSL_CERTIFICATE_VALIDATION_FAILURE" + } + }, + "OAUTH_TOKEN_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OAUTH_TOKEN_FAILURE" + } + }, + "SOURCE_API_LIMIT_EXCEEDED_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_API_LIMIT_EXCEEDED_FAILURE" + } + }, + "PASSWORD_AUTHENTICATION_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PASSWORD_AUTHENTICATION_FAILURE" + } + }, + "SQL_SCHEMA_MISMATCH_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_SCHEMA_MISMATCH_ERROR" + } + }, + "INVALID_DATE_FORMAT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATE_FORMAT" + } + }, + "INVALID_DATAPREP_SYNTAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATAPREP_SYNTAX" + } + }, + "SOURCE_RESOURCE_LIMIT_EXCEEDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_RESOURCE_LIMIT_EXCEEDED" + } + }, + "SQL_INVALID_PARAMETER_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_INVALID_PARAMETER_VALUE" + } + }, + "QUERY_TIMEOUT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUERY_TIMEOUT" + } + }, + "SQL_NUMERIC_OVERFLOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_NUMERIC_OVERFLOW" + } + }, + "UNRESOLVABLE_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNRESOLVABLE_HOST" + } + }, + "UNROUTABLE_HOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNROUTABLE_HOST" + } + }, + "SQL_EXCEPTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQL_EXCEPTION" + } + }, + "S3_FILE_INACCESSIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "S3_FILE_INACCESSIBLE" + } + }, + "IOT_FILE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOT_FILE_NOT_FOUND" + } + }, + "IOT_DATA_SET_FILE_EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "IOT_DATA_SET_FILE_EMPTY" + } + }, + "INVALID_DATA_SOURCE_CONFIG": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATA_SOURCE_CONFIG" + } + }, + "DATA_SOURCE_AUTH_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_AUTH_FAILED" + } + }, + "DATA_SOURCE_CONNECTION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SOURCE_CONNECTION_FAILED" + } + }, + "FAILURE_TO_PROCESS_JSON_FILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILURE_TO_PROCESS_JSON_FILE" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + }, + "REFRESH_SUPPRESSED_BY_EDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REFRESH_SUPPRESSED_BY_EDIT" + } + }, + "PERMISSION_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_NOT_FOUND" + } + }, + "ELASTICSEARCH_CURSOR_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ELASTICSEARCH_CURSOR_NOT_ENABLED" + } + }, + "CURSOR_NOT_ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CURSOR_NOT_ENABLED" + } + }, + "DUPLICATE_COLUMN_NAMES_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATE_COLUMN_NAMES_FOUND" + } + } + } + }, + "com.amazonaws.quicksight#IngestionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9-_]+$" + } + }, + "com.amazonaws.quicksight#IngestionMaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#IngestionRequestSource": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCHEDULED" + } + } + } + }, + "com.amazonaws.quicksight#IngestionRequestType": { + "type": "enum", + "members": { + "INITIAL_INGESTION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIAL_INGESTION" + } + }, + "EDIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EDIT" + } + }, + "INCREMENTAL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_REFRESH" + } + }, + "FULL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REFRESH" + } + } + }, + "traits": { + "smithy.api#documentation": "This defines the type of ingestion request. This is returned as part of create ingestion response." + } + }, + "com.amazonaws.quicksight#IngestionStatus": { + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" + } + }, + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.quicksight#IngestionType": { + "type": "enum", + "members": { + "INCREMENTAL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCREMENTAL_REFRESH" + } + }, + "FULL_REFRESH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FULL_REFRESH" + } + } + }, + "traits": { + "smithy.api#documentation": "This defines the type of ingestion user wants to trigger. This is part of create ingestion request." + } + }, + "com.amazonaws.quicksight#Ingestions": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Ingestion" + } + }, + "com.amazonaws.quicksight#InnerFilter": { + "type": "structure", + "members": { + "CategoryInnerFilter": { + "target": "com.amazonaws.quicksight#CategoryInnerFilter", + "traits": { + "smithy.api#documentation": "

A CategoryInnerFilter filters text values for the NestedFilter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

" + } + }, + "com.amazonaws.quicksight#InputColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of this column in the underlying data source.

", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.quicksight#InputColumnDataType", + "traits": { + "smithy.api#documentation": "

The data type of the column.

", + "smithy.api#required": {} + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Metadata for a column that is used as the input of a transform operation.

" + } + }, + "com.amazonaws.quicksight#InputColumnDataType": { + "type": "enum", + "members": { + "STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRING" + } + }, + "INTEGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTEGER" + } + }, + "DECIMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DECIMAL" + } + }, + "DATETIME": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATETIME" + } + }, + "BIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BIT" + } + }, + "BOOLEAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOOLEAN" + } + }, + "JSON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JSON" + } + } + } + }, + "com.amazonaws.quicksight#InputColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#InputColumn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#InsightConfiguration": { + "type": "structure", + "members": { + "Computations": { + "target": "com.amazonaws.quicksight#ComputationList", + "traits": { + "smithy.api#documentation": "

The computations configurations of the insight visual

" + } + }, + "CustomNarrative": { + "target": "com.amazonaws.quicksight#CustomNarrativeOptions", + "traits": { + "smithy.api#documentation": "

The custom narrative of the insight visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of an insight visual.

" + } + }, + "com.amazonaws.quicksight#InsightVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "InsightConfiguration": { + "target": "com.amazonaws.quicksight#InsightConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of an insight visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The dataset that is used in the insight visual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#InstanceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#Integer": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the integer parameter created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the integer parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given integer parameter. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An integer parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The default value for the integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of an integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#IntegerDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveLongObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#IntegerDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the IntegerDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the IntegerParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#IntegerParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of the integer parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveLongList", + "traits": { + "smithy.api#documentation": "

The values for the integer parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An integer parameter.

" + } + }, + "com.amazonaws.quicksight#IntegerParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#IntegerDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "com.amazonaws.quicksight#IntegerParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#IntegerParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#IntegerValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveLong", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#InternalFailureException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An internal failure occurred.

", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.quicksight#InvalidNextTokenException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The NextToken value isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidParameterValueException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more parameters has a value that isn't valid.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidRequestException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

You don't have this feature activated for your account. To fix this issue, contact Amazon Web Services support.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#InvalidTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the InvalidTopicReviewedAnswer.

" + } + }, + "Error": { + "target": "com.amazonaws.quicksight#ReviewedAnswerErrorCode", + "traits": { + "smithy.api#documentation": "

The error that is returned for the InvalidTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a InvalidTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#InvalidTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#InvalidTopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#IpRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#IpRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#CIDR" + }, + "value": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#ItemsLimitConfiguration": { + "type": "structure", + "members": { + "ItemsLimit": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The limit on how many items of a field are showed in the chart. For\n example, the number of slices that are displayed in a pie chart.

" + } + }, + "OtherCategories": { + "target": "com.amazonaws.quicksight#OtherCategories", + "traits": { + "smithy.api#documentation": "

The Show\n other of an axis in the chart. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The limit configuration of the visual display for an axis.

" + } + }, + "com.amazonaws.quicksight#JiraParameters": { + "type": "structure", + "members": { + "SiteBaseUrl": { + "target": "com.amazonaws.quicksight#SiteBaseUrl", + "traits": { + "smithy.api#documentation": "

The base URL of the Jira site.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Jira.

" + } + }, + "com.amazonaws.quicksight#JoinInstruction": { + "type": "structure", + "members": { + "LeftOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", + "traits": { + "smithy.api#documentation": "

The operand on the left side of a join.

", + "smithy.api#required": {} + } + }, + "RightOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", + "traits": { + "smithy.api#documentation": "

The operand on the right side of a join.

", + "smithy.api#required": {} + } + }, + "LeftJoinKeyProperties": { + "target": "com.amazonaws.quicksight#JoinKeyProperties", + "traits": { + "smithy.api#documentation": "

Join key properties of the left operand.

" + } + }, + "RightJoinKeyProperties": { + "target": "com.amazonaws.quicksight#JoinKeyProperties", + "traits": { + "smithy.api#documentation": "

Join key properties of the right operand.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#JoinType", + "traits": { + "smithy.api#documentation": "

The type of join that it is.

", + "smithy.api#required": {} + } + }, + "OnClause": { + "target": "com.amazonaws.quicksight#OnClause", + "traits": { + "smithy.api#documentation": "

The join instructions provided in the ON clause of a join.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The instructions associated with a join.

" + } + }, + "com.amazonaws.quicksight#JoinKeyProperties": { + "type": "structure", + "members": { + "UniqueKey": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

A value that indicates that a row in a table is uniquely identified by the columns in\n a join key. This is used by Amazon QuickSight to optimize query performance.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Properties associated with the columns participating in a join.

" + } + }, + "com.amazonaws.quicksight#JoinType": { + "type": "enum", + "members": { + "INNER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INNER" + } + }, + "OUTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTER" + } + }, + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#KPIActualValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the actual value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the comparison value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#KPIConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormattingOption": { + "type": "structure", + "members": { + "PrimaryValue": { + "target": "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" + } + }, + "ProgressBar": { + "target": "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" + } + }, + "ActualValue": { + "target": "com.amazonaws.quicksight#KPIActualValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the actual value of a KPI visual.

" + } + }, + "ComparisonValue": { + "target": "com.amazonaws.quicksight#KPIComparisonValueConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the comparison value of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting options of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#KPIConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#KPIConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#KPIFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a KPI visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#KPISortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a KPI visual.

" + } + }, + "KPIOptions": { + "target": "com.amazonaws.quicksight#KPIOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a KPI visual.

" + } + }, + "TargetValues": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The target value field wells of a KPI visual.

" + } + }, + "TrendGroups": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The trend group field wells of a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIOptions": { + "type": "structure", + "members": { + "ProgressBar": { + "target": "com.amazonaws.quicksight#ProgressBarOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" + } + }, + "TrendArrows": { + "target": "com.amazonaws.quicksight#TrendArrowOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" + } + }, + "SecondaryValue": { + "target": "com.amazonaws.quicksight#SecondaryValueOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" + } + }, + "Comparison": { + "target": "com.amazonaws.quicksight#ComparisonConfiguration", + "traits": { + "smithy.api#documentation": "

The comparison configuration of a KPI visual.

" + } + }, + "PrimaryValueDisplayType": { + "target": "com.amazonaws.quicksight#PrimaryValueDisplayType", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value display type.

" + } + }, + "PrimaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the primary value font configuration.

" + } + }, + "SecondaryValueFontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the secondary value font configuration.

" + } + }, + "Sparkline": { + "target": "com.amazonaws.quicksight#KPISparklineOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "VisualLayoutOptions": { + "target": "com.amazonaws.quicksight#KPIVisualLayoutOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIPrimaryValueConditionalFormatting": { + "type": "structure", + "members": { + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value's text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the primary value's icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the primary value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIProgressBarConditionalFormatting": { + "type": "structure", + "members": { + "ForegroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting of the progress bar's foreground color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the progress bar of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISortConfiguration": { + "type": "structure", + "members": { + "TrendGroupSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the trend group fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISparklineOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the sparkline.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#KPISparklineType", + "traits": { + "smithy.api#documentation": "

The type of the sparkline.

", + "smithy.api#required": {} + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the sparkline.

" + } + }, + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The tooltip visibility of the sparkline.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPISparklineType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + } + } + }, + "com.amazonaws.quicksight#KPIVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#KPIConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a KPI visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#KPIConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting of a KPI visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#KPIVisualLayoutOptions": { + "type": "structure", + "members": { + "StandardLayout": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayout", + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the layout a KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayout": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#KPIVisualStandardLayoutType", + "traits": { + "smithy.api#documentation": "

The standard layout type.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The standard layout of the KPI visual.

" + } + }, + "com.amazonaws.quicksight#KPIVisualStandardLayoutType": { + "type": "enum", + "members": { + "CLASSIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CLASSIC" + } + }, + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#KeyRegistration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RegisteredCustomerManagedKey" + } + }, + "com.amazonaws.quicksight#LabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the label is visible.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The text for the label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The share label options for the labels.

" + } + }, + "com.amazonaws.quicksight#Latitude": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -90, + "max": 90 + } + } + }, + "com.amazonaws.quicksight#Layout": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.quicksight#LayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines what the type of layout for a sheet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A Layout defines the placement of elements within a sheet.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayoutConfiguration": { + "type": "structure", + "members": { + "GridLayout": { + "target": "com.amazonaws.quicksight#GridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

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: FIXED or RESPONSIVE.

" + } + }, + "FreeFormLayout": { + "target": "com.amazonaws.quicksight#FreeFormLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.

" + } + }, + "SectionBasedLayout": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

A section based layout organizes visuals into multiple sections and has customized header, footer and page break.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that determines what the type of layout will be used on a sheet.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LayoutElementType": { + "type": "enum", + "members": { + "VISUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISUAL" + } + }, + "FILTER_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_CONTROL" + } + }, + "PARAMETER_CONTROL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARAMETER_CONTROL" + } + }, + "TEXT_BOX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TEXT_BOX" + } + } + } + }, + "com.amazonaws.quicksight#LayoutList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Layout" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#LegendOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the legend is visible.

" + } + }, + "Title": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The custom title for the legend.

" + } + }, + "Position": { + "target": "com.amazonaws.quicksight#LegendPosition", + "traits": { + "smithy.api#documentation": "

The positions for the legend. Choose one of the following\n options:

\n " + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of the legend. If this value is omitted, a default width is used when rendering.

" + } + }, + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of the legend. If this value is omitted, a default height is used when\n rendering.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the legend setup of a visual.

" + } + }, + "com.amazonaws.quicksight#LegendPosition": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + } + } + }, + "com.amazonaws.quicksight#Length": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit" + } + }, + "com.amazonaws.quicksight#LimitExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

Limit exceeded.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A limit is exceeded.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#LimitedString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#LineChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a line chart. Values are grouped by category fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a line chart. Values are aggregated based on categories.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The color field wells of a line chart. Values are grouped by category fields.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#LineChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#LineChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a line chart.

" + } + }, + "ForecastConfigurations": { + "target": "com.amazonaws.quicksight#ForecastConfigurationList", + "traits": { + "smithy.api#documentation": "

The forecast configuration of a line chart.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#LineChartType", + "traits": { + "smithy.api#documentation": "

Determines the type of the line chart.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the x-axis label.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" + } + }, + "SecondaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "SecondaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary y-axis label.

" + } + }, + "SingleAxisOptions": { + "target": "com.amazonaws.quicksight#SingleAxisOptions" + }, + "DefaultSeriesSettings": { + "target": "com.amazonaws.quicksight#LineChartDefaultSeriesSettings", + "traits": { + "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" + } + }, + "Series": { + "target": "com.amazonaws.quicksight#SeriesItemList", + "traits": { + "smithy.api#documentation": "

The series item configuration of a line chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend configuration of a line chart.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a line chart.

" + } + }, + "ReferenceLines": { + "target": "com.amazonaws.quicksight#ReferenceLineList", + "traits": { + "smithy.api#documentation": "

The reference lines configuration of a line chart.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip configuration of a line chart.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The default configuration of a line chart's contribution analysis.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a line chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartDefaultSeriesSettings": { + "type": "structure", + "members": { + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis to which you are binding all line series to.

" + } + }, + "LineStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", + "traits": { + "smithy.api#documentation": "

Line styles options for all line series in the visual.

" + } + }, + "MarkerStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", + "traits": { + "smithy.api#documentation": "

Marker styles options for all line series in the visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the default presentation of all line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartFieldWells": { + "type": "structure", + "members": { + "LineChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#LineChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartLineStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + } + } + }, + "com.amazonaws.quicksight#LineChartLineStyleSettings": { + "type": "structure", + "members": { + "LineVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Configuration option that determines whether to show the line for the series.

" + } + }, + "LineInterpolation": { + "target": "com.amazonaws.quicksight#LineInterpolation", + "traits": { + "smithy.api#documentation": "

Interpolation style for line series.

\n " + } + }, + "LineStyle": { + "target": "com.amazonaws.quicksight#LineChartLineStyle", + "traits": { + "smithy.api#documentation": "

Line style for line series.

\n " + } + }, + "LineWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Width that determines the line thickness.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartMarkerShape": { + "type": "enum", + "members": { + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "TRIANGLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRIANGLE" + } + }, + "SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SQUARE" + } + }, + "DIAMOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIAMOND" + } + }, + "ROUNDED_SQUARE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROUNDED_SQUARE" + } + } + } + }, + "com.amazonaws.quicksight#LineChartMarkerStyleSettings": { + "type": "structure", + "members": { + "MarkerVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Configuration option that determines whether to show the markers in the series.

" + } + }, + "MarkerShape": { + "target": "com.amazonaws.quicksight#LineChartMarkerShape", + "traits": { + "smithy.api#documentation": "

Shape option for markers in the series.

\n " + } + }, + "MarkerSize": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Size of marker in the series.

" + } + }, + "MarkerColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Color of marker in the series.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" + } + }, + "com.amazonaws.quicksight#LineChartSeriesSettings": { + "type": "structure", + "members": { + "LineStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartLineStyleSettings", + "traits": { + "smithy.api#documentation": "

Line styles options for a line series in LineChartVisual.

" + } + }, + "MarkerStyleSettings": { + "target": "com.amazonaws.quicksight#LineChartMarkerStyleSettings", + "traits": { + "smithy.api#documentation": "

Marker styles options for a line series in LineChartVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a line series in the visual

" + } + }, + "com.amazonaws.quicksight#LineChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories that are displayed in a line chart.

" + } + }, + "ColorItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of lines that are displayed in a line chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LineChartType": { + "type": "enum", + "members": { + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + }, + "AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AREA" + } + }, + "STACKED_AREA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STACKED_AREA" + } + } + } + }, + "com.amazonaws.quicksight#LineChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#LineChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a line chart.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#LineInterpolation": { + "type": "enum", + "members": { + "LINEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINEAR" + } + }, + "SMOOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMOOTH" + } + }, + "STEPPED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STEPPED" + } + } + } + }, + "com.amazonaws.quicksight#LineSeriesAxisDisplayOptions": { + "type": "structure", + "members": { + "AxisOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the line series axis.

" + } + }, + "MissingDataConfigurations": { + "target": "com.amazonaws.quicksight#MissingDataConfigurationList", + "traits": { + "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series axis configuration of a line chart.

" + } + }, + "com.amazonaws.quicksight#LinkEntityArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + }, + "smithy.api#pattern": "^arn:aws[\\w\\-]*:quicksight:[\\w\\-]+:\\d+:analysis/[\\w\\-]{1,512}$" + } + }, + "com.amazonaws.quicksight#LinkEntityArnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LinkEntityArn" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#LinkSharingConfiguration": { + "type": "structure", + "members": { + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that contains the permissions of a shareable link.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the configuration of a shareable link to the dashboard.

" + } + }, + "com.amazonaws.quicksight#ListAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAnalysesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

Metadata describing each of the analyses that are listed.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetBundleExportJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the export jobs were executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleExportJobsResponse": { + "type": "structure", + "members": { + "AssetBundleExportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobSummaryList", + "traits": { + "smithy.api#documentation": "

A list of export job summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AssetBundleImportJobSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the import jobs were executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListAssetBundleImportJobsResponse": { + "type": "structure", + "members": { + "AssetBundleImportJobSummaryList": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobSummaryList", + "traits": { + "smithy.api#documentation": "

A list of import job summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListControlDisplayOptions": { + "type": "structure", + "members": { + "SearchOptions": { + "target": "com.amazonaws.quicksight#ListControlSearchOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the search options in a list control.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#ListControlSelectAllOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" + } + }, + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#ListControlSearchOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the search options in a list control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the search options in a list control.

" + } + }, + "com.amazonaws.quicksight#ListControlSelectAllOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the Select all options in a list control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the Select all options in a list control.

" + } + }, + "com.amazonaws.quicksight#ListDashboardVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDashboardVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDashboardVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the dashboards in the Amazon QuickSight subscription.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDashboardVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're listing versions\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDashboardVersionsResponse": { + "type": "structure", + "members": { + "DashboardVersionSummaryList": { + "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains information about each version of the dashboard.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists dashboards in an Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/dashboards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDashboardsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboards that you're\n listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDashboardsResponse": { + "type": "structure", + "members": { + "DashboardSummaryList": { + "target": "com.amazonaws.quicksight#DashboardSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the dashboards in your Amazon Web Services account. This structure\n provides basic information about the dashboards.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSetsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDataSetsResponse": { + "type": "structure", + "members": { + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", + "traits": { + "smithy.api#documentation": "

The list of dataset summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSources", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListDataSourcesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListDataSourcesResponse": { + "type": "structure", + "members": { + "DataSources": { + "target": "com.amazonaws.quicksight#DataSourceList", + "traits": { + "smithy.api#documentation": "

A list of data sources.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListFolderMembers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListFolderMembersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListFolderMembersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderMemberList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFolderMembersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFolderMembersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderMemberList": { + "target": "com.amazonaws.quicksight#FolderMemberList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListFolders": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListFoldersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListFoldersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all folders in an account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListFoldersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListFoldersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListGroupMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListGroupMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListGroupMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists member users in a group.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupMemberList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListGroupMembershipsRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to see a membership list of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want a list of users from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListGroupMembershipsResponse": { + "type": "structure", + "members": { + "GroupMemberList": { + "target": "com.amazonaws.quicksight#GroupMemberList", + "traits": { + "smithy.api#documentation": "

The list of the members of the group.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all user groups in Amazon QuickSight.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListGroupsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want a list of groups from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

The list of the groups.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignments": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the\n\t\t\tIAM policy assignments in the current Amazon QuickSight\n\t\t\taccount.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/v2/iam-policy-assignments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "IAMPolicyAssignments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of\n\t\t\tthe IAM policy assignments, including the Amazon\n\t\t\tResource Names\n\t\t\t(ARNs),\n\t\t\tfor the IAM policies assigned to the specified user and\n\t\t\tgroup,\n\t\t\tor groups that the user belongs to.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ActiveAssignments", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the assignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The name of the user.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse": { + "type": "structure", + "members": { + "ActiveAssignments": { + "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", + "traits": { + "smithy.api#documentation": "

The active assignments for this user.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains these IAM policy\n\t\t\tassignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignments.

", + "smithy.api#httpQuery": "assignment-status" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace for the assignments.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { + "type": "structure", + "members": { + "IAMPolicyAssignments": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", + "traits": { + "smithy.api#documentation": "

Information describing the IAM policy assignments.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigs": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contain the identity propagation configurations of.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#ListIdentityPropagationMaxResults", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The maximum number of results to be returned.

", + "smithy.api#httpQuery": "max-results" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationConfigsResponse": { + "type": "structure", + "members": { + "Services": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsByServices", + "traits": { + "smithy.api#documentation": "

A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListIdentityPropagationMaxResults": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#ListIngestions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListIngestionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListIngestionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the history of SPICE ingestions for a dataset.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Ingestions", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListIngestionsRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset used in the ingestion.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#IngestionMaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListIngestionsResponse": { + "type": "structure", + "members": { + "Ingestions": { + "target": "com.amazonaws.quicksight#Ingestions", + "traits": { + "smithy.api#documentation": "

A list of the ingestions.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListNamespaces": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListNamespacesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListNamespacesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Namespaces", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListNamespacesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListNamespacesResponse": { + "type": "structure", + "members": { + "Namespaces": { + "target": "com.amazonaws.quicksight#Namespaces", + "traits": { + "smithy.api#documentation": "

The information about the namespaces in this Amazon Web Services account. The response includes \n the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and \n identity store.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRefreshSchedulesResponse": { + "type": "structure", + "members": { + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#RefreshSchedules", + "traits": { + "smithy.api#documentation": "

The list of refresh schedules for the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListRoleMemberships": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListRoleMembershipsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#UpdateFolder": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateFolderRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateFolderResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the name of a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#UpdateFolderPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateFolderPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateFolderPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates permissions of a folder.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" }, - "com.amazonaws.quicksight#UpdateFolderPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#UpdateFolderPermissionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

Information about the permissions for the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#UpdateFolderRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#FolderName", - "traits": { - "smithy.api#documentation": "

The name of the folder.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all groups that are associated with a role.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/members", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "MembersList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsRequest": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

", + "smithy.api#httpQuery": "max-results" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that includes the role.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListRoleMembershipsResponse": { + "type": "structure", + "members": { + "MembersList": { + "target": "com.amazonaws.quicksight#GroupsList", + "traits": { + "smithy.api#documentation": "

The list of groups associated with a role

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the tags assigned to a resource.

", + "smithy.api#http": { + "method": "GET", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want a list of tags for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplateAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplateAliasesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplateAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the aliases of a template.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateAliasList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplateAliasesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template aliases that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplateAliasesResponse": { + "type": "structure", + "members": { + "TemplateAliasList": { + "target": "com.amazonaws.quicksight#TemplateAliasList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of the template's aliases.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplateVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplateVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplateVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the templates in the current Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplateVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplateVersionsResponse": { + "type": "structure", + "members": { + "TemplateVersionSummaryList": { + "target": "com.amazonaws.quicksight#TemplateVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing a list of all the versions of the specified template.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTemplates": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTemplatesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTemplatesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the templates in the current Amazon QuickSight account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/templates", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TemplateSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTemplatesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the templates that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTemplatesResponse": { + "type": "structure", + "members": { + "TemplateSummaryList": { + "target": "com.amazonaws.quicksight#TemplateSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing information about the templates in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemeAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemeAliasesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemeAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the aliases of a theme.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListThemeAliasesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme aliases that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-result" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemeAliasesResponse": { + "type": "structure", + "members": { + "ThemeAliasList": { + "target": "com.amazonaws.quicksight#ThemeAliasList", + "traits": { + "smithy.api#documentation": "

A structure containing the list of the theme's aliases.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemeVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemeVersionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemeVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the versions of the themes in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/versions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThemeVersionSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListThemeVersionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemeVersionsResponse": { + "type": "structure", + "members": { + "ThemeVersionSummaryList": { + "target": "com.amazonaws.quicksight#ThemeVersionSummaryList", + "traits": { + "smithy.api#documentation": "

A structure containing a list of all the versions of the specified theme.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListThemes": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListThemesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListThemesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all the themes in the current Amazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/themes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "ThemeSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListThemesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the themes that you're listing.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", + "traits": { + "smithy.api#documentation": "

The type of themes that you want to list. Valid options include the following:

\n ", + "smithy.api#httpQuery": "type" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListThemesResponse": { + "type": "structure", + "members": { + "ThemeSummaryList": { + "target": "com.amazonaws.quicksight#ThemeSummaryList", + "traits": { + "smithy.api#documentation": "

Information about the themes in the list.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the refresh schedules for a topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedulesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want described.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicRefreshSchedulesResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "RefreshSchedules": { + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummaries", + "traits": { + "smithy.api#documentation": "

The list of topic refresh schedules.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all reviewed answers for a Q Topic.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/reviewed-answers", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that containd the reviewed answers that you want listed.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicReviewedAnswersResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic that contains the reviewed answer that you want to list. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Answers": { + "target": "com.amazonaws.quicksight#TopicReviewedAnswers", + "traits": { + "smithy.api#documentation": "

The definition of all Answers in the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListTopics": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListTopicsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListTopicsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the topics within an account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/topics", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListTopicsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topics that you want to\n list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListTopicsResponse": { + "type": "structure", + "members": { + "TopicsSummaries": { + "target": "com.amazonaws.quicksight#TopicSummaries", + "traits": { + "smithy.api#documentation": "

A list of topic summaries.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUserGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUserGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUserGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListUserGroupsRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to list group memberships for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account\n\t\t\tthat contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListUserGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

The list of groups the user is a member of.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListUsers": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListUsersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListUsersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Returns a list of all of the Amazon QuickSight users belonging to this account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "UserList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListUsersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListUsersResponse": { + "type": "structure", + "members": { + "UserList": { + "target": "com.amazonaws.quicksight#UserList", + "traits": { + "smithy.api#documentation": "

The list of users.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnections": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#ListVPCConnectionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Lists all of the VPC connections in the current set Amazon Web Services Region of an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#http": { + "method": "GET", + "uri": "/accounts/{AwsAccountId}/vpc-connections", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connections\n\t\t\tthat you want to list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

", + "smithy.api#httpQuery": "max-results" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#ListVPCConnectionsResponse": { + "type": "structure", + "members": { + "VPCConnectionSummaries": { + "target": "com.amazonaws.quicksight#VPCConnectionSummaryList", + "traits": { + "smithy.api#documentation": "

A VPCConnectionSummaries object that returns a summary of VPC connection\n\t\t\tobjects.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more\n\t\t\tresults.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#LoadingAnimation": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of LoadingAnimation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of loading animation in free-form layout.

" + } + }, + "com.amazonaws.quicksight#LocalNavigationConfiguration": { + "type": "structure", + "members": { + "TargetSheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The sheet that is targeted for navigation in the same analysis.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The navigation configuration for CustomActionNavigationOperation.

" + } + }, + "com.amazonaws.quicksight#LogicalTable": { + "type": "structure", + "members": { + "Alias": { + "target": "com.amazonaws.quicksight#LogicalTableAlias", + "traits": { + "smithy.api#documentation": "

A display name for the logical table.

", + "smithy.api#required": {} + } + }, + "DataTransforms": { + "target": "com.amazonaws.quicksight#TransformOperationList", + "traits": { + "smithy.api#documentation": "

Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.

" + } + }, + "Source": { + "target": "com.amazonaws.quicksight#LogicalTableSource", + "traits": { + "smithy.api#documentation": "

Source of this logical table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A logical table is a unit that joins and that data\n transformations operate on. A logical table has a source, which can be either a physical\n table or result of a join. When a logical table points to a physical table, the logical\n table acts as a mutable copy of that physical table through transform operations.

" + } + }, + "com.amazonaws.quicksight#LogicalTableAlias": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#LogicalTableId": { + "type": "string", + "traits": { + "smithy.api#documentation": "

An identifier for the logical table that is defined in the dataset

", + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.quicksight#LogicalTableMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LogicalTableId" + }, + "value": { + "target": "com.amazonaws.quicksight#LogicalTable" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#LogicalTableSource": { + "type": "structure", + "members": { + "JoinInstruction": { + "target": "com.amazonaws.quicksight#JoinInstruction", + "traits": { + "smithy.api#documentation": "

Specifies the result of a join of two logical tables.

" + } + }, + "PhysicalTableId": { + "target": "com.amazonaws.quicksight#PhysicalTableId", + "traits": { + "smithy.api#documentation": "

Physical table ID.

" + } + }, + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Number (ARN) of the parent dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the source of a logical table. This is a variant type structure. For\n this structure to be valid, only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#Long": { + "type": "long", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#LongFormatText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#LongPlainText", + "traits": { + "smithy.api#documentation": "

Plain text format.

" + } + }, + "RichText": { + "target": "com.amazonaws.quicksight#LongRichText", + "traits": { + "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text format for a subtitle.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#LongPlainText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#LongRichText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#Longitude": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -1800, + "max": 1800 + } + } + }, + "com.amazonaws.quicksight#LookbackWindow": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of the lookback window column.

", + "smithy.api#required": {} + } + }, + "Size": { + "target": "com.amazonaws.quicksight#PositiveLong", + "traits": { + "smithy.api#documentation": "

The lookback window column size.

", + "smithy.api#required": {} + } + }, + "SizeUnit": { + "target": "com.amazonaws.quicksight#LookbackWindowSizeUnit", + "traits": { + "smithy.api#documentation": "

The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The lookback window setup of an incremental refresh configuration.

" + } + }, + "com.amazonaws.quicksight#LookbackWindowSizeUnit": { + "type": "enum", + "members": { + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + } + } + }, + "com.amazonaws.quicksight#ManifestFileLocation": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.quicksight#S3Bucket", + "traits": { + "smithy.api#documentation": "

Amazon S3 bucket.

", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.quicksight#S3Key", + "traits": { + "smithy.api#documentation": "

Amazon S3 key that identifies an object.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Amazon S3 manifest file location.

" + } + }, + "com.amazonaws.quicksight#MapZoomMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.quicksight#MappedDataSetParameter": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

A unique name that identifies a dataset within the analysis or dashboard.

", + "smithy.api#required": {} + } + }, + "DataSetParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the dataset parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A dataset parameter that is mapped to an analysis parameter.

" + } + }, + "com.amazonaws.quicksight#MappedDataSetParameters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MappedDataSetParameter" + }, + "traits": { + "smithy.api#documentation": "

A list of dataset parameters that are mapped to an analysis parameter.

", + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#MarginStyle": { + "type": "structure", + "members": { + "Show": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

This Boolean value controls whether to display sheet margins.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for margins around the outside edge of sheets.

" + } + }, + "com.amazonaws.quicksight#MariaDbParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for MariaDB.

" + } + }, + "com.amazonaws.quicksight#MaxResults": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#MaximumLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the maximum label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum label of a data path label.

" + } + }, + "com.amazonaws.quicksight#MaximumMinimumComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#MaximumMinimumComputationType", + "traits": { + "smithy.api#documentation": "

The type of computation. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The maximum and minimum computation configuration.

" + } + }, + "com.amazonaws.quicksight#MaximumMinimumComputationType": { + "type": "enum", + "members": { + "MAXIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAXIMUM" + } + }, + "MINIMUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINIMUM" + } + } + } + }, + "com.amazonaws.quicksight#MeasureField": { + "type": "structure", + "members": { + "NumericalMeasureField": { + "target": "com.amazonaws.quicksight#NumericalMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with numerical type columns.

" + } + }, + "CategoricalMeasureField": { + "target": "com.amazonaws.quicksight#CategoricalMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with categorical type columns.

" + } + }, + "DateMeasureField": { + "target": "com.amazonaws.quicksight#DateMeasureField", + "traits": { + "smithy.api#documentation": "

The measure type field with date type columns.

" + } + }, + "CalculatedMeasureField": { + "target": "com.amazonaws.quicksight#CalculatedMeasureField", + "traits": { + "smithy.api#documentation": "

The calculated measure field only used in pivot tables.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure (metric) type field.

" + } + }, + "com.amazonaws.quicksight#MeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#MemberIdArnPair": { + "type": "structure", + "members": { + "MemberId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the member.

" + } + }, + "MemberArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the member.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that consists of a member Amazon Resource Name (ARN) and a member ID.

" + } + }, + "com.amazonaws.quicksight#MemberType": { + "type": "enum", + "members": { + "DASHBOARD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHBOARD" + } + }, + "ANALYSIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ANALYSIS" + } + }, + "DATASET": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET" + } + }, + "DATASOURCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASOURCE" + } + }, + "TOPIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOPIC" + } + } + } + }, + "com.amazonaws.quicksight#MetricComparisonComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "FromValue": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The field that is used in a metric comparison from value setup.

" + } + }, + "TargetValue": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The field that is used in a metric comparison to value setup.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The metric comparison computation configuration.

" + } + }, + "com.amazonaws.quicksight#MinimumLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the minimum label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The minimum label of a data path label.

" + } + }, + "com.amazonaws.quicksight#MissingDataConfiguration": { + "type": "structure", + "members": { + "TreatmentOption": { + "target": "com.amazonaws.quicksight#MissingDataTreatmentOption", + "traits": { + "smithy.api#documentation": "

The treatment option that determines how missing data should be rendered. Choose\n from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration options that determine how missing data is treated during the rendering of a line chart.

" + } + }, + "com.amazonaws.quicksight#MissingDataConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MissingDataConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#MissingDataTreatmentOption": { + "type": "enum", + "members": { + "INTERPOLATE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERPOLATE" + } + }, + "SHOW_AS_ZERO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHOW_AS_ZERO" + } + }, + "SHOW_AS_BLANK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHOW_AS_BLANK" + } + } + } + }, + "com.amazonaws.quicksight#MySqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for MySQL.

" + } + }, + "com.amazonaws.quicksight#NamedEntityAggType": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "PERCENTILE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENTILE" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + } + } + }, + "com.amazonaws.quicksight#NamedEntityDefinition": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the entity.

" + } + }, + "PropertyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The property name to be used for the named entity.

" + } + }, + "PropertyRole": { + "target": "com.amazonaws.quicksight#PropertyRole", + "traits": { + "smithy.api#documentation": "

The property role. Valid values for this structure are PRIMARY and ID.

" + } + }, + "PropertyUsage": { + "target": "com.amazonaws.quicksight#PropertyUsage", + "traits": { + "smithy.api#documentation": "

The property usage. Valid values for this structure are INHERIT,\n DIMENSION,\n and MEASURE.

" + } + }, + "Metric": { + "target": "com.amazonaws.quicksight#NamedEntityDefinitionMetric", + "traits": { + "smithy.api#documentation": "

The definition of a metric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a named entity.

" + } + }, + "com.amazonaws.quicksight#NamedEntityDefinitionMetric": { + "type": "structure", + "members": { + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedEntityAggType", + "traits": { + "smithy.api#documentation": "

The aggregation of a named entity. Valid values for this structure are SUM,\n MIN, MAX, COUNT, AVERAGE,\n DISTINCT_COUNT, STDEV, STDEVP, VAR,\n VARP, PERCENTILE,\n MEDIAN,\n and CUSTOM.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggregationFunctionParameters", + "traits": { + "smithy.api#documentation": "

The additional parameters for an aggregation function.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a metric.

" + } + }, + "com.amazonaws.quicksight#NamedEntityDefinitions": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamedEntityDefinition" + } + }, + "com.amazonaws.quicksight#NamedEntityRef": { + "type": "structure", + "members": { + "NamedEntityName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The NamedEntityName for the NamedEntityRef.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a NamedEntityRef.

" + } + }, + "com.amazonaws.quicksight#NamedFilterAggType": { + "type": "enum", + "members": { + "NO_AGGREGATION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NO_AGGREGATION" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + } + } + }, + "com.amazonaws.quicksight#NamedFilterType": { + "type": "enum", + "members": { + "CATEGORY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORY_FILTER" + } + }, + "NUMERIC_EQUALITY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" + } + }, + "NUMERIC_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" + } + }, + "DATE_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE_FILTER" + } + }, + "RELATIVE_DATE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE_DATE_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#Namespace": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9._-]*$" + } + }, + "com.amazonaws.quicksight#NamespaceError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#NamespaceErrorType", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The message for the error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Errors that occur during namespace creation.

" + } + }, + "com.amazonaws.quicksight#NamespaceErrorType": { + "type": "enum", + "members": { + "PERMISSION_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERMISSION_DENIED" + } + }, + "INTERNAL_SERVICE_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_SERVICE_ERROR" + } + } + } + }, + "com.amazonaws.quicksight#NamespaceInfoV2": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The name of the error.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The namespace ARN.

" + } + }, + "CapacityRegion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The namespace Amazon Web Services Region.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#NamespaceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of a namespace that is not yet completely created.

" + } + }, + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", + "traits": { + "smithy.api#documentation": "

The identity store used for the namespace.

" + } + }, + "NamespaceError": { + "target": "com.amazonaws.quicksight#NamespaceError", + "traits": { + "smithy.api#documentation": "

An error that occurred when the namespace was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The error type.

" + } + }, + "com.amazonaws.quicksight#NamespaceStatus": { + "type": "enum", + "members": { + "CREATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATED" + } + }, + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RETRYABLE_FAILURE" + } + }, + "NON_RETRYABLE_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_RETRYABLE_FAILURE" + } + } + } + }, + "com.amazonaws.quicksight#Namespaces": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NamespaceInfoV2" + } + }, + "com.amazonaws.quicksight#NarrativeString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150000 + } + } + }, + "com.amazonaws.quicksight#NegativeFormat": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The prefix for a negative format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The suffix for a negative format.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a negative format.

" + } + }, + "com.amazonaws.quicksight#NegativeValueConfiguration": { + "type": "structure", + "members": { + "DisplayMode": { + "target": "com.amazonaws.quicksight#NegativeValueDisplayMode", + "traits": { + "smithy.api#documentation": "

Determines the display mode of the negative value configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "com.amazonaws.quicksight#NegativeValueDisplayMode": { + "type": "enum", + "members": { + "POSITIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POSITIVE" + } + }, + "NEGATIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEGATIVE" + } + } + } + }, + "com.amazonaws.quicksight#NestedFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeInnerSet": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean condition to include or exclude the subset that is defined by the values of the nested inner filter.

", + "smithy.api#required": {} + } + }, + "InnerFilter": { + "target": "com.amazonaws.quicksight#InnerFilter", + "traits": { + "smithy.api#documentation": "

The InnerFilter defines the subset of data to be used with the NestedFilter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A NestedFilter filters data with a subset of data that is defined by the nested inner filter.

" + } + }, + "com.amazonaws.quicksight#NetworkInterface": { + "type": "structure", + "members": { + "SubnetId": { + "target": "com.amazonaws.quicksight#SubnetId", + "traits": { + "smithy.api#documentation": "

The subnet ID associated with the network interface.

" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The availability zone that the network interface resides in.

" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An error message.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#NetworkInterfaceStatus", + "traits": { + "smithy.api#documentation": "

The status of the network interface.

" + } + }, + "NetworkInterfaceId": { + "target": "com.amazonaws.quicksight#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "

The network interface ID.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure that contains information about a network interface.

" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + }, + "smithy.api#pattern": "^eni-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#NetworkInterface" + } + }, + "com.amazonaws.quicksight#NetworkInterfaceStatus": { + "type": "enum", + "members": { + "CREATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATING" + } + }, + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATING" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETING" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETION_SCHEDULED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_SCHEDULED" + } + }, + "ATTACHMENT_FAILED_ROLLBACK_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ATTACHMENT_FAILED_ROLLBACK_FAILED" + } + } + } + }, + "com.amazonaws.quicksight#NewDefaultValues": { + "type": "structure", + "members": { + "StringStaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given string parameter.

" + } + }, + "DecimalStaticValues": { + "target": "com.amazonaws.quicksight#DecimalDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given decimal parameter.

" + } + }, + "DateTimeStaticValues": { + "target": "com.amazonaws.quicksight#DateTimeDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given date time parameter.

" + } + }, + "IntegerStaticValues": { + "target": "com.amazonaws.quicksight#IntegerDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given integer parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that overrides the existing default values for a dataset parameter that is inherited from another dataset.

" + } + }, + "com.amazonaws.quicksight#NonEmptyString": { + "type": "string", + "traits": { + "smithy.api#pattern": "\\S" + } + }, + "com.amazonaws.quicksight#NonRepeatingVisualsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#NullFilterOption": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + }, + "NON_NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NON_NULLS_ONLY" + } + }, + "NULLS_ONLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULLS_ONLY" + } + } + } + }, + "com.amazonaws.quicksight#NullString": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#NullValueFormatConfiguration": { + "type": "structure", + "members": { + "NullString": { + "target": "com.amazonaws.quicksight#NullString", + "traits": { + "smithy.api#documentation": "

Determines the null string of null values.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "com.amazonaws.quicksight#NullableBoolean": { + "type": "boolean" + }, + "com.amazonaws.quicksight#NumberDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the number format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the number format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NumberScale": { + "target": "com.amazonaws.quicksight#NumberScale", + "traits": { + "smithy.api#documentation": "

Determines the number scale value of the number format.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the number display format configuration.

" + } + }, + "com.amazonaws.quicksight#NumberFormatConfiguration": { + "type": "structure", + "members": { + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for number fields.

" + } + }, + "com.amazonaws.quicksight#NumberScale": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "THOUSANDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THOUSANDS" + } + }, + "MILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLIONS" + } + }, + "BILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BILLIONS" + } + }, + "TRILLIONS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TRILLIONS" + } + } + } + }, + "com.amazonaws.quicksight#NumericAxisOptions": { + "type": "structure", + "members": { + "Scale": { + "target": "com.amazonaws.quicksight#AxisScale", + "traits": { + "smithy.api#documentation": "

The scale setup of a numeric axis.

" + } + }, + "Range": { + "target": "com.amazonaws.quicksight#AxisDisplayRange", + "traits": { + "smithy.api#documentation": "

The range setup of a numeric axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for an axis with a numeric field.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The value of the double input numeric drill down filter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The numeric equality type drill down filter.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The input value.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "MatchOperator": { + "target": "com.amazonaws.quicksight#NumericEqualityMatchOperator", + "traits": { + "smithy.api#documentation": "

The match operator that is used to determine if a filter should be applied.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the filter.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A NumericEqualityFilter filters values that are equal to the specified value.

" + } + }, + "com.amazonaws.quicksight#NumericEqualityMatchOperator": { + "type": "enum", + "members": { + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "DOES_NOT_EQUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOES_NOT_EQUAL" + } + } + } + }, + "com.amazonaws.quicksight#NumericFilterSelectAllOptions": { + "type": "enum", + "members": { + "FILTER_ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FILTER_ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#NumericFormatConfiguration": { + "type": "structure", + "members": { + "NumberDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the number display format configuration.

" + } + }, + "CurrencyDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#CurrencyDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the currency display format configuration.

" + } + }, + "PercentageDisplayFormatConfiguration": { + "target": "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the numeric format configuration.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#NumericRangeFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeMinimum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" + } + }, + "IncludeMaximum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" + } + }, + "RangeMinimum": { + "target": "com.amazonaws.quicksight#NumericRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

" + } + }, + "RangeMaximum": { + "target": "com.amazonaws.quicksight#NumericRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

" + } + }, + "SelectAllOptions": { + "target": "com.amazonaws.quicksight#NumericFilterSelectAllOptions", + "traits": { + "smithy.api#documentation": "

Select all of the values. Null is not the assigned value of select all.

\n " + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the filter.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A NumericRangeFilter filters values that are within the value range.

" + } + }, + "com.amazonaws.quicksight#NumericRangeFilterValue": { + "type": "structure", + "members": { + "StaticValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The static value of the numeric range filter.

" + } + }, + "Parameter": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter that is used in the numeric range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value input pf the numeric range filter.

" + } + }, + "com.amazonaws.quicksight#NumericSeparatorConfiguration": { + "type": "structure", + "members": { + "DecimalSeparator": { + "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the decimal separator.

" + } + }, + "ThousandsSeparator": { + "target": "com.amazonaws.quicksight#ThousandSeparatorOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "com.amazonaws.quicksight#NumericSeparatorSymbol": { + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMA" + } + }, + "DOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT" + } + }, + "SPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SPACE" + } + } + } + }, + "com.amazonaws.quicksight#NumericalAggregationFunction": { + "type": "structure", + "members": { + "SimpleNumericalAggregation": { + "target": "com.amazonaws.quicksight#SimpleNumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

Built-in aggregation functions for numerical values.

\n " + } + }, + "PercentileAggregation": { + "target": "com.amazonaws.quicksight#PercentileAggregation", + "traits": { + "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregation for numerical values.

" + } + }, + "com.amazonaws.quicksight#NumericalDimensionField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the NumericalDimensionField.

", + "smithy.api#required": {} + } + }, + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The custom hierarchy ID.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The dimension type field with numerical type columns.

" + } + }, + "com.amazonaws.quicksight#NumericalMeasureField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the NumericalMeasureField.

", + "smithy.api#required": {} + } + }, + "AggregationFunction": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function of the measure field.

" + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumberFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The measure type field with numerical type columns.

" + } + }, + "com.amazonaws.quicksight#OnClause": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#OperandList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Identifier" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 25 + } + } + }, + "com.amazonaws.quicksight#OptionalPort": { + "type": "integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 65535 + } + } + }, + "com.amazonaws.quicksight#OracleParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

An Oracle host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

The database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Oracle.

" + } + }, + "com.amazonaws.quicksight#OtherCategories": { + "type": "enum", + "members": { + "INCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INCLUDE" + } + }, + "EXCLUDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCLUDE" + } + } + } + }, + "com.amazonaws.quicksight#OutputColumn": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The display name of the column..

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#ColumnDescriptiveText", + "traits": { + "smithy.api#documentation": "

A description for a column.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ColumnDataType", + "traits": { + "smithy.api#documentation": "

The data type of the column.

" + } + }, + "SubType": { + "target": "com.amazonaws.quicksight#ColumnDataSubType", + "traits": { + "smithy.api#documentation": "

The sub data type of the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Output column.

" + } + }, + "com.amazonaws.quicksight#OutputColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#OutputColumn" + } + }, + "com.amazonaws.quicksight#OverrideDatasetParameterOperation": { + "type": "structure", + "members": { + "ParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter to be overridden with different values.

", + "smithy.api#required": {} + } + }, + "NewParameterName": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The new name for the parameter.

" + } + }, + "NewDefaultValues": { + "target": "com.amazonaws.quicksight#NewDefaultValues", + "traits": { + "smithy.api#documentation": "

The new default values for the parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that overrides the dataset parameter values that are defined in another dataset.

" + } + }, + "com.amazonaws.quicksight#PageNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.quicksight#PaginationConfiguration": { + "type": "structure", + "members": { + "PageSize": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Indicates how many items render in one page.

", + "smithy.api#required": {} + } + }, + "PageNumber": { + "target": "com.amazonaws.quicksight#PageNumber", + "traits": { + "smithy.api#documentation": "

Indicates the page number.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The pagination configuration for a table visual or boxplot.

" + } + }, + "com.amazonaws.quicksight#PanelBorderStyle": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + } + } + }, + "com.amazonaws.quicksight#PanelConfiguration": { + "type": "structure", + "members": { + "Title": { + "target": "com.amazonaws.quicksight#PanelTitleOptions", + "traits": { + "smithy.api#documentation": "

Configures the title display within each small multiples panel.

" + } + }, + "BorderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not each panel displays a border.

" + } + }, + "BorderThickness": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Sets the line thickness of panel borders.

" + } + }, + "BorderStyle": { + "target": "com.amazonaws.quicksight#PanelBorderStyle", + "traits": { + "smithy.api#documentation": "

Sets the line style of panel borders.

" + } + }, + "BorderColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

Sets the line color of panel borders.

" + } + }, + "GutterVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not negative space between sibling panels is rendered.

" + } + }, + "GutterSpacing": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

Sets the total amount of negative space to display between sibling panels.

" + } + }, + "BackgroundVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not a background for each small multiples panel is rendered.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColorWithTransparency", + "traits": { + "smithy.api#documentation": "

Sets the background color for each panel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A collection of options that configure how each panel displays in a small multiples chart.

" + } + }, + "com.amazonaws.quicksight#PanelTitleOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not panel titles are displayed.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration" + }, + "HorizontalTextAlignment": { + "target": "com.amazonaws.quicksight#HorizontalTextAlignment", + "traits": { + "smithy.api#documentation": "

Sets the horizontal text alignment of the title within each panel.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the title styles for each small multiples\n panel.

" + } + }, + "com.amazonaws.quicksight#PaperOrientation": { + "type": "enum", + "members": { + "PORTRAIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PORTRAIT" + } + }, + "LANDSCAPE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LANDSCAPE" + } + } + } + }, + "com.amazonaws.quicksight#PaperSize": { + "type": "enum", + "members": { + "US_LETTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_LETTER" + } + }, + "US_LEGAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_LEGAL" + } + }, + "US_TABLOID_LEDGER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "US_TABLOID_LEDGER" + } + }, + "A0": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A0" + } + }, + "A1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A1" + } + }, + "A2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A2" + } + }, + "A3": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A3" + } + }, + "A4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A4" + } + }, + "A5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "A5" + } + }, + "JIS_B4": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIS_B4" + } + }, + "JIS_B5": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "JIS_B5" + } + } + } + }, + "com.amazonaws.quicksight#ParameterControl": { + "type": "structure", + "members": { + "DateTimePicker": { + "target": "com.amazonaws.quicksight#ParameterDateTimePickerControl", + "traits": { + "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" + } + }, + "List": { + "target": "com.amazonaws.quicksight#ParameterListControl", + "traits": { + "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" + } + }, + "Dropdown": { + "target": "com.amazonaws.quicksight#ParameterDropDownControl", + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "TextField": { + "target": "com.amazonaws.quicksight#ParameterTextFieldControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "TextArea": { + "target": "com.amazonaws.quicksight#ParameterTextAreaControl", + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "Slider": { + "target": "com.amazonaws.quicksight#ParameterSliderControl", + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The control of a parameter that users can interact with in a dashboard or an analysis.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ParameterControlList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ParameterControl" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ParameterDateTimePickerControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the ParameterDateTimePickerControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DateTimePickerControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control from a date parameter that specifies date and time.

" + } + }, + "com.amazonaws.quicksight#ParameterDeclaration": { + "type": "structure", + "members": { + "StringParameterDeclaration": { + "target": "com.amazonaws.quicksight#StringParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the String data type.

" + } + }, + "DecimalParameterDeclaration": { + "target": "com.amazonaws.quicksight#DecimalParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Decimal data type.

" + } + }, + "IntegerParameterDeclaration": { + "target": "com.amazonaws.quicksight#IntegerParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the Integer data type.

" + } + }, + "DateTimeParameterDeclaration": { + "target": "com.amazonaws.quicksight#DateTimeParameterDeclaration", + "traits": { + "smithy.api#documentation": "

A parameter declaration for the DateTime data type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The declaration definition of a parameter.

\n

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ParameterDeclarationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ParameterDeclaration" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ParameterDropDownControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterDropDownControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#DropDownControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type parameter name of the ParameterDropDownControl.

" + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#ParameterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a dropdown list with buttons that are used to select a single value.

" + } + }, + "com.amazonaws.quicksight#ParameterListControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterListControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#ListControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#SheetControlListType", + "traits": { + "smithy.api#documentation": "

The type of ParameterListControl.

" + } + }, + "SelectableValues": { + "target": "com.amazonaws.quicksight#ParameterSelectableValues", + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "CascadingControlConfiguration": { + "target": "com.amazonaws.quicksight#CascadingControlConfiguration", + "traits": { + "smithy.api#documentation": "

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.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

" + } + }, + "com.amazonaws.quicksight#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[a-zA-Z0-9]+$" + } + }, + "com.amazonaws.quicksight#ParameterSelectableValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#ParameterSelectableValues": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#ParameterSelectableValueList", + "traits": { + "smithy.api#documentation": "

The values that are used in ParameterSelectableValues.

" + } + }, + "LinkToDataSetColumn": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column identifier that fetches values from the data set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of selectable values that are used in a control.

" + } + }, + "com.amazonaws.quicksight#ParameterSliderControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterSliderControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#SliderControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "MaximumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The larger value that is displayed at the right of the slider.

", + "smithy.api#required": {} + } + }, + "MinimumValue": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The smaller value that is displayed at the left of the slider.

", + "smithy.api#required": {} + } + }, + "StepSize": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The number of increments that the slider bar is divided into.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.

" + } + }, + "com.amazonaws.quicksight#ParameterTextAreaControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterTextAreaControl.

", + "smithy.api#required": {} + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#TextAreaControlDelimiter", + "traits": { + "smithy.api#documentation": "

The delimiter that is used to separate the lines in text.

" + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextAreaControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter multiple entries.

" + } + }, + "com.amazonaws.quicksight#ParameterTextFieldControl": { + "type": "structure", + "members": { + "ParameterControlId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetControlTitle", + "traits": { + "smithy.api#documentation": "

The title of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "SourceParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The source parameter name of the ParameterTextFieldControl.

", + "smithy.api#required": {} + } + }, + "DisplayOptions": { + "target": "com.amazonaws.quicksight#TextFieldControlDisplayOptions", + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display a text box that is used to enter a single entry.

" + } + }, + "com.amazonaws.quicksight#ParameterValueType": { + "type": "enum", + "members": { + "MULTI_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_VALUED" + } + }, + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + } + } + }, + "com.amazonaws.quicksight#Parameters": { + "type": "structure", + "members": { + "StringParameters": { + "target": "com.amazonaws.quicksight#StringParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of string.

" + } + }, + "IntegerParameters": { + "target": "com.amazonaws.quicksight#IntegerParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of integer.

" + } + }, + "DecimalParameters": { + "target": "com.amazonaws.quicksight#DecimalParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of decimal.

" + } + }, + "DateTimeParameters": { + "target": "com.amazonaws.quicksight#DateTimeParameterList", + "traits": { + "smithy.api#documentation": "

The parameters that have a data type of date-time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A list of Amazon QuickSight parameters and the list's override values.

" + } + }, + "com.amazonaws.quicksight#Password": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#Path": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Arn" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PercentNumber": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PercentVisibleRange": { + "type": "structure", + "members": { + "From": { + "target": "com.amazonaws.quicksight#PercentNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower bound of the range.

" + } + }, + "To": { + "target": "com.amazonaws.quicksight#PercentNumber", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The top bound of the range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The percent range in the visible range.

" + } + }, + "com.amazonaws.quicksight#PercentageDisplayFormatConfiguration": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.quicksight#Prefix", + "traits": { + "smithy.api#documentation": "

Determines the prefix value of the percentage format.

" + } + }, + "Suffix": { + "target": "com.amazonaws.quicksight#Suffix", + "traits": { + "smithy.api#documentation": "

Determines the suffix value of the percentage format.

" + } + }, + "SeparatorConfiguration": { + "target": "com.amazonaws.quicksight#NumericSeparatorConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the numeric separator configuration.

" + } + }, + "DecimalPlacesConfiguration": { + "target": "com.amazonaws.quicksight#DecimalPlacesConfiguration", + "traits": { + "smithy.api#documentation": "

The option that determines the decimal places configuration.

" + } + }, + "NegativeValueConfiguration": { + "target": "com.amazonaws.quicksight#NegativeValueConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the negative value configuration.

" + } + }, + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the percentage display format configuration.

" + } + }, + "com.amazonaws.quicksight#PercentileAggregation": { + "type": "structure", + "members": { + "PercentileValue": { + "target": "com.amazonaws.quicksight#PercentileValue", + "traits": { + "smithy.api#documentation": "

The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation based on the percentile of values in a dimension or measure.

" + } + }, + "com.amazonaws.quicksight#PercentileValue": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PeriodOverPeriodComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The period over period computation configuration.

" + } + }, + "com.amazonaws.quicksight#PeriodToDateComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "PeriodTimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity setup of period to date computation. Choose from the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The period to date computation configuration.

" + } + }, + "com.amazonaws.quicksight#PeriodsBackward": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#PeriodsForward": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#PhysicalTable": { + "type": "union", + "members": { + "RelationalTable": { + "target": "com.amazonaws.quicksight#RelationalTable", + "traits": { + "smithy.api#documentation": "

A physical table type for relational data sources.

" + } + }, + "CustomSql": { + "target": "com.amazonaws.quicksight#CustomSql", + "traits": { + "smithy.api#documentation": "

A physical table type built from the results of the custom SQL query.

" + } + }, + "S3Source": { + "target": "com.amazonaws.quicksight#S3Source", + "traits": { + "smithy.api#documentation": "

A physical table type for as S3 data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A view of a data source that contains information about the shape of the data in the\n underlying source. This is a variant type structure. For this structure to be valid,\n only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#PhysicalTableId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[0-9a-zA-Z-]*$" + } + }, + "com.amazonaws.quicksight#PhysicalTableMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#PhysicalTableId" + }, + "value": { + "target": "com.amazonaws.quicksight#PhysicalTable" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#PieChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category (group/color) field wells of a pie chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a pie chart. Values are aggregated based on categories.

" + } + }, + "SmallMultiples": { + "target": "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The small multiples field well of a pie chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PieChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PieChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a pie chart.

" + } + }, + "DonutOptions": { + "target": "com.amazonaws.quicksight#DonutOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.

" + } + }, + "SmallMultiplesOptions": { + "target": "com.amazonaws.quicksight#SmallMultiplesOptions", + "traits": { + "smithy.api#documentation": "

The small multiples setup for the visual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options of the group/color that is displayed in a pie chart.

" + } + }, + "ValueLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options for the value that is displayed in a pie chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "ContributionAnalysisDefaults": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDefaultList", + "traits": { + "smithy.api#documentation": "

The contribution analysis (anomaly configuration) setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartFieldWells": { + "type": "structure", + "members": { + "PieChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#PieChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a pie chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#PieChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of categories that are displayed in a pie chart.

" + } + }, + "SmallMultiplesSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the small multiples field.

" + } + }, + "SmallMultiplesLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of small multiples panels that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a pie chart.

" + } + }, + "com.amazonaws.quicksight#PieChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PieChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a pie chart.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pie or donut chart.

\n

The PieChartVisual structure describes a visual that is a member of the pie chart family.

\n

The following charts can be described by using this structure:

\n \n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

\n

For more information, see Using donut charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#PivotFieldSortOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for the field sort options.

", + "smithy.api#required": {} + } + }, + "SortBy": { + "target": "com.amazonaws.quicksight#PivotTableSortBy", + "traits": { + "smithy.api#documentation": "

The sort by field for the field sort options.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" + } + }, + "com.amazonaws.quicksight#PivotFieldSortOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotFieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#PivotMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.quicksight#PivotTableAggregatedFieldWells": { + "type": "structure", + "members": { + "Rows": { + "target": "com.amazonaws.quicksight#PivotTableDimensionList", + "traits": { + "smithy.api#documentation": "

The rows field well for a pivot table. Values are grouped by rows fields.

" + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#PivotTableDimensionList", + "traits": { + "smithy.api#documentation": "

The columns field well for a pivot table. Values are grouped by columns fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#PivotMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on rows and columns fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for the pivot table.

" + } + }, + "com.amazonaws.quicksight#PivotTableCellConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", + "smithy.api#required": {} + } + }, + "TextFormat": { + "target": "com.amazonaws.quicksight#TextConditionalFormat", + "traits": { + "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" + } + }, + "Scope": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope", + "traits": { + "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" + } + }, + "Scopes": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList", + "traits": { + "smithy.api#documentation": "

A list of cell scopes for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingOption": { + "type": "structure", + "members": { + "Cell": { + "target": "com.amazonaws.quicksight#PivotTableCellConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScope": { + "type": "structure", + "members": { + "Role": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole", + "traits": { + "smithy.api#documentation": "

The role (field, field total, grand total) of the cell for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The scope of the cell for conditional formatting.

" + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormattingScope" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#PivotTableConditionalFormattingScopeRole": { + "type": "enum", + "members": { + "FIELD": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD" + } + }, + "FIELD_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIELD_TOTAL" + } + }, + "GRAND_TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRAND_TOTAL" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#PivotTableFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#PivotTableSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" + } + }, + "TableOptions": { + "target": "com.amazonaws.quicksight#PivotTableOptions", + "traits": { + "smithy.api#documentation": "

The table options for a pivot table visual.

" + } + }, + "TotalOptions": { + "target": "com.amazonaws.quicksight#PivotTableTotalOptions", + "traits": { + "smithy.api#documentation": "

The total options for a pivot table visual.

" + } + }, + "FieldOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldOptions", + "traits": { + "smithy.api#documentation": "

The field options for a pivot table visual.

" + } + }, + "PaginatedReportOptions": { + "target": "com.amazonaws.quicksight#PivotTablePaginatedReportOptions", + "traits": { + "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableDataPathOption": { + "type": "structure", + "members": { + "DataPathList": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The list of data path values for the data path options.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width of the data path option.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The data path options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableDataPathOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableDataPathOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableDataPathType": { + "type": "enum", + "members": { + "HIERARCHY_ROWS_LAYOUT_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY_ROWS_LAYOUT_COLUMN" + } + }, + "MULTIPLE_ROW_METRICS_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTIPLE_ROW_METRICS_COLUMN" + } + }, + "EMPTY_COLUMN_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPTY_COLUMN_HEADER" + } + }, + "COUNT_METRIC_COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT_METRIC_COLUMN" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableDimensionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 40 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseState": { + "type": "enum", + "members": { + "COLLAPSED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLLAPSED" + } + }, + "EXPANDED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXPANDED" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget", + "traits": { + "smithy.api#documentation": "

A tagged-union object that sets the collapse state.

", + "smithy.api#required": {} + } + }, + "State": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseState", + "traits": { + "smithy.api#documentation": "

The state of the field target of a pivot table. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOption" + } + }, + "com.amazonaws.quicksight#PivotTableFieldCollapseStateTarget": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The field ID of the pivot table that the collapse state needs to be set to.

" + } + }, + "FieldDataPathValues": { + "target": "com.amazonaws.quicksight#DataPathValueList", + "traits": { + "smithy.api#documentation": "

The data path of the pivot table's header. Used to set the collapse state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The target of a pivot table field collapse state.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the pivot table field.

", + "smithy.api#required": {} + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#CustomLabel", + "traits": { + "smithy.api#documentation": "

The custom label of the pivot table field.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the pivot table field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The selected field options for the pivot table field options.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldOptions": { + "type": "structure", + "members": { + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldOptionList", + "traits": { + "smithy.api#documentation": "

The selected field options for the pivot table field options.

" + } + }, + "DataPathOptions": { + "target": "com.amazonaws.quicksight#PivotTableDataPathOptionList", + "traits": { + "smithy.api#documentation": "

The data path options for the pivot table field options.

" + } + }, + "CollapseStateOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldCollapseStateOptionList", + "traits": { + "smithy.api#documentation": "

The collapse state options for the pivot table field options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the subtotal options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The optional configuration of subtotals cells.

" + } + }, + "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#PivotTableFieldWells": { + "type": "structure", + "members": { + "PivotTableAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#PivotTableAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for the pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells for a pivot table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#PivotTableMetricPlacement": { + "type": "enum", + "members": { + "ROW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ROW" + } + }, + "COLUMN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COLUMN" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableOptions": { + "type": "structure", + "members": { + "MetricPlacement": { + "target": "com.amazonaws.quicksight#PivotTableMetricPlacement", + "traits": { + "smithy.api#documentation": "

The metric placement (row, column) options.

" + } + }, + "SingleMetricVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the single metric options.

" + } + }, + "ColumnNamesVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the column names.

" + } + }, + "ToggleButtonsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the pivot table.

" + } + }, + "ColumnHeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of the column header.

" + } + }, + "RowHeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of the row headers.

" + } + }, + "CellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of cells.

" + } + }, + "RowFieldNamesStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of row field names.

" + } + }, + "RowAlternateColorOptions": { + "target": "com.amazonaws.quicksight#RowAlternateColorOptions", + "traits": { + "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors).

" + } + }, + "CollapsedRowDimensionsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.

" + } + }, + "RowsLayout": { + "target": "com.amazonaws.quicksight#PivotTableRowsLayout", + "traits": { + "smithy.api#documentation": "

The layout for the row dimension headers of a pivot table. Choose one of the following options.

\n " + } + }, + "RowsLabelOptions": { + "target": "com.amazonaws.quicksight#PivotTableRowsLabelOptions", + "traits": { + "smithy.api#documentation": "

The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" + } + }, + "DefaultCellWidth": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The default cell width of the pivot table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTablePaginatedReportOptions": { + "type": "structure", + "members": { + "VerticalOverflowVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the printing table overflow across pages.

" + } + }, + "OverflowColumnHeaderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the repeating header rows on each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The paginated report options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableRowsLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the rows label.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#PivotTableRowsLabelText", + "traits": { + "smithy.api#documentation": "

The custom label string for the rows label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the label thta is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.

" + } + }, + "com.amazonaws.quicksight#PivotTableRowsLabelText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#PivotTableRowsLayout": { + "type": "enum", + "members": { + "TABULAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TABULAR" + } + }, + "HIERARCHY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIERARCHY" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableSortBy": { + "type": "structure", + "members": { + "Field": { + "target": "com.amazonaws.quicksight#FieldSort", + "traits": { + "smithy.api#documentation": "

The field sort (field id, direction) for the pivot table sort by options.

" + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnSort", + "traits": { + "smithy.api#documentation": "

The column sort (field id, direction) for the pivot table sort by options.

" + } + }, + "DataPath": { + "target": "com.amazonaws.quicksight#DataPathSort", + "traits": { + "smithy.api#documentation": "

The data path sort (data path value, direction) for the pivot table sort by options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort by field for the field sort options.

" + } + }, + "com.amazonaws.quicksight#PivotTableSortConfiguration": { + "type": "structure", + "members": { + "FieldSortOptions": { + "target": "com.amazonaws.quicksight#PivotFieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The field sort options for a pivot table sort configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PivotTableSubtotalLevel": { + "type": "enum", + "members": { + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + } + } + }, + "com.amazonaws.quicksight#PivotTableTotalOptions": { + "type": "structure", + "members": { + "RowSubtotalOptions": { + "target": "com.amazonaws.quicksight#SubtotalOptions", + "traits": { + "smithy.api#documentation": "

The row subtotal options.

" + } + }, + "ColumnSubtotalOptions": { + "target": "com.amazonaws.quicksight#SubtotalOptions", + "traits": { + "smithy.api#documentation": "

The column subtotal options.

" + } + }, + "RowTotalOptions": { + "target": "com.amazonaws.quicksight#PivotTotalOptions", + "traits": { + "smithy.api#documentation": "

The row total options.

" + } + }, + "ColumnTotalOptions": { + "target": "com.amazonaws.quicksight#PivotTotalOptions", + "traits": { + "smithy.api#documentation": "

The column total options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total options for a pivot table visual.

" + } + }, + "com.amazonaws.quicksight#PivotTableVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#PivotTableConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#PivotTableConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#PivotTotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the total cells.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#TableTotalsPlacement", + "traits": { + "smithy.api#documentation": "

The placement (start, end) for the total cells.

" + } + }, + "ScrollStatus": { + "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", + "traits": { + "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the total cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the total cells.

" + } + }, + "ValueCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the totals of value cells.

" + } + }, + "MetricHeaderCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the total of header cells.

" + } + }, + "TotalAggregationOptions": { + "target": "com.amazonaws.quicksight#TotalAggregationOptionList", + "traits": { + "smithy.api#documentation": "

The total aggregation options for each value field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The optional configuration of totals cells in a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#PixelLength": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit in px" + } + }, + "com.amazonaws.quicksight#Port": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 65535 + } + } + }, + "com.amazonaws.quicksight#PositiveInteger": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#PositiveLong": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#PostgreSqlParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for PostgreSQL.

" + } + }, + "com.amazonaws.quicksight#PreconditionNotMetException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more preconditions aren't met.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#PredefinedHierarchy": { + "type": "structure", + "members": { + "HierarchyId": { + "target": "com.amazonaws.quicksight#HierarchyId", + "traits": { + "smithy.api#documentation": "

The hierarchy ID of the predefined hierarchy.

", + "smithy.api#required": {} + } + }, + "Columns": { + "target": "com.amazonaws.quicksight#PredefinedHierarchyColumnList", + "traits": { + "smithy.api#documentation": "

The list of columns that define the predefined hierarchy.

", + "smithy.api#required": {} + } + }, + "DrillDownFilters": { + "target": "com.amazonaws.quicksight#DrillDownFilterList", + "traits": { + "smithy.api#documentation": "

The option that determines the drill down filters for the predefined hierarchy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "com.amazonaws.quicksight#PredefinedHierarchyColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnIdentifier" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#PredictionInterval": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 50, + "max": 95 + } + } + }, + "com.amazonaws.quicksight#Prefix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#PrestoParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

Catalog.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Presto.

" + } + }, + "com.amazonaws.quicksight#PrimaryValueDisplayType": { + "type": "enum", + "members": { + "HIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIDDEN" + } + }, + "COMPARISON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPARISON" + } + }, + "ACTUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACTUAL" + } + } + } + }, + "com.amazonaws.quicksight#Principal": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#PrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ProgressBarOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the progress bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the progress bar of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#ProjectId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#ProjectOperation": { + "type": "structure", + "members": { + "ProjectedColumns": { + "target": "com.amazonaws.quicksight#ProjectedColumnList", + "traits": { + "smithy.api#documentation": "

Projected columns.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that projects columns. Operations that come after a projection\n can only refer to projected columns.

" + } + }, + "com.amazonaws.quicksight#ProjectedColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#PropertyRole": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "ID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ID" + } + } + } + }, + "com.amazonaws.quicksight#PropertyUsage": { + "type": "enum", + "members": { + "INHERIT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INHERIT" + } + }, + "DIMENSION": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DIMENSION" + } + }, + "MEASURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEASURE" + } + } + } + }, + "com.amazonaws.quicksight#PurchaseMode": { + "type": "enum", + "members": { + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + }, + "AUTO_PURCHASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO_PURCHASE" + } + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshProperties": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates or updates the dataset refresh properties for the dataset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-properties", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetRefreshProperties": { + "target": "com.amazonaws.quicksight#DataSetRefreshProperties", + "traits": { + "smithy.api#documentation": "

The dataset refresh properties.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#PutDataSetRefreshPropertiesResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Query": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#QueryExecutionMode": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "MANUAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MANUAL" + } + } + } + }, + "com.amazonaws.quicksight#QueryExecutionOptions": { + "type": "structure", + "members": { + "QueryExecutionMode": { + "target": "com.amazonaws.quicksight#QueryExecutionMode", + "traits": { + "smithy.api#documentation": "

A structure that describes the query execution mode.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the query execution options.

" + } + }, + "com.amazonaws.quicksight#QueueInfo": { + "type": "structure", + "members": { + "WaitingOnIngestion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the queued ingestion.

", + "smithy.api#required": {} + } + }, + "QueuedIngestion": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a queued dataset SPICE ingestion.

" + } + }, + "com.amazonaws.quicksight#QuickSightUserNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The user with the provided name isn't found. This error can happen in any operation\n\t\t\tthat requires finding a user based on a provided user name, such as\n\t\t\t\tDeleteUser, DescribeUser, and so on.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.quicksight#QuickSight_20180401": { + "type": "service", + "version": "2018-04-01", + "operations": [ + { + "target": "com.amazonaws.quicksight#BatchCreateTopicReviewedAnswer" }, - "com.amazonaws.quicksight#UpdateFolderResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" - } - }, - "FolderId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the folder.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#BatchDeleteTopicReviewedAnswer" }, - "com.amazonaws.quicksight#UpdateGroup": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateGroupRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateGroupResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Changes a group description.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CancelIngestion" }, - "com.amazonaws.quicksight#UpdateGroupRequest": { - "type": "structure", - "members": { - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "

The name of the group that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "

The description for the group that you want to update.

" - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the group that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateAccountCustomization" }, - "com.amazonaws.quicksight#UpdateGroupResponse": { - "type": "structure", - "members": { - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "

The name of the group.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateAccountSubscription" }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignment": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an existing IAM policy assignment. This operation updates only\n\t\t\tthe optional parameter or parameters that are specified in the request. This overwrites\n\t\t\tall of the users included in Identities.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateAnalysis" }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IAM policy\n\t\t\tassignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname must be unique within the\n\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace of the assignment.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateDashboard" }, - "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { - "type": "structure", - "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "

The name of the assignment or rule.

" - } - }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the assignment.

" - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateDataSet" }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfig": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateDataSource" }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Service": { - "target": "com.amazonaws.quicksight#ServiceType", - "traits": { - "smithy.api#documentation": "

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AuthorizedTargets": { - "target": "com.amazonaws.quicksight#AuthorizedTargetsList", - "traits": { - "smithy.api#documentation": "

Specifies a list of application ARNs that represent the authorized targets for a service.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateFolder" }, - "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateFolderMembership" }, - "com.amazonaws.quicksight#UpdateIpRestriction": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateIpRestrictionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateIpRestrictionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/ip-restriction", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateGroup" }, - "com.amazonaws.quicksight#UpdateIpRestrictionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "IpRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map that describes the updated IP rules with CIDR ranges and descriptions.

" - } - }, - "VpcIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

" - } - }, - "VpcEndpointIdRestrictionRuleMap": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", - "traits": { - "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

" - } - }, - "Enabled": { - "target": "com.amazonaws.quicksight#NullableBoolean", - "traits": { - "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateGroupMembership" }, - "com.amazonaws.quicksight#UpdateIpRestrictionResponse": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateIAMPolicyAssignment" }, - "com.amazonaws.quicksight#UpdateKeyRegistration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateKeyRegistrationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateKeyRegistrationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a customer managed key in a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/key-registration", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateIngestion" }, - "com.amazonaws.quicksight#UpdateKeyRegistrationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "KeyRegistration": { - "target": "com.amazonaws.quicksight#KeyRegistration", - "traits": { - "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateNamespace" }, - "com.amazonaws.quicksight#UpdateKeyRegistrationResponse": { - "type": "structure", - "members": { - "FailedKeyRegistration": { - "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntries", - "traits": { - "smithy.api#documentation": "

A list of all customer managed key registrations that failed to update.

" - } - }, - "SuccessfulKeyRegistration": { - "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries", - "traits": { - "smithy.api#documentation": "

A list of all customer managed key registrations that were successfully updated.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateRefreshSchedule" }, - "com.amazonaws.quicksight#UpdateLinkPermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } + { + "target": "com.amazonaws.quicksight#CreateRoleMembership" }, - "com.amazonaws.quicksight#UpdatePublicSharingSettings": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" - } - ], - "traits": { - "smithy.api#documentation": "

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an Amazon QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your Amazon QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with Amazon QuickSight, see\n Using Amazon QuickSight with IAM in the Amazon QuickSight\n User Guide.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/public-sharing-settings", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateTemplate" }, - "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PublicSharingEnabled": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateTemplateAlias" }, - "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateTheme" }, - "com.amazonaws.quicksight#UpdateRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a refresh schedule for a dataset.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#CreateThemeAlias" }, - "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { - "type": "structure", - "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Schedule": { - "target": "com.amazonaws.quicksight#RefreshSchedule", - "traits": { - "smithy.api#documentation": "

The refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#CreateTopic" }, - "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "ScheduleId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the refresh schedule.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#CreateTopicRefreshSchedule" }, - "com.amazonaws.quicksight#UpdateResourcePermissionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#ResourcePermission" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 100 - } - } + { + "target": "com.amazonaws.quicksight#CreateVPCConnection" }, - "com.amazonaws.quicksight#UpdateRoleCustomPermission": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the custom permissions that are associated with a role.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DeleteAccountCustomization" + }, + { + "target": "com.amazonaws.quicksight#DeleteAccountSubscription" + }, + { + "target": "com.amazonaws.quicksight#DeleteAnalysis" + }, + { + "target": "com.amazonaws.quicksight#DeleteDashboard" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSet" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSetRefreshProperties" + }, + { + "target": "com.amazonaws.quicksight#DeleteDataSource" + }, + { + "target": "com.amazonaws.quicksight#DeleteFolder" + }, + { + "target": "com.amazonaws.quicksight#DeleteFolderMembership" + }, + { + "target": "com.amazonaws.quicksight#DeleteGroup" + }, + { + "target": "com.amazonaws.quicksight#DeleteGroupMembership" + }, + { + "target": "com.amazonaws.quicksight#DeleteIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#DeleteIdentityPropagationConfig" }, - "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest": { - "type": "structure", - "members": { - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The name of the custom permission that you want to update the role with.

", - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#Role", - "traits": { - "smithy.api#documentation": "

The name of role tht you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace that contains the role that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DeleteNamespace" }, - "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DeleteRefreshSchedule" }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", - "smithy.api#http": { - "method": "POST", - "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DeleteRoleCustomPermission" }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "PurchaseMode": { - "target": "com.amazonaws.quicksight#PurchaseMode", - "traits": { - "smithy.api#documentation": "

Determines how SPICE capacity can be purchased. The following options are available.

\n ", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DeleteRoleMembership" }, - "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse": { - "type": "structure", - "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DeleteTemplate" }, - "com.amazonaws.quicksight#UpdateTemplate": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplateRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplateResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a template from an existing Amazon QuickSight analysis or another template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DeleteTemplateAlias" }, - "com.amazonaws.quicksight#UpdateTemplateAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the template alias of a template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DeleteTheme" }, - "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the template.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DeleteThemeAlias" }, - "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { - "type": "structure", - "members": { - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "

The template alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DeleteTopic" }, - "com.amazonaws.quicksight#UpdateTemplatePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the resource permissions for a template.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DeleteTopicRefreshSchedule" }, - "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be granted on the template.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be revoked from the template.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DeleteUser" }, - "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "TemplateArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DeleteUserByPrincipalId" }, - "com.amazonaws.quicksight#UpdateTemplateRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#TemplateSourceEntity", - "traits": { - "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", - "traits": { - "smithy.api#documentation": "

The name for the template.

" - } - }, - "Definition": { - "target": "com.amazonaws.quicksight#TemplateVersionDefinition", - "traits": { - "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" - } - }, - "ValidationStrategy": { - "target": "com.amazonaws.quicksight#ValidationStrategy", - "traits": { - "smithy.api#documentation": "

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DeleteVPCConnection" }, - "com.amazonaws.quicksight#UpdateTemplateResponse": { - "type": "structure", - "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the template.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the template.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The ARN for the template, including the version information of the first version.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the template.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeAccountCustomization" }, - "com.amazonaws.quicksight#UpdateTheme": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemeRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemeResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a theme.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeAccountSettings" }, - "com.amazonaws.quicksight#UpdateThemeAlias": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an alias of a theme.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeAccountSubscription" }, - "com.amazonaws.quicksight#UpdateThemeAliasRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "

The name of the theme alias that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", - "traits": { - "smithy.api#documentation": "

The version number of the theme that the alias should reference.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeAnalysis" }, - "com.amazonaws.quicksight#UpdateThemeAliasResponse": { - "type": "structure", - "members": { - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "

Information about the theme alias.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeAnalysisDefinition" }, - "com.amazonaws.quicksight#UpdateThemePermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".

\n

Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:

\n ", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeAnalysisPermissions" }, - "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be granted for the theme.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions to be revoked from the theme.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeAssetBundleExportJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeAssetBundleImportJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboard" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardDefinition" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJob" + }, + { + "target": "com.amazonaws.quicksight#DescribeDashboardSnapshotJobResult" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSet" + }, + { + "target": "com.amazonaws.quicksight#DescribeDataSetPermissions" }, - "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resulting list of resource permissions for the theme.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeDataSetRefreshProperties" }, - "com.amazonaws.quicksight#UpdateThemeRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're updating.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "

The name for the theme.

" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.

", - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "

A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.

" - } - }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeDataSource" }, - "com.amazonaws.quicksight#UpdateThemeResponse": { - "type": "structure", - "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID for the theme.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" - } - }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new version of the theme.

" - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "

The creation status of the theme.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeDataSourcePermissions" }, - "com.amazonaws.quicksight#UpdateTopic": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a topic.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeFolder" }, - "com.amazonaws.quicksight#UpdateTopicPermissions": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicPermissionsRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicPermissionsResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates the permissions of a topic.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeFolderPermissions" }, - "com.amazonaws.quicksight#UpdateTopicPermissionsRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to update\n the permissions for.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to grant to the topic.

" - } - }, - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "

The resource permissions that you want to revoke from the topic.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeFolderResolvedPermissions" }, - "com.amazonaws.quicksight#UpdateTopicPermissionsResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "

A list of resource permissions on the topic.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeGroup" }, - "com.amazonaws.quicksight#UpdateTopicRefreshSchedule": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceExistsException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a topic refresh schedule.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeGroupMembership" }, - "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DatasetId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ID of the dataset.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RefreshSchedule": { - "target": "com.amazonaws.quicksight#TopicRefreshSchedule", - "traits": { - "smithy.api#documentation": "

The definition of a refresh schedule.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeIAMPolicyAssignment" }, - "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "TopicArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "DatasetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeIngestion" }, - "com.amazonaws.quicksight#UpdateTopicRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Topic": { - "target": "com.amazonaws.quicksight#TopicDetails", - "traits": { - "smithy.api#documentation": "

The definition of the topic that you want to update.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeIpRestriction" }, - "com.amazonaws.quicksight#UpdateTopicResponse": { - "type": "structure", - "members": { - "TopicId": { - "target": "com.amazonaws.quicksight#TopicId", - "traits": { - "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" - } - }, - "RefreshArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeKeyRegistration" }, - "com.amazonaws.quicksight#UpdateUser": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateUserRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateUserResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#PreconditionNotMetException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ResourceUnavailableException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates an Amazon QuickSight user.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeNamespace" }, - "com.amazonaws.quicksight#UpdateUserRequest": { - "type": "structure", - "members": { - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user name that you want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The email address of the user that you want to update.

", - "smithy.api#required": {} - } - }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", - "smithy.api#required": {} - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" - } - }, - "UnapplyCustomPermissions": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

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.

\n " - } - }, - "CustomFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeRefreshSchedule" }, - "com.amazonaws.quicksight#UpdateUserResponse": { - "type": "structure", - "members": { - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight user.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeRoleCustomPermission" }, - "com.amazonaws.quicksight#UpdateVPCConnection": { - "type": "operation", - "input": { - "target": "com.amazonaws.quicksight#UpdateVPCConnectionRequest" - }, - "output": { - "target": "com.amazonaws.quicksight#UpdateVPCConnectionResponse" - }, - "errors": [ - { - "target": "com.amazonaws.quicksight#AccessDeniedException" - }, - { - "target": "com.amazonaws.quicksight#ConflictException" - }, - { - "target": "com.amazonaws.quicksight#InternalFailureException" - }, - { - "target": "com.amazonaws.quicksight#InvalidParameterValueException" - }, - { - "target": "com.amazonaws.quicksight#LimitExceededException" - }, - { - "target": "com.amazonaws.quicksight#ResourceNotFoundException" - }, - { - "target": "com.amazonaws.quicksight#ThrottlingException" - }, - { - "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" - } - ], - "traits": { - "smithy.api#documentation": "

Updates a VPC connection.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", - "code": 200 - } - } + { + "target": "com.amazonaws.quicksight#DescribeTemplate" }, - "com.amazonaws.quicksight#UpdateVPCConnectionRequest": { - "type": "structure", - "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want to update.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're updating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SubnetIds": { - "target": "com.amazonaws.quicksight#SubnetIdList", - "traits": { - "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", - "smithy.api#required": {} - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#DnsResolverList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#RoleArn", - "traits": { - "smithy.api#documentation": "

An IAM role associated with the VPC connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#input": {} - } + { + "target": "com.amazonaws.quicksight#DescribeTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplateDefinition" + }, + { + "target": "com.amazonaws.quicksight#DescribeTemplatePermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTheme" + }, + { + "target": "com.amazonaws.quicksight#DescribeThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#DescribeThemePermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopic" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#DescribeTopicRefresh" }, - "com.amazonaws.quicksight#UpdateVPCConnectionResponse": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

" - } - }, - "UpdateStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The update status of the VPC connection's last update.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The HTTP status of the request.

", - "smithy.api#httpResponseCode": {} - } - } - }, - "traits": { - "smithy.api#output": {} - } + { + "target": "com.amazonaws.quicksight#DescribeTopicRefreshSchedule" }, - "com.amazonaws.quicksight#UploadSettings": { - "type": "structure", - "members": { - "Format": { - "target": "com.amazonaws.quicksight#FileFormat", - "traits": { - "smithy.api#documentation": "

File format.

" - } - }, - "StartFromRow": { - "target": "com.amazonaws.quicksight#PositiveInteger", - "traits": { - "smithy.api#documentation": "

A row number to start reading data from.

" - } - }, - "ContainsHeader": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": null, - "smithy.api#documentation": "

Whether the file has a header row, or the files each have a header row.

" - } - }, - "TextQualifier": { - "target": "com.amazonaws.quicksight#TextQualifier", - "traits": { - "smithy.api#documentation": "

Text qualifier.

" - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#Delimiter", - "traits": { - "smithy.api#documentation": "

The delimiter between values in the file.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

Information about the format for a source file or files.

" - } + { + "target": "com.amazonaws.quicksight#DescribeUser" }, - "com.amazonaws.quicksight#User": { - "type": "structure", - "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

" - } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" - } - }, - "Email": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The user's email address.

" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n " - } - }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", - "traits": { - "smithy.api#documentation": "

The type of identity authentication used by the user.

" - } - }, - "Active": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#default": false, - "smithy.api#documentation": "

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

" - } - }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The principal ID of the user.

" - } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "

The custom permissions profile associated with this user.

" - } - }, - "ExternalLoginFederationProviderType": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

\n " - } - }, - "ExternalLoginFederationProviderUrl": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The URL of the external login provider.

" - } - }, - "ExternalLoginId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The identity ID for the user in the external login provider.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A registered user of Amazon QuickSight.

" - } + { + "target": "com.amazonaws.quicksight#DescribeVPCConnection" }, - "com.amazonaws.quicksight#UserList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#User" - } + { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForAnonymousUser" }, - "com.amazonaws.quicksight#UserName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1 - }, - "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" - } + { + "target": "com.amazonaws.quicksight#GenerateEmbedUrlForRegisteredUser" }, - "com.amazonaws.quicksight#UserRole": { - "type": "enum", - "members": { - "ADMIN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN" - } - }, - "AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR" - } - }, - "READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER" - } - }, - "RESTRICTED_AUTHOR": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED_AUTHOR" - } - }, - "RESTRICTED_READER": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RESTRICTED_READER" - } - }, - "ADMIN_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ADMIN_PRO" - } - }, - "AUTHOR_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTHOR_PRO" - } - }, - "READER_PRO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "READER_PRO" - } - } - } + { + "target": "com.amazonaws.quicksight#GetDashboardEmbedUrl" }, - "com.amazonaws.quicksight#VPCConnection": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

" - } - }, - "VPCId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.quicksight#NetworkInterfaceList", - "traits": { - "smithy.api#documentation": "

A list of network interfaces.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the\n IAM role associated with the VPC\n connection.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The structure of a VPC connection.

" - } + { + "target": "com.amazonaws.quicksight#GetSessionEmbedUrl" }, - "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus": { - "type": "enum", - "members": { - "AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AVAILABLE" - } - }, - "UNAVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UNAVAILABLE" - } - }, - "PARTIALLY_AVAILABLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PARTIALLY_AVAILABLE" - } - } - } + { + "target": "com.amazonaws.quicksight#ListAnalyses" }, - "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - }, - "smithy.api#pattern": "^[\\w\\-]+$" - } + { + "target": "com.amazonaws.quicksight#ListAssetBundleExportJobs" }, - "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 1000 - } - } + { + "target": "com.amazonaws.quicksight#ListAssetBundleImportJobs" }, - "com.amazonaws.quicksight#VPCConnectionResourceStatus": { - "type": "enum", - "members": { - "CREATION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_IN_PROGRESS" - } - }, - "CREATION_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_SUCCESSFUL" - } - }, - "CREATION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "CREATION_FAILED" - } - }, - "UPDATE_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_IN_PROGRESS" - } - }, - "UPDATE_SUCCESSFUL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_SUCCESSFUL" - } - }, - "UPDATE_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "UPDATE_FAILED" - } - }, - "DELETION_IN_PROGRESS": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_IN_PROGRESS" - } - }, - "DELETION_FAILED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETION_FAILED" - } - }, - "DELETED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DELETED" - } - } - } + { + "target": "com.amazonaws.quicksight#ListDashboards" }, - "com.amazonaws.quicksight#VPCConnectionSummary": { - "type": "structure", - "members": { - "VPCConnectionId": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", - "traits": { - "smithy.api#documentation": "

The ID of the VPC connection that\n you're\n creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" - } - }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", - "traits": { - "smithy.api#documentation": "

The display name for the VPC connection.

" - } - }, - "VPCId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" - } - }, - "SecurityGroupIds": { - "target": "com.amazonaws.quicksight#SecurityGroupIdList", - "traits": { - "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" - } - }, - "DnsResolvers": { - "target": "com.amazonaws.quicksight#StringList", - "traits": { - "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", - "traits": { - "smithy.api#documentation": "

The status of the VPC connection.

" - } - }, - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", - "traits": { - "smithy.api#documentation": "

The availability status of the VPC connection.

" - } - }, - "NetworkInterfaces": { - "target": "com.amazonaws.quicksight#NetworkInterfaceList", - "traits": { - "smithy.api#documentation": "

A list of network interfaces.

" - } - }, - "RoleArn": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

The ARN of the IAM role associated\n with the VPC connection.

" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was created.

" - } - }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The time that the VPC connection was last updated.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The summary metadata that describes a VPC connection.

" - } + { + "target": "com.amazonaws.quicksight#ListDashboardVersions" }, - "com.amazonaws.quicksight#VPCConnectionSummaryList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VPCConnectionSummary" - } + { + "target": "com.amazonaws.quicksight#ListDataSets" }, - "com.amazonaws.quicksight#ValidationStrategy": { - "type": "structure", - "members": { - "Mode": { - "target": "com.amazonaws.quicksight#ValidationStrategyMode", - "traits": { - "smithy.api#documentation": "

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

" - } + { + "target": "com.amazonaws.quicksight#ListDataSources" }, - "com.amazonaws.quicksight#ValidationStrategyMode": { - "type": "enum", - "members": { - "STRICT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "STRICT" - } - }, - "LENIENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LENIENT" - } - } - } + { + "target": "com.amazonaws.quicksight#ListFolderMembers" }, - "com.amazonaws.quicksight#ValueWhenUnsetOption": { - "type": "enum", - "members": { - "RECOMMENDED_VALUE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "RECOMMENDED_VALUE" - } - }, - "NULL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NULL" - } - } - } + { + "target": "com.amazonaws.quicksight#ListFolders" }, - "com.amazonaws.quicksight#VersionDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 512 - } - } + { + "target": "com.amazonaws.quicksight#ListGroupMemberships" }, - "com.amazonaws.quicksight#VersionNumber": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1 - } - } + { + "target": "com.amazonaws.quicksight#ListGroups" }, - "com.amazonaws.quicksight#VerticalTextAlignment": { - "type": "enum", - "members": { - "TOP": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "TOP" - } - }, - "MIDDLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MIDDLE" - } - }, - "BOTTOM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "BOTTOM" - } - }, - "AUTO": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "AUTO" - } - } - } + { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignments" }, - "com.amazonaws.quicksight#Visibility": { - "type": "enum", - "members": { - "HIDDEN": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HIDDEN" - } - }, - "VISIBLE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "VISIBLE" - } - } - } + { + "target": "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUser" }, - "com.amazonaws.quicksight#VisiblePanelColumns": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } + { + "target": "com.amazonaws.quicksight#ListIdentityPropagationConfigs" }, - "com.amazonaws.quicksight#VisiblePanelRows": { - "type": "long", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 10 - } - } + { + "target": "com.amazonaws.quicksight#ListIngestions" }, - "com.amazonaws.quicksight#VisibleRangeOptions": { - "type": "structure", - "members": { - "PercentRange": { - "target": "com.amazonaws.quicksight#PercentVisibleRange", - "traits": { - "smithy.api#documentation": "

The percent range in the visible range.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The range options for the data zoom scroll bar.

" - } + { + "target": "com.amazonaws.quicksight#ListNamespaces" }, - "com.amazonaws.quicksight#Visual": { - "type": "structure", - "members": { - "TableVisual": { - "target": "com.amazonaws.quicksight#TableVisual", - "traits": { - "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" - } - }, - "PivotTableVisual": { - "target": "com.amazonaws.quicksight#PivotTableVisual", - "traits": { - "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" - } - }, - "BarChartVisual": { - "target": "com.amazonaws.quicksight#BarChartVisual", - "traits": { - "smithy.api#documentation": "

A bar chart.

\n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" - } - }, - "KPIVisual": { - "target": "com.amazonaws.quicksight#KPIVisual", - "traits": { - "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" - } - }, - "PieChartVisual": { - "target": "com.amazonaws.quicksight#PieChartVisual", - "traits": { - "smithy.api#documentation": "

A pie or donut chart.

\n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

" - } - }, - "GaugeChartVisual": { - "target": "com.amazonaws.quicksight#GaugeChartVisual", - "traits": { - "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" - } - }, - "LineChartVisual": { - "target": "com.amazonaws.quicksight#LineChartVisual", - "traits": { - "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" - } - }, - "HeatMapVisual": { - "target": "com.amazonaws.quicksight#HeatMapVisual", - "traits": { - "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" - } - }, - "TreeMapVisual": { - "target": "com.amazonaws.quicksight#TreeMapVisual", - "traits": { - "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" - } - }, - "GeospatialMapVisual": { - "target": "com.amazonaws.quicksight#GeospatialMapVisual", - "traits": { - "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" - } - }, - "FilledMapVisual": { - "target": "com.amazonaws.quicksight#FilledMapVisual", - "traits": { - "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" - } - }, - "FunnelChartVisual": { - "target": "com.amazonaws.quicksight#FunnelChartVisual", - "traits": { - "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" - } - }, - "ScatterPlotVisual": { - "target": "com.amazonaws.quicksight#ScatterPlotVisual", - "traits": { - "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" - } - }, - "ComboChartVisual": { - "target": "com.amazonaws.quicksight#ComboChartVisual", - "traits": { - "smithy.api#documentation": "

A combo chart.

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" - } - }, - "BoxPlotVisual": { - "target": "com.amazonaws.quicksight#BoxPlotVisual", - "traits": { - "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" - } - }, - "WaterfallVisual": { - "target": "com.amazonaws.quicksight#WaterfallVisual", - "traits": { - "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" - } - }, - "HistogramVisual": { - "target": "com.amazonaws.quicksight#HistogramVisual", - "traits": { - "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" - } - }, - "WordCloudVisual": { - "target": "com.amazonaws.quicksight#WordCloudVisual", - "traits": { - "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" - } - }, - "InsightVisual": { - "target": "com.amazonaws.quicksight#InsightVisual", - "traits": { - "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" - } - }, - "SankeyDiagramVisual": { - "target": "com.amazonaws.quicksight#SankeyDiagramVisual", - "traits": { - "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" - } - }, - "CustomContentVisual": { - "target": "com.amazonaws.quicksight#CustomContentVisual", - "traits": { - "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" - } - }, - "EmptyVisual": { - "target": "com.amazonaws.quicksight#EmptyVisual", - "traits": { - "smithy.api#documentation": "

An empty visual.

" - } - }, - "RadarChartVisual": { - "target": "com.amazonaws.quicksight#RadarChartVisual", - "traits": { - "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A visual displayed on a sheet in an analysis, dashboard, or template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } + { + "target": "com.amazonaws.quicksight#ListRefreshSchedules" + }, + { + "target": "com.amazonaws.quicksight#ListRoleMemberships" + }, + { + "target": "com.amazonaws.quicksight#ListTagsForResource" + }, + { + "target": "com.amazonaws.quicksight#ListTemplateAliases" + }, + { + "target": "com.amazonaws.quicksight#ListTemplates" + }, + { + "target": "com.amazonaws.quicksight#ListTemplateVersions" + }, + { + "target": "com.amazonaws.quicksight#ListThemeAliases" + }, + { + "target": "com.amazonaws.quicksight#ListThemes" + }, + { + "target": "com.amazonaws.quicksight#ListThemeVersions" + }, + { + "target": "com.amazonaws.quicksight#ListTopicRefreshSchedules" + }, + { + "target": "com.amazonaws.quicksight#ListTopicReviewedAnswers" + }, + { + "target": "com.amazonaws.quicksight#ListTopics" + }, + { + "target": "com.amazonaws.quicksight#ListUserGroups" + }, + { + "target": "com.amazonaws.quicksight#ListUsers" + }, + { + "target": "com.amazonaws.quicksight#ListVPCConnections" + }, + { + "target": "com.amazonaws.quicksight#PutDataSetRefreshProperties" }, - "com.amazonaws.quicksight#VisualAxisSortOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availaiblity status of a visual's axis sort options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The axis sort options for a visual.

" - } + { + "target": "com.amazonaws.quicksight#RegisterUser" }, - "com.amazonaws.quicksight#VisualCustomAction": { - "type": "structure", - "members": { - "CustomActionId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

The ID of the VisualCustomAction.

", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#VisualCustomActionName", - "traits": { - "smithy.api#documentation": "

The name of the VisualCustomAction.

", - "smithy.api#required": {} - } - }, - "Status": { - "target": "com.amazonaws.quicksight#WidgetStatus", - "traits": { - "smithy.api#documentation": "

The status of the VisualCustomAction.

" - } - }, - "Trigger": { - "target": "com.amazonaws.quicksight#VisualCustomActionTrigger", - "traits": { - "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n ", - "smithy.api#required": {} - } - }, - "ActionOperations": { - "target": "com.amazonaws.quicksight#VisualCustomActionOperationList", - "traits": { - "smithy.api#documentation": "

A list of VisualCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

A custom action defined on a visual.

" - } + { + "target": "com.amazonaws.quicksight#RestoreAnalysis" }, - "com.amazonaws.quicksight#VisualCustomActionList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VisualCustomAction" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } + { + "target": "com.amazonaws.quicksight#SearchAnalyses" }, - "com.amazonaws.quicksight#VisualCustomActionName": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 256 - } - } + { + "target": "com.amazonaws.quicksight#SearchDashboards" }, - "com.amazonaws.quicksight#VisualCustomActionOperation": { - "type": "structure", - "members": { - "FilterOperation": { - "target": "com.amazonaws.quicksight#CustomActionFilterOperation", - "traits": { - "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" - } - }, - "NavigationOperation": { - "target": "com.amazonaws.quicksight#CustomActionNavigationOperation", - "traits": { - "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

" - } - }, - "URLOperation": { - "target": "com.amazonaws.quicksight#CustomActionURLOperation", - "traits": { - "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" - } - }, - "SetParametersOperation": { - "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation", - "traits": { - "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } + { + "target": "com.amazonaws.quicksight#SearchDataSets" }, - "com.amazonaws.quicksight#VisualCustomActionOperationList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#VisualCustomActionOperation" - }, - "traits": { - "smithy.api#length": { - "min": 1, - "max": 2 - } - } + { + "target": "com.amazonaws.quicksight#SearchDataSources" }, - "com.amazonaws.quicksight#VisualCustomActionTrigger": { - "type": "enum", - "members": { - "DATA_POINT_CLICK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_POINT_CLICK" - } - }, - "DATA_POINT_MENU": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DATA_POINT_MENU" - } - } - } + { + "target": "com.amazonaws.quicksight#SearchFolders" }, - "com.amazonaws.quicksight#VisualInteractionOptions": { - "type": "structure", - "members": { - "VisualMenuOption": { - "target": "com.amazonaws.quicksight#VisualMenuOption", - "traits": { - "smithy.api#documentation": "

The on-visual menu options for a visual.

" - } - }, - "ContextMenuOption": { - "target": "com.amazonaws.quicksight#ContextMenuOption", - "traits": { - "smithy.api#documentation": "

The context menu options for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for visual publish options

" - } + { + "target": "com.amazonaws.quicksight#SearchGroups" }, - "com.amazonaws.quicksight#VisualList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#Visual" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 50 - } - } + { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJob" }, - "com.amazonaws.quicksight#VisualMenuOption": { - "type": "structure", - "members": { - "AvailabilityStatus": { - "target": "com.amazonaws.quicksight#DashboardBehavior", - "traits": { - "smithy.api#documentation": "

The availaiblity status of a visual's menu options.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The menu options for a visual.

" - } + { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJob" }, - "com.amazonaws.quicksight#VisualOptions": { - "type": "structure", - "members": { - "type": { - "target": "com.amazonaws.quicksight#LimitedString", - "traits": { - "smithy.api#documentation": "

The type for a VisualOptions.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The definition for a VisualOptions.

" - } + { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJob" }, - "com.amazonaws.quicksight#VisualPalette": { - "type": "structure", - "members": { - "ChartColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

The chart color options for the visual palette.

" - } - }, - "ColorMap": { - "target": "com.amazonaws.quicksight#DataPathColorList", - "traits": { - "smithy.api#documentation": "

The color map options for the visual palette.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The visual display options for the visual palette.

" - } + { + "target": "com.amazonaws.quicksight#TagResource" }, - "com.amazonaws.quicksight#VisualRole": { - "type": "enum", - "members": { - "PRIMARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "PRIMARY" - } - }, - "COMPLIMENTARY": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "COMPLIMENTARY" - } - }, - "MULTI_INTENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MULTI_INTENT" - } - }, - "FALLBACK": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FALLBACK" - } - }, - "FRAGMENT": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FRAGMENT" - } - } - } + { + "target": "com.amazonaws.quicksight#UntagResource" }, - "com.amazonaws.quicksight#VisualSubtitleLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the subtitle label.

" - } - }, - "FormatText": { - "target": "com.amazonaws.quicksight#LongFormatText", - "traits": { - "smithy.api#documentation": "

The long text format of the subtitle label, such as plain text or rich text.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The subtitle label options for a visual.

" - } + { + "target": "com.amazonaws.quicksight#UpdateAccountCustomization" }, - "com.amazonaws.quicksight#VisualTitleLabelOptions": { - "type": "structure", - "members": { - "Visibility": { - "target": "com.amazonaws.quicksight#Visibility", - "traits": { - "smithy.api#documentation": "

The visibility of the title label.

" - } - }, - "FormatText": { - "target": "com.amazonaws.quicksight#ShortFormatText", - "traits": { - "smithy.api#documentation": "

The short text format of the title label, such as plain text or rich text.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The title label options for a visual.

" - } + { + "target": "com.amazonaws.quicksight#UpdateAccountSettings" }, - "com.amazonaws.quicksight#VpcConnectionProperties": { - "type": "structure", - "members": { - "VpcConnectionArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the VPC connection.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

VPC connection properties.

" - } + { + "target": "com.amazonaws.quicksight#UpdateAnalysis" }, - "com.amazonaws.quicksight#VpcEndpointId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^vpce-[0-9a-z]*$" - } + { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissions" }, - "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } + { + "target": "com.amazonaws.quicksight#UpdateDashboard" }, - "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#VpcEndpointId" - }, - "value": { - "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription" - } + { + "target": "com.amazonaws.quicksight#UpdateDashboardLinks" }, - "com.amazonaws.quicksight#VpcId": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 255 - }, - "smithy.api#pattern": "^vpc-[0-9a-z]*$" - } + { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissions" }, - "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 150 - } - } + { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersion" }, - "com.amazonaws.quicksight#VpcIdRestrictionRuleMap": { - "type": "map", - "key": { - "target": "com.amazonaws.quicksight#VpcId" - }, - "value": { - "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription" - } + { + "target": "com.amazonaws.quicksight#UpdateDataSet" }, - "com.amazonaws.quicksight#Warehouse": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 0, - "max": 128 - } - } + { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSource" + }, + { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateFolder" + }, + { + "target": "com.amazonaws.quicksight#UpdateFolderPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateGroup" + }, + { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignment" + }, + { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfig" + }, + { + "target": "com.amazonaws.quicksight#UpdateIpRestriction" + }, + { + "target": "com.amazonaws.quicksight#UpdateKeyRegistration" }, - "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells": { - "type": "structure", - "members": { - "Categories": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The category field wells of a waterfall visual.

" + { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettings" + }, + { + "target": "com.amazonaws.quicksight#UpdateRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermission" + }, + { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplate" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplateAlias" + }, + { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTheme" + }, + { + "target": "com.amazonaws.quicksight#UpdateThemeAlias" + }, + { + "target": "com.amazonaws.quicksight#UpdateThemePermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopic" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicPermissions" + }, + { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshSchedule" + }, + { + "target": "com.amazonaws.quicksight#UpdateUser" + }, + { + "target": "com.amazonaws.quicksight#UpdateVPCConnection" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "QuickSight", + "arnNamespace": "quicksight", + "cloudFormationName": "QuickSight", + "cloudTrailEventSource": "quicksight.amazonaws.com", + "endpointPrefix": "quicksight" + }, + "aws.auth#sigv4": { + "name": "quicksight" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "Amazon QuickSight API Reference\n

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

", + "smithy.api#title": "Amazon QuickSight", + "smithy.rules#endpointRuleSet": { + "version": "1.0", + "parameters": { + "Region": { + "builtIn": "AWS::Region", + "required": false, + "documentation": "The AWS region used to dispatch the request.", + "type": "String" + }, + "UseDualStack": { + "builtIn": "AWS::UseDualStack", + "required": true, + "default": false, + "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", + "type": "Boolean" + }, + "UseFIPS": { + "builtIn": "AWS::UseFIPS", + "required": true, + "default": false, + "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", + "type": "Boolean" + }, + "Endpoint": { + "builtIn": "SDK::Endpoint", + "required": false, + "documentation": "Override the endpoint used to send this request", + "type": "String" + } + }, + "rules": [ + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Endpoint" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] } + ], + "error": "Invalid Configuration: FIPS and custom endpoint are not supported", + "type": "error" }, - "Values": { - "target": "com.amazonaws.quicksight#MeasureFieldList", - "traits": { - "smithy.api#documentation": "

The value field wells of a waterfall visual.

" + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] } + ], + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", + "type": "error" }, - "Breakdowns": { - "target": "com.amazonaws.quicksight#DimensionFieldList", - "traits": { - "smithy.api#documentation": "

The breakdown field wells of a waterfall visual.

" + { + "conditions": [], + "endpoint": { + "url": { + "ref": "Endpoint" + }, + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "isSet", + "argv": [ + { + "ref": "Region" + } + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "aws.partition", + "argv": [ + { + "ref": "Region" + } + ], + "assign": "PartitionResult" + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + }, + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + } + ] + }, + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS and DualStack are enabled, but this partition does not support one or both", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseFIPS" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsFIPS" + ] + }, + true + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight-fips.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "FIPS is enabled but this partition does not support FIPS", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + { + "ref": "UseDualStack" + }, + true + ] + } + ], + "rules": [ + { + "conditions": [ + { + "fn": "booleanEquals", + "argv": [ + true, + { + "fn": "getAttr", + "argv": [ + { + "ref": "PartitionResult" + }, + "supportsDualStack" + ] + } + ] + } + ], + "rules": [ + { + "conditions": [], + "endpoint": { + "url": "https://quicksight.{Region}.{PartitionResult#dualStackDnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" + } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "DualStack is enabled but this partition does not support DualStack", + "type": "error" + } + ], + "type": "tree" + }, + { + "conditions": [], + "endpoint": { + "url": "https://quicksight.{Region}.{PartitionResult#dnsSuffix}", + "properties": {}, + "headers": {} + }, + "type": "endpoint" } + ], + "type": "tree" } + ], + "type": "tree" + }, + { + "conditions": [], + "error": "Invalid Configuration: Missing Region", + "type": "error" + } + ] + }, + "smithy.rules#endpointTests": { + "testCases": [ + { + "documentation": "For region ap-northeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ap-northeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-northeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ap-northeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-northeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-south-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ap-south-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-south-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ap-southeast-1.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ap-southeast-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ap-southeast-2.amazonaws.com" + } + }, + "params": { + "Region": "ap-southeast-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region api with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.api.amazonaws.com" + } + }, + "params": { + "Region": "api", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region ca-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.ca-central-1.amazonaws.com" + } + }, + "params": { + "Region": "ca-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-central-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.eu-central-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-central-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.eu-west-1.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region eu-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.eu-west-2.amazonaws.com" + } + }, + "params": { + "Region": "eu-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region sa-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.sa-east-1.amazonaws.com" + } + }, + "params": { + "Region": "sa-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-east-2.amazonaws.com" + } + }, + "params": { + "Region": "us-east-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-west-2 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-west-2.amazonaws.com" + } + }, + "params": { + "Region": "us-west-2", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-east-1.api.aws" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight.cn-north-1.api.amazonwebservices.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region cn-north-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.cn-north-1.amazonaws.com.cn" + } + }, + "params": { + "Region": "cn-north-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region api with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.api.amazonaws.com" + } + }, + "params": { + "Region": "api", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-gov-west-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-west-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": true, + "UseDualStack": false + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-gov-east-1.api.aws" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": true + } + }, + { + "documentation": "For region us-gov-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-gov-east-1.amazonaws.com" + } + }, + "params": { + "Region": "us-gov-east-1", + "UseFIPS": false, + "UseDualStack": false + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": true + } + }, + { + "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartColorConfiguration": { - "type": "structure", - "members": { - "GroupColorConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" - } - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "

The color configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#WaterfallChartFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" - } - }, - "WaterfallChartOptions": { - "target": "com.amazonaws.quicksight#WaterfallChartOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" - } - }, - "CategoryAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the category axis label.

" - } - }, - "CategoryAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the category axis.

" - } - }, - "PrimaryYAxisLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" - } - }, - "PrimaryYAxisDisplayOptions": { - "target": "com.amazonaws.quicksight#AxisDisplayOptions", - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" - } - }, - "Legend": { - "target": "com.amazonaws.quicksight#LegendOptions", - "traits": { - "smithy.api#documentation": "

The legend configuration of a waterfall visual.

" - } - }, - "DataLabels": { - "target": "com.amazonaws.quicksight#DataLabelOptions", - "traits": { - "smithy.api#documentation": "

The data label configuration of a waterfall visual.

" - } - }, - "VisualPalette": { - "target": "com.amazonaws.quicksight#VisualPalette", - "traits": { - "smithy.api#documentation": "

The visual palette configuration of a waterfall visual.

" - } - }, - "ColorConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartColorConfiguration", - "traits": { - "smithy.api#documentation": "

The color configuration of a waterfall visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } + { + "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-iso-east-1.c2s.ic.gov" + } + }, + "params": { + "Region": "us-iso-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

The configuration for a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartFieldWells": { - "type": "structure", - "members": { - "WaterfallChartAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack enabled", + "expect": { + "error": "FIPS and DualStack are enabled, but this partition does not support one or both" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration": { - "type": "structure", - "members": { - "PositiveBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the positive bars of a waterfall chart.

" - } - }, - "NegativeBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the negative bars of a waterfall chart.

" - } - }, - "TotalBarColor": { - "target": "com.amazonaws.quicksight#HexColor", - "traits": { - "smithy.api#documentation": "

Defines the color for the total bars of a waterfall chart.

" - } - } + { + "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight-fips.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": true, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartOptions": { - "type": "structure", - "members": { - "TotalBarLabel": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "

This option determines the total bar label of a waterfall visual.

" - } - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack enabled", + "expect": { + "error": "DualStack is enabled but this partition does not support DualStack" + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": true + } }, - "traits": { - "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallChartSortConfiguration": { - "type": "structure", - "members": { - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of the category fields.

" - } - }, - "BreakdownItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of bar groups that are displayed.

" - } - } + { + "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", + "expect": { + "endpoint": { + "url": "https://quicksight.us-isob-east-1.sc2s.sgov.gov" + } + }, + "params": { + "Region": "us-isob-east-1", + "UseFIPS": false, + "UseDualStack": false + } }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" - } - }, - "com.amazonaws.quicksight#WaterfallVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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.

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#WaterfallChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration for a waterfall visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } + { + "documentation": "For custom endpoint with region set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" - } - }, - "com.amazonaws.quicksight#WhatIfPointScenario": { - "type": "structure", - "members": { - "Date": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The date that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The target value that you want to meet for the provided date.

", - "smithy.api#required": {} - } - } + { + "documentation": "For custom endpoint with region not set and fips disabled and dualstack disabled", + "expect": { + "endpoint": { + "url": "https://example.com" + } + }, + "params": { + "UseFIPS": false, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date.

" - } - }, - "com.amazonaws.quicksight#WhatIfRangeScenario": { - "type": "structure", - "members": { - "StartDate": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The start date in the date range that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "EndDate": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "

The end date in the date range that you need the forecast results for.

", - "smithy.api#required": {} - } - }, - "Value": { - "target": "com.amazonaws.quicksight#Double", - "traits": { - "smithy.api#default": 0, - "smithy.api#documentation": "

The target value that you want to meet for the provided date range.

", - "smithy.api#required": {} - } - } + { + "documentation": "For custom endpoint with fips enabled and dualstack disabled", + "expect": { + "error": "Invalid Configuration: FIPS and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": true, + "UseDualStack": false, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date range.

" - } - }, - "com.amazonaws.quicksight#WidgetStatus": { - "type": "enum", - "members": { - "ENABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "ENABLED" - } - }, - "DISABLED": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "DISABLED" - } - } - } - }, - "com.amazonaws.quicksight#WordCloudAggregatedFieldWells": { - "type": "structure", - "members": { - "GroupBy": { - "target": "com.amazonaws.quicksight#WordCloudDimensionFieldList", - "traits": { - "smithy.api#documentation": "

The group by field well of a word cloud. Values are grouped by group by fields.

" - } - }, - "Size": { - "target": "com.amazonaws.quicksight#WordCloudMeasureFieldList", - "traits": { - "smithy.api#documentation": "

The size field well of a word cloud. Values are aggregated based on group by fields.

" - } - } + { + "documentation": "For custom endpoint with fips disabled and dualstack enabled", + "expect": { + "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" + }, + "params": { + "Region": "us-east-1", + "UseFIPS": false, + "UseDualStack": true, + "Endpoint": "https://example.com" + } }, - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" + { + "documentation": "Missing region", + "expect": { + "error": "Invalid Configuration: Missing Region" + } } + ], + "version": "1.0" + } + } + }, + "com.amazonaws.quicksight#RadarChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Category": { + "target": "com.amazonaws.quicksight#RadarChartCategoryFieldList", + "traits": { + "smithy.api#documentation": "

The aggregated field well categories of a radar chart.

" + } + }, + "Color": { + "target": "com.amazonaws.quicksight#RadarChartColorFieldList", + "traits": { + "smithy.api#documentation": "

The color that are assigned to the aggregated field wells of a radar chart.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#RadarChartValuesFieldList", + "traits": { + "smithy.api#documentation": "

The values that are assigned to the aggregated field wells of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartAreaStyleSettings": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility settings of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configured style settings of a radar chart.

" + } + }, + "com.amazonaws.quicksight#RadarChartAxesRangeScale": { + "type": "enum", + "members": { + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + }, + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + } + } + }, + "com.amazonaws.quicksight#RadarChartCategoryFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RadarChartColorFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RadarChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#RadarChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a RadarChartVisual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#RadarChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" + } + }, + "Shape": { + "target": "com.amazonaws.quicksight#RadarChartShape", + "traits": { + "smithy.api#documentation": "

The shape of the radar chart.

" + } + }, + "BaseSeriesSettings": { + "target": "com.amazonaws.quicksight#RadarChartSeriesSettings", + "traits": { + "smithy.api#documentation": "

The base sreies settings of a radar chart.

" + } + }, + "StartAngle": { + "target": "com.amazonaws.quicksight#RadarChartStartAngle", + "traits": { + "smithy.api#documentation": "

The start angle of a radar chart's axis.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "AlternateBandColorsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the colors of alternatign bands in a radar chart.

" + } + }, + "AlternateBandEvenColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the even-numbered alternate bands of a radar chart.

" + } + }, + "AlternateBandOddColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the odd-numbered alternate bands of a radar chart.

" + } + }, + "CategoryAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The category axis of a radar chart.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The category label options of a radar chart.

" + } + }, + "ColorAxis": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The color axis of a radar chart.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The color label options of a radar chart.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "AxesRangeScale": { + "target": "com.amazonaws.quicksight#RadarChartAxesRangeScale", + "traits": { + "smithy.api#documentation": "

The axis behavior options of a radar chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartFieldWells": { + "type": "structure", + "members": { + "RadarChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#RadarChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a radar chart visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a radar chart visual.

" + } + }, + "com.amazonaws.quicksight#RadarChartSeriesSettings": { + "type": "structure", + "members": { + "AreaStyleSettings": { + "target": "com.amazonaws.quicksight#RadarChartAreaStyleSettings", + "traits": { + "smithy.api#documentation": "

The area style settings of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series settings of a radar chart.

" + } + }, + "com.amazonaws.quicksight#RadarChartShape": { + "type": "enum", + "members": { + "CIRCLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CIRCLE" + } + }, + "POLYGON": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "POLYGON" + } + } + } + }, + "com.amazonaws.quicksight#RadarChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The category sort options of a radar chart.

" + } + }, + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The category items limit for a radar chart.

" + } + }, + "ColorSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The color sort configuration of a radar chart.

" + } + }, + "ColorItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The color items limit of a radar chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a RadarChartVisual.

" + } + }, + "com.amazonaws.quicksight#RadarChartStartAngle": { + "type": "double", + "traits": { + "smithy.api#range": { + "min": -360, + "max": 360 + } + } + }, + "com.amazonaws.quicksight#RadarChartValuesFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#RadarChartVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#RadarChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A radar chart visual.

" + } + }, + "com.amazonaws.quicksight#RangeConstant": { + "type": "structure", + "members": { + "Minimum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The minimum value for a range constant.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The maximum value for a range constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a range constant.

" + } + }, + "com.amazonaws.quicksight#RangeEndsLabelType": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the range ends label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range ends label type of a data path label.

" + } + }, + "com.amazonaws.quicksight#RdsParameters": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.quicksight#InstanceId", + "traits": { + "smithy.api#documentation": "

Instance ID.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Amazon RDS.

" + } + }, + "com.amazonaws.quicksight#RecoveryWindowInDays": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 7, + "max": 30 + } + } + }, + "com.amazonaws.quicksight#RedshiftIAMParameters": { + "type": "structure", + "members": { + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.

", + "smithy.api#required": {} + } + }, + "DatabaseUser": { + "target": "com.amazonaws.quicksight#DatabaseUser", + "traits": { + "smithy.api#documentation": "

The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.

" + } + }, + "DatabaseGroups": { + "target": "com.amazonaws.quicksight#DatabaseGroupList", + "traits": { + "smithy.api#documentation": "

A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.

" + } + }, + "AutoCreateDatabaseUser": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that grants Amazon QuickSight access to your cluster and make a call to the redshift:GetClusterCredentials API. For more information on the redshift:GetClusterCredentials API, see \n GetClusterCredentials\n .

" + } + }, + "com.amazonaws.quicksight#RedshiftParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host. This field can be blank if ClusterId is provided.

" + } + }, + "Port": { + "target": "com.amazonaws.quicksight#OptionalPort", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

Port. This field can be blank if the ClusterId is provided.

" + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + }, + "ClusterId": { + "target": "com.amazonaws.quicksight#ClusterId", + "traits": { + "smithy.api#documentation": "

Cluster ID. This field can be blank if the Host and Port are\n provided.

" + } + }, + "IAMParameters": { + "target": "com.amazonaws.quicksight#RedshiftIAMParameters", + "traits": { + "smithy.api#documentation": "

An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.

" + } + }, + "IdentityCenterConfiguration": { + "target": "com.amazonaws.quicksight#IdentityCenterConfiguration", + "traits": { + "smithy.api#documentation": "

An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster.

\n

This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Amazon Redshift. The ClusterId field can be blank if\n Host and Port are both set. The Host and Port fields can be blank if the ClusterId field is set.

" + } + }, + "com.amazonaws.quicksight#ReferenceLine": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the reference line. Choose one of the following options:

\n " + } + }, + "DataConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineDataConfiguration", + "traits": { + "smithy.api#documentation": "

The data configuration of the reference line.

", + "smithy.api#required": {} + } + }, + "StyleConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineStyleConfiguration", + "traits": { + "smithy.api#documentation": "

The style configuration of the reference line.

" + } + }, + "LabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The label configuration of the reference line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The reference line visual display options.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration": { + "type": "structure", + "members": { + "CustomLabel": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The string text of the custom label.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a custom label on a ReferenceLine.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineDataConfiguration": { + "type": "structure", + "members": { + "StaticConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration", + "traits": { + "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" + } + }, + "DynamicConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration", + "traits": { + "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" + } + }, + "AxisBinding": { + "target": "com.amazonaws.quicksight#AxisBinding", + "traits": { + "smithy.api#documentation": "

The axis binding type of the reference line. Choose one of the following options:

\n " + } + }, + "SeriesType": { + "target": "com.amazonaws.quicksight#ReferenceLineSeriesType", + "traits": { + "smithy.api#documentation": "

The series type of the reference line data configuration. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The data configuration of the reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineDynamicDataConfiguration": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the dynamic data targets.

", + "smithy.api#required": {} + } + }, + "MeasureAggregationFunction": { + "target": "com.amazonaws.quicksight#AggregationFunction", + "traits": { + "smithy.api#documentation": "

The aggregation function that is used in the dynamic data.

" + } + }, + "Calculation": { + "target": "com.amazonaws.quicksight#NumericalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The calculation that is used in the dynamic data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The dynamic configuration of the reference line data configuration.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelConfiguration": { + "type": "structure", + "members": { + "ValueLabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" + } + }, + "CustomLabelConfiguration": { + "target": "com.amazonaws.quicksight#ReferenceLineCustomLabelConfiguration", + "traits": { + "smithy.api#documentation": "

The custom label configuration of the label in a reference line.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the label in a reference line.

" + } + }, + "FontColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The font color configuration of the label in a reference line.

" + } + }, + "HorizontalPosition": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition", + "traits": { + "smithy.api#documentation": "

The horizontal position configuration of the label in a reference line. Choose one of\n the following options:

\n " + } + }, + "VerticalPosition": { + "target": "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition", + "traits": { + "smithy.api#documentation": "

The vertical position configuration of the label in a reference line. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The label configuration of a reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelHorizontalPosition": { + "type": "enum", + "members": { + "LEFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEFT" + } + }, + "CENTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CENTER" + } + }, + "RIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RIGHT" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineLabelVerticalPosition": { + "type": "enum", + "members": { + "ABOVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABOVE" + } + }, + "BELOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BELOW" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ReferenceLine" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#ReferenceLinePatternType": { + "type": "enum", + "members": { + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + }, + "DASHED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DASHED" + } + }, + "DOTTED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOTTED" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineSeriesType": { + "type": "enum", + "members": { + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, + "com.amazonaws.quicksight#ReferenceLineStaticDataConfiguration": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#SensitiveDouble", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The double input of the static data.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The static data configuration of the reference line data configuration.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineStyleConfiguration": { + "type": "structure", + "members": { + "Pattern": { + "target": "com.amazonaws.quicksight#ReferenceLinePatternType", + "traits": { + "smithy.api#documentation": "

The pattern type of the line style. Choose one of the following options:

\n " + } + }, + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The hex color of the reference line.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The style configuration of the reference\n line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineValueLabelConfiguration": { + "type": "structure", + "members": { + "RelativePosition": { + "target": "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition", + "traits": { + "smithy.api#documentation": "

The relative position of the value label. Choose one of the following options:

\n " + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the value label.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value label configuration of the label in a reference line.

" + } + }, + "com.amazonaws.quicksight#ReferenceLineValueLabelRelativePosition": { + "type": "enum", + "members": { + "BEFORE_CUSTOM_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BEFORE_CUSTOM_LABEL" + } + }, + "AFTER_CUSTOM_LABEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AFTER_CUSTOM_LABEL" + } + } + } + }, + "com.amazonaws.quicksight#RefreshConfiguration": { + "type": "structure", + "members": { + "IncrementalRefresh": { + "target": "com.amazonaws.quicksight#IncrementalRefresh", + "traits": { + "smithy.api#documentation": "

The incremental refresh for the dataset.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh configuration of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshFrequency": { + "type": "structure", + "members": { + "Interval": { + "target": "com.amazonaws.quicksight#RefreshInterval", + "traits": { + "smithy.api#documentation": "

The interval between scheduled refreshes. Valid values are as follows:

\n ", + "smithy.api#required": {} + } + }, + "RefreshOnDay": { + "target": "com.amazonaws.quicksight#ScheduleRefreshOnEntity", + "traits": { + "smithy.api#documentation": "

The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.

" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().

" + } + }, + "TimeOfTheDay": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Specifies the interval between each scheduled refresh of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshInterval": { + "type": "enum", + "members": { + "MINUTE15": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE15" + } + }, + "MINUTE30": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE30" + } + }, + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#RefreshSchedule": { + "type": "structure", + "members": { + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

An identifier for the refresh schedule.

", + "smithy.api#required": {} + } + }, + "ScheduleFrequency": { + "target": "com.amazonaws.quicksight#RefreshFrequency", + "traits": { + "smithy.api#documentation": "

The frequency for the refresh schedule.

", + "smithy.api#required": {} + } + }, + "StartAfterDateTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.

" + } + }, + "RefreshType": { + "target": "com.amazonaws.quicksight#IngestionType", + "traits": { + "smithy.api#documentation": "

The type of refresh that a datset undergoes. Valid values are as follows:

\n \n

For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.

", + "smithy.api#required": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh schedule of a dataset.

" + } + }, + "com.amazonaws.quicksight#RefreshSchedules": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

A list of RefreshSchedule objects.

" + } + } + }, + "com.amazonaws.quicksight#RegisterUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#RegisterUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#RegisterUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#WordCloudChartConfiguration": { - "type": "structure", - "members": { - "FieldWells": { - "target": "com.amazonaws.quicksight#WordCloudFieldWells", - "traits": { - "smithy.api#documentation": "

The field wells of the visual.

" - } - }, - "SortConfiguration": { - "target": "com.amazonaws.quicksight#WordCloudSortConfiguration", - "traits": { - "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" - } - }, - "CategoryLabelOptions": { - "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", - "traits": { - "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

" - } - }, - "WordCloudOptions": { - "target": "com.amazonaws.quicksight#WordCloudOptions", - "traits": { - "smithy.api#documentation": "

The options for a word cloud visual.

" - } - }, - "Interactions": { - "target": "com.amazonaws.quicksight#VisualInteractionOptions", - "traits": { - "smithy.api#documentation": "

The general visual interactions setup for a visual.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The configuration of a word cloud visual.

" - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#WordCloudCloudLayout": { - "type": "enum", - "members": { - "FLUID": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "FLUID" - } - }, - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - } - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#WordCloudDimensionFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#DimensionField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 10 - } - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#WordCloudFieldWells": { - "type": "structure", - "members": { - "WordCloudAggregatedFieldWells": { - "target": "com.amazonaws.quicksight#WordCloudAggregatedFieldWells", - "traits": { - "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The field wells of a word cloud visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" - } + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" }, - "com.amazonaws.quicksight#WordCloudMaximumStringLength": { - "type": "integer", - "traits": { - "smithy.api#range": { - "min": 1, - "max": 100 - } - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#WordCloudMeasureFieldList": { - "type": "list", - "member": { - "target": "com.amazonaws.quicksight#MeasureField" - }, - "traits": { - "smithy.api#length": { - "min": 0, - "max": 1 - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#WordCloudOptions": { - "type": "structure", - "members": { - "WordOrientation": { - "target": "com.amazonaws.quicksight#WordCloudWordOrientation", - "traits": { - "smithy.api#documentation": "

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

" - } - }, - "WordScaling": { - "target": "com.amazonaws.quicksight#WordCloudWordScaling", - "traits": { - "smithy.api#documentation": "

The word scaling options (emphasize, normal) for the words in a word cloud.

" - } - }, - "CloudLayout": { - "target": "com.amazonaws.quicksight#WordCloudCloudLayout", - "traits": { - "smithy.api#documentation": "

The cloud layout options (fluid, normal) of a word cloud.

" - } - }, - "WordCasing": { - "target": "com.amazonaws.quicksight#WordCloudWordCasing", - "traits": { - "smithy.api#documentation": "

The word casing options (lower_case, existing_case) for the words in a word cloud.

" - } - }, - "WordPadding": { - "target": "com.amazonaws.quicksight#WordCloudWordPadding", - "traits": { - "smithy.api#documentation": "

The word padding options (none, small, medium, large) for the words in a word cloud.

" - } - }, - "MaximumStringLength": { - "target": "com.amazonaws.quicksight#WordCloudMaximumStringLength", - "traits": { - "smithy.api#documentation": "

The length limit of each word from 1-100.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The word cloud options for a word cloud visual.

" - } + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#RegisterUserRequest": { + "type": "structure", + "members": { + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", + "traits": { + "smithy.api#documentation": "

The identity type that your Amazon QuickSight account uses to manage the identity of users.

", + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the user that you want to register.

", + "smithy.api#required": {} + } + }, + "UserRole": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n\t\t\tfollowing:

\n ", + "smithy.api#required": {} + } + }, + "IamArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

" + } + }, + "SessionName": { + "target": "com.amazonaws.quicksight#RoleSessionName", + "traits": { + "smithy.api#documentation": "

You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role\n in the CLI Reference.\n

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.

" + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

To add custom permissions to an existing user, use \n UpdateUser\n instead.

\n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

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.

\n " + } + }, + "CustomFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

The tags to associate with the user.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#RegisterUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The user's user name.

" + } + }, + "UserInvitationUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL the user visits to complete registration and provide a password. This is\n\t\t\treturned only for users with an identity type of QUICKSIGHT.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#RegisteredCustomerManagedKey": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is registered to a Amazon QuickSight account for encryption and decryption use.

" + } + }, + "DefaultKey": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Indicates whether a RegisteredCustomerManagedKey is set as the default key for encryption and decryption use.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A customer managed key structure that contains the information listed below:

\n " + } + }, + "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations": { + "type": "structure", + "members": { + "StatePersistence": { + "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", + "traits": { + "smithy.api#documentation": "

The state persistence configurations of an embedded Amazon QuickSight console.

" + } + }, + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configurations of an embedded Amazon QuickSight console.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

\n

If the user does not have permission to view this dashboard, they see a permissions error message.

", + "smithy.api#required": {} + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The feature configurations of an embbedded Amazon QuickSight dashboard.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the dashboard you want to embed.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardFeatureConfigurations": { + "type": "structure", + "members": { + "StatePersistence": { + "target": "com.amazonaws.quicksight#StatePersistenceConfigurations", + "traits": { + "smithy.api#documentation": "

The state persistence settings of an embedded dashboard.

" + } + }, + "SharedView": { + "target": "com.amazonaws.quicksight#SharedViewConfigurations", + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + }, + "Bookmarks": { + "target": "com.amazonaws.quicksight#BookmarksConfigurations", + "traits": { + "smithy.api#documentation": "

The bookmarks configuration for an embedded dashboard in Amazon QuickSight.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The feature configuration for an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialDashboardVisualId": { + "target": "com.amazonaws.quicksight#DashboardVisualId", + "traits": { + "smithy.api#documentation": "

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.

\n

The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The experience that you are embedding. You can use this object to generate a url that embeds a visual into your application.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserEmbeddingExperienceConfiguration": { + "type": "structure", + "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for providing a dashboard embedding experience.

" + } + }, + "QuickSightConsole": { + "target": "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User\n Guide.

\n

Use \n GenerateEmbedUrlForRegisteredUser\n \n where\n you want to provide an authoring portal that allows users to create data sources,\n datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console\n needs to belong to the author or admin security cohort. If you want to restrict permissions\n to some of these features, add a custom permissions profile to the user with the\n \n UpdateUser\n API operation. Use the \n RegisterUser\n API operation to add a new user with a custom permission profile attached. For more\n information, see the following sections in the Amazon QuickSight User\n Guide:

\n \n

For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.

" + } + }, + "QSearchBar": { + "target": "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for embedding the Q search bar.

\n

For more information about embedding the Q search bar, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + } + }, + "DashboardVisual": { + "target": "com.amazonaws.quicksight#RegisteredUserDashboardVisualEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The type of embedding experience. In this case, Amazon QuickSight visuals.

" + } + }, + "GenerativeQnA": { + "target": "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration details for embedding the Generative Q&A experience.

\n

For more information about embedding the Generative Q&A experience, see Embedding Overview in\n the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The type of experience you want to embed. For registered users, you can embed Amazon QuickSight dashboards or the Amazon QuickSight console.

\n \n

Exactly one of the experience configurations is required. You can choose\n Dashboard or QuickSightConsole. You cannot choose more\n than one experience configuration.

\n " + } + }, + "com.amazonaws.quicksight#RegisteredUserGenerativeQnAEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&A experience.\n You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening\n a topic. The ID is in the URL for the topic that you open.

\n

If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that provides information about the configuration of a Generative Q&A experience.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserQSearchBarEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialTopicId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers\n are allowed to select other topics from the list of available topics.

\n

If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Q search bar embedding experience.

" + } + }, + "com.amazonaws.quicksight#RegisteredUserQuickSightConsoleEmbeddingConfiguration": { + "type": "structure", + "members": { + "InitialPath": { + "target": "com.amazonaws.quicksight#EntryPath", + "traits": { + "smithy.api#documentation": "

The initial URL path for the Amazon QuickSight console. InitialPath is required.

\n

The entry point URL is constrained to the following paths:

\n " + } + }, + "FeatureConfigurations": { + "target": "com.amazonaws.quicksight#RegisteredUserConsoleFeatureConfigurations", + "traits": { + "smithy.api#documentation": "

The embedding configuration of an embedded Amazon QuickSight console.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the Amazon QuickSight console that you want to embed.

" + } + }, + "com.amazonaws.quicksight#RelationalTable": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#RelationalTableCatalog", + "traits": { + "smithy.api#documentation": "

The catalog associated with a table.

" + } + }, + "Schema": { + "target": "com.amazonaws.quicksight#RelationalTableSchema", + "traits": { + "smithy.api#documentation": "

The schema name. This name applies to certain relational database engines.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#RelationalTableName", + "traits": { + "smithy.api#documentation": "

The name of the relational table.

", + "smithy.api#required": {} + } + }, + "InputColumns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

The column schema of the table.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type for relational data sources.

" + } + }, + "com.amazonaws.quicksight#RelationalTableCatalog": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelationalTableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelationalTableSchema": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#RelativeDateTimeControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "DateTimeFormat": { + "target": "com.amazonaws.quicksight#DateTimeFormat", + "traits": { + "smithy.api#documentation": "

Customize how dates are formatted in controls.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#RelativeDateType": { + "type": "enum", + "members": { + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + } + } + }, + "com.amazonaws.quicksight#RelativeDatesFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "AnchorDateConfiguration": { + "target": "com.amazonaws.quicksight#AnchorDateConfiguration", + "traits": { + "smithy.api#documentation": "

The date configuration of the filter.

", + "smithy.api#required": {} + } + }, + "MinimumGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The minimum granularity (period granularity) of the relative dates filter.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", + "smithy.api#required": {} + } + }, + "RelativeDateType": { + "target": "com.amazonaws.quicksight#RelativeDateType", + "traits": { + "smithy.api#documentation": "

The range date type of the filter. Choose one of the options below:

\n ", + "smithy.api#required": {} + } + }, + "RelativeDateValue": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The date value of the filter.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "ExcludePeriodConfiguration": { + "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for the exclude period of the filter.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A RelativeDatesFilter filters relative dates values.

" + } + }, + "com.amazonaws.quicksight#RelativeFontSize": { + "type": "enum", + "members": { + "EXTRA_SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_SMALL" + } + }, + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + }, + "EXTRA_LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXTRA_LARGE" + } + } + } + }, + "com.amazonaws.quicksight#RenameColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The name of the column to be renamed.

", + "smithy.api#required": {} + } + }, + "NewColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The new name for the column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that renames a column.

" + } + }, + "com.amazonaws.quicksight#ResizeOption": { + "type": "enum", + "members": { + "FIXED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIXED" + } + }, + "RESPONSIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESPONSIVE" + } + } + } + }, + "com.amazonaws.quicksight#ResourceExistsException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The resource specified already exists.

", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.quicksight#ResourceId": { + "type": "string" + }, + "com.amazonaws.quicksight#ResourceName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

One or more resources can't be found.

", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.quicksight#ResourcePermission": { + "type": "structure", + "members": { + "Principal": { + "target": "com.amazonaws.quicksight#Principal", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the principal. This can be one of the\n following:

\n ", + "smithy.api#required": {} + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#ActionList", + "traits": { + "smithy.api#documentation": "

The IAM action to grant or revoke permissions on.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Permission for the resource.

" + } + }, + "com.amazonaws.quicksight#ResourcePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + } + } + }, + "com.amazonaws.quicksight#ResourceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_SUCCESSFUL" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SUCCESSFUL" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.quicksight#ResourceUnavailableException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "ResourceType": { + "target": "com.amazonaws.quicksight#ExceptionResourceType", + "traits": { + "smithy.api#documentation": "

The resource type for this request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This resource is currently unavailable.

", + "smithy.api#error": "server", + "smithy.api#httpError": 503 + } + }, + "com.amazonaws.quicksight#RestoreAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#RestoreAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#RestoreAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Restores an analysis.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/restore/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#RestoreAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're restoring.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#RestoreAnalysisResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you're restoring.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you're restoring.\n

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#RestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#ReviewedAnswerErrorCode": { + "type": "enum", + "members": { + "INTERNAL_ERROR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_ERROR" + } + }, + "MISSING_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_ANSWER" + } + }, + "DATASET_DOES_NOT_EXIST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATASET_DOES_NOT_EXIST" + } + }, + "INVALID_DATASET_ARN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATASET_ARN" + } + }, + "DUPLICATED_ANSWER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DUPLICATED_ANSWER" + } + }, + "INVALID_DATA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INVALID_DATA" + } + }, + "MISSING_REQUIRED_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MISSING_REQUIRED_FIELDS" + } + } + } + }, + "com.amazonaws.quicksight#Role": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN" + } + }, + "AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR" + } + }, + "READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER" + } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } + } + } + }, + "com.amazonaws.quicksight#RoleArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#RoleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 64 + }, + "smithy.api#pattern": "^[a-zA-Z0-9+=,.@_-]+$" + } + }, + "com.amazonaws.quicksight#RoleSessionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 2, + "max": 64 + }, + "smithy.api#pattern": "^[\\w+=.@-]*$" + } + }, + "com.amazonaws.quicksight#RollingDateConfiguration": { + "type": "structure", + "members": { + "DataSetIdentifier": { + "target": "com.amazonaws.quicksight#DataSetIdentifier", + "traits": { + "smithy.api#documentation": "

The data set that is used in the rolling date configuration.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression of the rolling date configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The rolling date configuration of a date time filter.

" + } + }, + "com.amazonaws.quicksight#RowAlternateColorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#HexColor" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#RowAlternateColorOptions": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

Determines the widget status.

" + } + }, + "RowAlternateColors": { + "target": "com.amazonaws.quicksight#RowAlternateColorList", + "traits": { + "smithy.api#documentation": "

Determines the list of row alternate colors.

" + } + }, + "UsePrimaryBackgroundColor": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The primary background color options for alternate rows.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the row alternate color options.

" + } + }, + "com.amazonaws.quicksight#RowInfo": { + "type": "structure", + "members": { + "RowsIngested": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of rows that were ingested.

" + } + }, + "RowsDropped": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of rows that were not ingested.

" + } + }, + "TotalRowsInDataset": { + "target": "com.amazonaws.quicksight#Long", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The total number of rows in the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about rows for a data set SPICE ingestion.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionDataSet": { + "type": "structure", + "members": { + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the dataset that contains permissions for RLS.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.

", + "smithy.api#required": {} + } + }, + "PermissionPolicy": { + "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", + "traits": { + "smithy.api#documentation": "

The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS\n is included for backward compatibility only.

", + "smithy.api#required": {} + } + }, + "FormatVersion": { + "target": "com.amazonaws.quicksight#RowLevelPermissionFormatVersion", + "traits": { + "smithy.api#documentation": "

The user or group rules associated with the dataset that contains permissions for RLS.

\n

By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#Status", + "traits": { + "smithy.api#documentation": "

The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about a dataset that contains permissions for row-level security (RLS).\n The permissions dataset maps fields to users or groups. For more information, see\n Using Row-Level Security (RLS) to Restrict Access to a Dataset in the Amazon QuickSight User\n Guide.

\n

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is\n not supported for new RLS datasets.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionFormatVersion": { + "type": "enum", + "members": { + "VERSION_1": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_1" + } + }, + "VERSION_2": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERSION_2" + } + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionPolicy": { + "type": "enum", + "members": { + "GRANT_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GRANT_ACCESS" + } + }, + "DENY_ACCESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DENY_ACCESS" + } + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#Status", + "traits": { + "smithy.api#documentation": "

The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.

" + } + }, + "TagRules": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleList", + "traits": { + "smithy.api#documentation": "

A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.

", + "smithy.api#required": {} + } + }, + "TagRuleConfigurations": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRule": { + "type": "structure", + "members": { + "TagKey": { + "target": "com.amazonaws.quicksight#SessionTagKey", + "traits": { + "smithy.api#documentation": "

The unique key for a tag.

", + "smithy.api#required": {} + } + }, + "ColumnName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The column name that a tag key is assigned to.

", + "smithy.api#required": {} + } + }, + "TagMultiValueDelimiter": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagDelimiter", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "MatchAllValue": { + "target": "com.amazonaws.quicksight#SessionTagValue", + "traits": { + "smithy.api#documentation": "

A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A set of rules associated with a tag.

" + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRuleConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowLevelPermissionTagRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#RowSortList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldSortOptions" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#S3Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#S3BucketConfiguration": { + "type": "structure", + "members": { + "BucketName": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.

", + "smithy.api#required": {} + } + }, + "BucketPrefix": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The prefix of the Amazon S3 bucket that the generated snapshots are stored in.

", + "smithy.api#required": {} + } + }, + "BucketRegion": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

An optional structure that contains the Amazon S3 bucket configuration that the generated snapshots are stored in. If you don't provide this information, generated snapshots are stored in the default Amazon QuickSight bucket.

" + } + }, + "com.amazonaws.quicksight#S3Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#S3Parameters": { + "type": "structure", + "members": { + "ManifestFileLocation": { + "target": "com.amazonaws.quicksight#ManifestFileLocation", + "traits": { + "smithy.api#documentation": "

Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded into Amazon QuickSight.

", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for S3.

" + } + }, + "com.amazonaws.quicksight#S3Source": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the data source.

", + "smithy.api#required": {} + } + }, + "UploadSettings": { + "target": "com.amazonaws.quicksight#UploadSettings", + "traits": { + "smithy.api#documentation": "

Information about the format for the S3 source file or files.

" + } + }, + "InputColumns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

\n \n

For files that aren't JSON, only STRING data types are supported in input columns.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A physical table type for an S3 data source.

" + } + }, + "com.amazonaws.quicksight#S3Uri": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$" + } + }, + "com.amazonaws.quicksight#SameSheetTargetVisualConfiguration": { + "type": "structure", + "members": { + "TargetVisuals": { + "target": "com.amazonaws.quicksight#TargetVisualList", + "traits": { + "smithy.api#documentation": "

A list of the target visual IDs that are located in the same sheet of the analysis.

" + } + }, + "TargetVisualOptions": { + "target": "com.amazonaws.quicksight#TargetVisualOptions", + "traits": { + "smithy.api#documentation": "

The options that choose the target visual in the same sheet.

\n

Valid values are defined as follows:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the same-sheet target visuals that you want to be filtered.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells": { + "type": "structure", + "members": { + "Source": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The source field wells of a sankey diagram.

" + } + }, + "Destination": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The destination field wells of a sankey diagram.

" + } + }, + "Weight": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The weight field wells of a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#SankeyDiagramFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#SankeyDiagramSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a sankey diagram.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramFieldWells": { + "type": "structure", + "members": { + "SankeyDiagramAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#SankeyDiagramAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramSortConfiguration": { + "type": "structure", + "members": { + "WeightSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the weight fields.

" + } + }, + "SourceItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of source nodes that are displayed in a sankey diagram.

" + } + }, + "DestinationItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of destination nodes that are displayed in a sankey diagram.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a sankey diagram.

" + } + }, + "com.amazonaws.quicksight#SankeyDiagramVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#SankeyDiagramChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of a sankey diagram.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is aggregated by category.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is aggregated by category.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field well of a scatter plot.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a scatter plot.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The label field well of a scatter plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a scatter plot.

" + } + }, + "XAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.

" + } + }, + "XAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.

" + } + }, + "YAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.

" + } + }, + "YAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The palette (chart color) display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotFieldWells": { + "type": "structure", + "members": { + "ScatterPlotCategoricallyAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotCategoricallyAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.

" + } + }, + "ScatterPlotUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are\n unaggregated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a scatter plot.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotSortConfiguration": { + "type": "structure", + "members": { + "ScatterPlotLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration" + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotUnaggregatedFieldWells": { + "type": "structure", + "members": { + "XAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The x-axis field well of a scatter plot.

\n

The x-axis is a dimension field and cannot be aggregated.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The y-axis field well of a scatter plot.

\n

The y-axis is a dimension field and cannot be aggregated.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a scatter plot.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field well of a scatter plot.

" + } + }, + "Label": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The label field well of a scatter plot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field wells of a scatter plot.

" + } + }, + "com.amazonaws.quicksight#ScatterPlotVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#ScatterPlotConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#ScheduleRefreshOnEntity": { + "type": "structure", + "members": { + "DayOfWeek": { + "target": "com.amazonaws.quicksight#DayOfWeek", + "traits": { + "smithy.api#documentation": "

The day of the week that you want to schedule a refresh on.

" + } + }, + "DayOfMonth": { + "target": "com.amazonaws.quicksight#DayOfMonth", + "traits": { + "smithy.api#documentation": "

The day of the month that you want to schedule refresh on.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The refresh on entity for weekly or monthly schedules.

" + } + }, + "com.amazonaws.quicksight#ScrollBarOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the data zoom scroll bar.

" + } + }, + "VisibleRange": { + "target": "com.amazonaws.quicksight#VisibleRangeOptions", + "traits": { + "smithy.api#documentation": "

The visibility range for the data zoom scroll bar.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual display options for a data zoom scroll bar.

" + } + }, + "com.amazonaws.quicksight#SearchAnalyses": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchAnalysesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchAnalysesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for analyses that belong to the user specified in the filter.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/analyses", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "AnalysisSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchAnalysesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analyses that you're searching\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#AnalysisSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchAnalysesResponse": { + "type": "structure", + "members": { + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "traits": { + "smithy.api#documentation": "

Metadata describing the analyses that you searched for.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDashboards": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDashboardsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDashboardsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches for dashboards that belong to a user.

\n \n

This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/dashboards", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DashboardSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDashboardsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the user whose dashboards you're searching\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]\n

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDashboardsResponse": { + "type": "structure", + "members": { + "DashboardSummaryList": { + "target": "com.amazonaws.quicksight#DashboardSummaryList", + "traits": { + "smithy.api#documentation": "

The list of dashboards owned by the user specified in Filters in your\n request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDataSets": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDataSetsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDataSetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchDataSets operation to search for datasets that belong to an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/data-sets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSetSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDataSetsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DataSetSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDataSetsResponse": { + "type": "structure", + "members": { + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", + "traits": { + "smithy.api#documentation": "

A DataSetSummaries object that returns a summary of a dataset.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchDataSources": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchDataSourcesRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchDataSourcesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchDataSources operation to search for data sources that belong to an account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/data-sources", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "DataSourceSummaries", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchDataSourcesRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#DataSourceSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search.

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchDataSourcesResponse": { + "type": "structure", + "members": { + "DataSourceSummaries": { + "target": "com.amazonaws.quicksight#DataSourceSummaryList", + "traits": { + "smithy.api#documentation": "

A DataSourceSummaries object that returns a summary of a data source.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchFolders": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchFoldersRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchFoldersResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#InvalidRequestException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Searches the subfolders in a folder.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/search/folders", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "FolderSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchFoldersRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#FolderSearchFilterList", + "traits": { + "smithy.api#documentation": "

The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, \"Filters\": [ { \"Name\": \"PARENT_FOLDER_ARN\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:folder/folderId\" } ].

", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to be returned per request.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchFoldersResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "FolderSummaryList": { + "target": "com.amazonaws.quicksight#FolderSummaryList", + "traits": { + "smithy.api#documentation": "

A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The token for the next set of results, or null if there are no more results.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#SearchGroups": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#SearchGroupsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#SearchGroupsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidNextTokenException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups-search", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "GroupList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.quicksight#SearchGroupsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#documentation": "

The maximum number of results to return from this request.

", + "smithy.api#httpQuery": "max-results" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to search.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#GroupSearchFilterList", + "traits": { + "smithy.api#documentation": "

The structure for the search filters that you want to apply to your search.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#SearchGroupsResponse": { + "type": "structure", + "members": { + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", + "traits": { + "smithy.api#documentation": "

A list of groups in a specified namespace that match the filters you set in your SearchGroups request.

" + } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

A pagination token that can be used in a subsequent request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#Seasonality": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 180 + } + } + }, + "com.amazonaws.quicksight#SecondaryValueOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the secondary value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the secondary value of a KPI visual.

" + } + }, + "com.amazonaws.quicksight#SecretArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + }, + "smithy.api#pattern": "^arn:[-a-z0-9]*:secretsmanager:[-a-z0-9]*:[0-9]{12}:secret:.+$" + } + }, + "com.amazonaws.quicksight#SectionAfterPageBreak": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#SectionPageBreakStatus", + "traits": { + "smithy.api#documentation": "

The option that enables or disables a page break at the end of a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a page break after a section.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions": { + "type": "structure", + "members": { + "PaperCanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for the canvas of a section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutConfiguration": { + "type": "structure", + "members": { + "HeaderSections": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of header section configurations.

", + "smithy.api#required": {} + } + }, + "BodySections": { + "target": "com.amazonaws.quicksight#BodySectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of body section configurations.

", + "smithy.api#required": {} + } + }, + "FooterSections": { + "target": "com.amazonaws.quicksight#HeaderFooterSectionConfigurationList", + "traits": { + "smithy.api#documentation": "

A list of footer section configurations.

", + "smithy.api#required": {} + } + }, + "CanvasSizeOptions": { + "target": "com.amazonaws.quicksight#SectionBasedLayoutCanvasSizeOptions", + "traits": { + "smithy.api#documentation": "

The options for the canvas of a section-based layout.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a\n section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionBasedLayoutPaperCanvasSizeOptions": { + "type": "structure", + "members": { + "PaperSize": { + "target": "com.amazonaws.quicksight#PaperSize", + "traits": { + "smithy.api#documentation": "

The paper size that is used to define canvas dimensions.

" + } + }, + "PaperOrientation": { + "target": "com.amazonaws.quicksight#PaperOrientation", + "traits": { + "smithy.api#documentation": "

The paper orientation that\n is used to define canvas dimensions. Choose one of the following\n options:

\n " + } + }, + "PaperMargin": { + "target": "com.amazonaws.quicksight#Spacing", + "traits": { + "smithy.api#documentation": "

Defines the spacing between the canvas content and the top, bottom, left, and right edges.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a paper canvas of a section-based layout.

" + } + }, + "com.amazonaws.quicksight#SectionLayoutConfiguration": { + "type": "structure", + "members": { + "FreeFormLayout": { + "target": "com.amazonaws.quicksight#FreeFormSectionLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The free-form layout configuration of a section.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The layout configuration of a section.

" + } + }, + "com.amazonaws.quicksight#SectionPageBreakConfiguration": { + "type": "structure", + "members": { + "After": { + "target": "com.amazonaws.quicksight#SectionAfterPageBreak", + "traits": { + "smithy.api#documentation": "

The configuration of a page break after a section.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a page break for a section.

" + } + }, + "com.amazonaws.quicksight#SectionPageBreakStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#SectionStyle": { + "type": "structure", + "members": { + "Height": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The height of a section.

\n

Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.

" + } + }, + "Padding": { + "target": "com.amazonaws.quicksight#Spacing", + "traits": { + "smithy.api#documentation": "

The spacing between section content and its top, bottom, left, and right edges.

\n

There is no padding by default.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that style a section.

" + } + }, + "com.amazonaws.quicksight#SecurityGroupId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^sg-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#SecurityGroupIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SecurityGroupId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.quicksight#SelectAllValueOptions": { + "type": "enum", + "members": { + "ALL_VALUES": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VALUES" + } + } + } + }, + "com.amazonaws.quicksight#SelectedFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SelectedFieldOptions": { + "type": "enum", + "members": { + "ALL_FIELDS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_FIELDS" + } + } + } + }, + "com.amazonaws.quicksight#SelectedSheetsFilterScopeConfiguration": { + "type": "structure", + "members": { + "SheetVisualScopingConfigurations": { + "target": "com.amazonaws.quicksight#SheetVisualScopingConfigurations", + "traits": { + "smithy.api#documentation": "

The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

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.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SelectedTooltipType": { + "type": "enum", + "members": { + "BASIC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BASIC" + } + }, + "DETAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DETAILED" + } + } + } + }, + "com.amazonaws.quicksight#SemanticEntityType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic entity type name.

" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic entity sub type name.

" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "

The semantic entity type parameters.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a semantic entity type.

" + } + }, + "com.amazonaws.quicksight#SemanticType": { + "type": "structure", + "members": { + "TypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic type name.

" + } + }, + "SubTypeName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The semantic type sub type name.

" + } + }, + "TypeParameters": { + "target": "com.amazonaws.quicksight#TypeParameters", + "traits": { + "smithy.api#documentation": "

The semantic type parameters.

" + } + }, + "TruthyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The semantic type truthy cell value.

" + } + }, + "TruthyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the true cell value.

" + } + }, + "FalseyCellValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

The semantic type falsey cell value.

" + } + }, + "FalseyCellValueSynonyms": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the false cell value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a semantic type.

" + } + }, + "com.amazonaws.quicksight#SensitiveDouble": { + "type": "double", + "traits": { + "smithy.api#default": 0, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveDoubleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveDouble" + } + }, + "com.amazonaws.quicksight#SensitiveDoubleObject": { + "type": "double", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveLong": { + "type": "long", + "traits": { + "smithy.api#default": 0, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveLongList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveLong" + } + }, + "com.amazonaws.quicksight#SensitiveLongObject": { + "type": "long", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveS3Uri": { + "type": "string", + "traits": { + "smithy.api#pattern": "^(https|s3)://([^/]+)/?(.*)$", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveString": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveStringList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveString" + } + }, + "com.amazonaws.quicksight#SensitiveStringObject": { + "type": "string", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveTimestamp": { + "type": "timestamp", + "traits": { + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SensitiveTimestampList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveTimestamp" + } + }, + "com.amazonaws.quicksight#SeriesItem": { + "type": "structure", + "members": { + "FieldSeriesItem": { + "target": "com.amazonaws.quicksight#FieldSeriesItem", + "traits": { + "smithy.api#documentation": "

The field series item configuration of a line chart.

" + } + }, + "DataFieldSeriesItem": { + "target": "com.amazonaws.quicksight#DataFieldSeriesItem", + "traits": { + "smithy.api#documentation": "

The data field series item configuration of a line chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The series item configuration of a line chart.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#SeriesItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SeriesItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#ServiceNowParameters": { + "type": "structure", + "members": { + "SiteBaseUrl": { + "target": "com.amazonaws.quicksight#SiteBaseUrl", + "traits": { + "smithy.api#documentation": "

URL of the base site.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for ServiceNow.

" + } + }, + "com.amazonaws.quicksight#ServiceType": { + "type": "enum", + "members": { + "REDSHIFT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "REDSHIFT" + } + } + } + }, + "com.amazonaws.quicksight#SessionLifetimeInMinutes": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 15, + "max": 600 + } + } + }, + "com.amazonaws.quicksight#SessionLifetimeInMinutesInvalidException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The number of minutes specified for the lifetime of a session isn't valid. The session\n\t\t\tlifetime must be 15-600 minutes.

", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.quicksight#SessionTag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.quicksight#SessionTagKey", + "traits": { + "smithy.api#documentation": "

The key for the tag.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#SessionTagValue", + "traits": { + "smithy.api#documentation": "

The value that you want to assign the tag.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The key-value pair used for the row-level security tags feature.

" + } + }, + "com.amazonaws.quicksight#SessionTagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#SessionTagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#SessionTagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SessionTag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#SessionTagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#SetParameterValueConfiguration": { + "type": "structure", + "members": { + "DestinationParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The destination parameter name of the SetParameterValueConfiguration.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#DestinationParameterValueConfiguration", + "traits": { + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of adding parameters in action.

" + } + }, + "com.amazonaws.quicksight#SetParameterValueConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SetParameterValueConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#ShapeConditionalFormat": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the shape background color of a filled map visual.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The shape conditional formatting of a filled map visual.

" + } + }, + "com.amazonaws.quicksight#SharedViewConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The shared view settings of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#SharingModel": { + "type": "enum", + "members": { + "ACCOUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCOUNT" + } + }, + "NAMESPACE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NAMESPACE" + } + } + } + }, + "com.amazonaws.quicksight#Sheet": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier associated with a sheet.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#SheetName", + "traits": { + "smithy.api#documentation": "

The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A sheet, which is an object that contains a set of visuals that\n are viewed together on one page in Amazon QuickSight. Every analysis and dashboard\n contains at least one sheet. Each sheet contains at least one visualization widget, for\n example a chart, pivot table, or narrative insight. Sheets can be associated with other\n components, such as controls, filters, and so on.

" + } + }, + "com.amazonaws.quicksight#SheetContentType": { + "type": "enum", + "members": { + "PAGINATED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PAGINATED" + } + }, + "INTERACTIVE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERACTIVE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlDateTimePickerType": { + "type": "enum", + "members": { + "SINGLE_VALUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_VALUED" + } + }, + "DATE_RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of info icon label options.

" + } + }, + "InfoIconText": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconText", + "traits": { + "smithy.api#documentation": "

The text content of info icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A control to display info icons for filters and parameters.

" + } + }, + "com.amazonaws.quicksight#SheetControlInfoIconText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#SheetControlLayout": { + "type": "structure", + "members": { + "Configuration": { + "target": "com.amazonaws.quicksight#SheetControlLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A grid layout to define the placement of sheet control.

" + } + }, + "com.amazonaws.quicksight#SheetControlLayoutConfiguration": { + "type": "structure", + "members": { + "GridLayout": { + "target": "com.amazonaws.quicksight#GridLayoutConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that determines the elements and canvas size options of sheet control.

" + } + }, + "com.amazonaws.quicksight#SheetControlLayoutList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetControlLayout" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SheetControlListType": { + "type": "enum", + "members": { + "MULTI_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_SELECT" + } + }, + "SINGLE_SELECT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_SELECT" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlSliderType": { + "type": "enum", + "members": { + "SINGLE_POINT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_POINT" + } + }, + "RANGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANGE" + } + } + } + }, + "com.amazonaws.quicksight#SheetControlTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#SheetControlsOption": { + "type": "structure", + "members": { + "VisibilityState": { + "target": "com.amazonaws.quicksight#DashboardUIState", + "traits": { + "smithy.api#documentation": "

Visibility state.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Sheet controls option.

" + } + }, + "com.amazonaws.quicksight#SheetDefinition": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The unique identifier of a sheet.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#SheetTitle", + "traits": { + "smithy.api#documentation": "

The title of the sheet.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#SheetDescription", + "traits": { + "smithy.api#documentation": "

A description of the sheet.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#SheetName", + "traits": { + "smithy.api#documentation": "

The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight\n console.

" + } + }, + "ParameterControls": { + "target": "com.amazonaws.quicksight#ParameterControlList", + "traits": { + "smithy.api#documentation": "

The list of parameter controls that are on a sheet.

\n

For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.

" + } + }, + "FilterControls": { + "target": "com.amazonaws.quicksight#FilterControlList", + "traits": { + "smithy.api#documentation": "

The list of filter controls that are on a sheet.

\n

For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.

" + } + }, + "Visuals": { + "target": "com.amazonaws.quicksight#VisualList", + "traits": { + "smithy.api#documentation": "

A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.

" + } + }, + "TextBoxes": { + "target": "com.amazonaws.quicksight#SheetTextBoxList", + "traits": { + "smithy.api#documentation": "

The text boxes that are on a sheet.

" + } + }, + "Layouts": { + "target": "com.amazonaws.quicksight#LayoutList", + "traits": { + "smithy.api#documentation": "

Layouts define how the components of a sheet are arranged.

\n

For more information, see Types of layout in the Amazon QuickSight User Guide.

" + } + }, + "SheetControlLayouts": { + "target": "com.amazonaws.quicksight#SheetControlLayoutList", + "traits": { + "smithy.api#documentation": "

The control layouts of the sheet.

" + } + }, + "ContentType": { + "target": "com.amazonaws.quicksight#SheetContentType", + "traits": { + "smithy.api#documentation": "

The layout content type of the sheet. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

A sheet is an object that contains a set of visuals that\n are viewed together on one page in a paginated report. Every analysis and dashboard must contain at least one sheet.

" + } + }, + "com.amazonaws.quicksight#SheetDefinitionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetDefinition" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SheetDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SheetElementConfigurationOverrides": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the overrides are visible. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

" + } + }, + "com.amazonaws.quicksight#SheetElementRenderingRule": { + "type": "structure", + "members": { + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression of the rendering rules of a sheet.

", + "smithy.api#required": {} + } + }, + "ConfigurationOverrides": { + "target": "com.amazonaws.quicksight#SheetElementConfigurationOverrides", + "traits": { + "smithy.api#documentation": "

The override configuration of the rendering rules of a sheet.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The rendering rules of a sheet that uses a free-form layout.

" + } + }, + "com.amazonaws.quicksight#SheetElementRenderingRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetElementRenderingRule" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10000 + } + } + }, + "com.amazonaws.quicksight#SheetLayoutElementMaximizationOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The status of the sheet layout maximization options of a dashbaord.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sheet layout maximization options of a dashbaord.

" + } + }, + "com.amazonaws.quicksight#SheetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Sheet" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#SheetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#SheetStyle": { + "type": "structure", + "members": { + "Tile": { + "target": "com.amazonaws.quicksight#TileStyle", + "traits": { + "smithy.api#documentation": "

The display options for tiles.

" + } + }, + "TileLayout": { + "target": "com.amazonaws.quicksight#TileLayoutStyle", + "traits": { + "smithy.api#documentation": "

The layout options for tiles.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme display options for sheets.

" + } + }, + "com.amazonaws.quicksight#SheetTextBox": { + "type": "structure", + "members": { + "SheetTextBoxId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#SheetTextBoxContent", + "traits": { + "smithy.api#documentation": "

The content that is displayed in the text box.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A text box.

" + } + }, + "com.amazonaws.quicksight#SheetTextBoxContent": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150000 + } + } + }, + "com.amazonaws.quicksight#SheetTextBoxList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetTextBox" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#SheetTitle": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SheetVisualScopingConfiguration": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The selected sheet that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Scope": { + "target": "com.amazonaws.quicksight#FilterVisualScope", + "traits": { + "smithy.api#documentation": "

The scope of the applied entities. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + }, + "VisualIds": { + "target": "com.amazonaws.quicksight#FilteredVisualsList", + "traits": { + "smithy.api#documentation": "

The selected visuals that the filter is applied to.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The filter that is applied to the options.

" + } + }, + "com.amazonaws.quicksight#SheetVisualScopingConfigurations": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SheetVisualScopingConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#ShortFormatText": { + "type": "structure", + "members": { + "PlainText": { + "target": "com.amazonaws.quicksight#ShortPlainText", + "traits": { + "smithy.api#documentation": "

Plain text format.

" + } + }, + "RichText": { + "target": "com.amazonaws.quicksight#ShortRichText", + "traits": { + "smithy.api#documentation": "

Rich text. Examples of rich text include bold, underline, and italics.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The text format for the title.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#ShortPlainText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#ShortRestrictiveResourceId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#ShortRichText": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SignupResponse": { + "type": "structure", + "members": { + "IAMUser": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that is TRUE if the Amazon QuickSight uses IAM as an\n authentication method.

" + } + }, + "userLoginName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The user login name for your Amazon QuickSight account.

" + } + }, + "accountName": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of your Amazon QuickSight account.

" + } + }, + "directoryType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of Active Directory that is being used to authenticate the Amazon QuickSight\n account. Valid values are SIMPLE_AD, AD_CONNECTOR, and\n MICROSOFT_AD.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A SignupResponse object that contains a summary of a newly created account.

" + } + }, + "com.amazonaws.quicksight#SimpleAttributeAggregationFunction": { + "type": "enum", + "members": { + "UNIQUE_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNIQUE_VALUE" + } + } + } + }, + "com.amazonaws.quicksight#SimpleClusterMarker": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of the simple cluster marker.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The simple cluster marker of the cluster marker.

" + } + }, + "com.amazonaws.quicksight#SimpleNumericalAggregationFunction": { + "type": "enum", + "members": { + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COUNT" + } + }, + "DISTINCT_COUNT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISTINCT_COUNT" + } + }, + "VAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VAR" + } + }, + "VARP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VARP" + } + }, + "STDEV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEV" + } + }, + "STDEVP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STDEVP" + } + }, + "MEDIAN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIAN" + } + } + } + }, + "com.amazonaws.quicksight#SimpleTotalAggregationFunction": { + "type": "enum", + "members": { + "DEFAULT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DEFAULT" + } + }, + "SUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SUM" + } + }, + "AVERAGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVERAGE" + } + }, + "MIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIN" + } + }, + "MAX": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MAX" + } + }, + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + } + } + }, + "com.amazonaws.quicksight#SingleAxisOptions": { + "type": "structure", + "members": { + "YAxisOptions": { + "target": "com.amazonaws.quicksight#YAxisOptions", + "traits": { + "smithy.api#documentation": "

The Y axis options of a single axis configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings of a chart's single axis configuration.

" + } + }, + "com.amazonaws.quicksight#SingleYAxisOption": { + "type": "enum", + "members": { + "PRIMARY_Y_AXIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_Y_AXIS" + } + } + } + }, + "com.amazonaws.quicksight#SiteBaseUrl": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.quicksight#SliderControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#Slot": { + "type": "structure", + "members": { + "SlotId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The slot ID of the slot.

" + } + }, + "VisualId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The visual ID for the slot.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for the slot.

" + } + }, + "com.amazonaws.quicksight#Slots": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Slot" + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisPlacement": { + "type": "enum", + "members": { + "OUTSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OUTSIDE" + } + }, + "INSIDE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INSIDE" + } + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisProperties": { + "type": "structure", + "members": { + "Scale": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisScale", + "traits": { + "smithy.api#documentation": "

Determines whether scale of the axes are shared or independent. The default value is SHARED.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisPlacement", + "traits": { + "smithy.api#documentation": "

Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Configures the properties of a chart's axes that are used by small multiples panels.

" + } + }, + "com.amazonaws.quicksight#SmallMultiplesAxisScale": { + "type": "enum", + "members": { + "SHARED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SHARED" + } + }, + "INDEPENDENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INDEPENDENT" + } + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SmallMultiplesOptions": { + "type": "structure", + "members": { + "MaxVisibleRows": { + "target": "com.amazonaws.quicksight#VisiblePanelRows", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of visible rows to display in the grid of small multiples panels.

\n

The default value is Auto,\n which automatically adjusts the rows in the grid\n to fit the overall layout and size of the given chart.

" + } + }, + "MaxVisibleColumns": { + "target": "com.amazonaws.quicksight#VisiblePanelColumns", + "traits": { + "smithy.api#documentation": "

Sets the maximum number of visible columns to display in the grid of small multiples panels.

\n

The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.

" + } + }, + "PanelConfiguration": { + "target": "com.amazonaws.quicksight#PanelConfiguration", + "traits": { + "smithy.api#documentation": "

Configures the display options for each small multiples panel.

" + } + }, + "XAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples X axis.

" + } + }, + "YAxis": { + "target": "com.amazonaws.quicksight#SmallMultiplesAxisProperties", + "traits": { + "smithy.api#documentation": "

The properties of a small multiples Y axis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Options that determine the layout and display options of a chart's small multiples.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUser": { + "type": "structure", + "members": { + "RowLevelPermissionTags": { + "target": "com.amazonaws.quicksight#SessionTagList", + "traits": { + "smithy.api#documentation": "

The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call.

\n

These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the anonymous user configuration.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUser" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted": { + "type": "structure", + "members": { + "RowLevelPermissionTagKeys": { + "target": "com.amazonaws.quicksight#SessionTagKeyList", + "traits": { + "smithy.api#documentation": "

The tag keys for the RowLevelPermissionTags.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Use this structure to redact sensitive information that you provide about an anonymous user from the snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedacted" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotConfiguration": { + "type": "structure", + "members": { + "FileGroups": { + "target": "com.amazonaws.quicksight#SnapshotFileGroupList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.

", + "smithy.api#required": {} + } + }, + "DestinationConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotDestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.

" + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters" + } + }, + "traits": { + "smithy.api#documentation": "

Describes the configuration of the dashboard snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotDestinationConfiguration": { + "type": "structure", + "members": { + "S3Destinations": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList", + "traits": { + "smithy.api#documentation": "

\n A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the Amazon S3 destinations of the generated snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotFile": { + "type": "structure", + "members": { + "SheetSelections": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.

", + "smithy.api#required": {} + } + }, + "FormatType": { + "target": "com.amazonaws.quicksight#SnapshotFileFormatType", + "traits": { + "smithy.api#documentation": "

The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the information for the snapshot that you want to generate. This information is provided by you when you start a new snapshot job.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileFormatType": { + "type": "enum", + "members": { + "CSV": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CSV" + } + }, + "PDF": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PDF" + } + }, + "EXCEL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXCEL" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotFileGroup": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.quicksight#SnapshotFileList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains the information on the snapshot files.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFileGroup" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 7 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFile" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelection": { + "type": "structure", + "members": { + "SheetId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.

", + "smithy.api#required": {} + } + }, + "SelectionScope": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope", + "traits": { + "smithy.api#documentation": "

The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options.

\n ", + "smithy.api#required": {} + } + }, + "VisualIds": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList", + "traits": { + "smithy.api#documentation": "

\n A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information that identifies the snapshot that needs to be generated.

" + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotFileSheetSelection" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionScope": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + }, + "SELECTED_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SELECTED_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotFileSheetSelectionVisualIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 5 + } + } + }, + "com.amazonaws.quicksight#SnapshotJobErrorInfo": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that contains information on the error that caused the snapshot job to fail.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResult": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#AnonymousUserSnapshotJobResultList", + "traits": { + "smithy.api#documentation": "

A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An object that provides information on the result of a snapshot job. This object provides information about the job, the job status, and the location of the generated file.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultErrorInfo": { + "type": "structure", + "members": { + "ErrorMessage": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + }, + "ErrorType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The error type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information on the error that caused the snapshot job to fail.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfo" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultFileGroup": { + "type": "structure", + "members": { + "Files": { + "target": "com.amazonaws.quicksight#SnapshotFileList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotFile objects.

" + } + }, + "S3Results": { + "target": "com.amazonaws.quicksight#SnapshotJobS3ResultList", + "traits": { + "smithy.api#documentation": "

A list of SnapshotJobS3Result objects.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information on the generated snapshot file groups.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobResultFileGroupList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobResultFileGroup" + } + }, + "com.amazonaws.quicksight#SnapshotJobS3Result": { + "type": "structure", + "members": { + "S3DestinationConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration", + "traits": { + "smithy.api#documentation": "

A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.\n

" + } + }, + "S3Uri": { + "target": "com.amazonaws.quicksight#SensitiveS3Uri", + "traits": { + "smithy.api#documentation": "

The Amazon S3 Uri.

" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#SnapshotJobResultErrorInfoList", + "traits": { + "smithy.api#documentation": "

An array of error records that describe any failures that occur while the dashboard snapshot job runs.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The Amazon S3 result from the snapshot job. The result includes the DestinationConfiguration and the Amazon S3 Uri. If an error occured during the job, the result returns information on the error.

" + } + }, + "com.amazonaws.quicksight#SnapshotJobS3ResultList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotJobS3Result" + } + }, + "com.amazonaws.quicksight#SnapshotJobStatus": { + "type": "enum", + "members": { + "QUEUED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUEUED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + } + } + }, + "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration": { + "type": "structure", + "members": { + "BucketConfiguration": { + "target": "com.amazonaws.quicksight#S3BucketConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the Amazon S3 settings to use to save the generated dashboard snapshot.

" + } + }, + "com.amazonaws.quicksight#SnapshotS3DestinationConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SnapshotS3DestinationConfiguration" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#SnapshotUserConfiguration": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserList", + "traits": { + "smithy.api#documentation": "

An array of records that describe the anonymous users that the dashboard snapshot is generated for.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for.

" + } + }, + "com.amazonaws.quicksight#SnapshotUserConfigurationRedacted": { + "type": "structure", + "members": { + "AnonymousUsers": { + "target": "com.amazonaws.quicksight#SnapshotAnonymousUserRedactedList", + "traits": { + "smithy.api#documentation": "

\n An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that contains information about the users that the dashboard snapshot is generated for. Sensitive user information is excluded.\n

" + } + }, + "com.amazonaws.quicksight#SnowflakeParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + }, + "Warehouse": { + "target": "com.amazonaws.quicksight#Warehouse", + "traits": { + "smithy.api#documentation": "

Warehouse.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Snowflake.

" + } + }, + "com.amazonaws.quicksight#SortDirection": { + "type": "enum", + "members": { + "ASC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASC" + } + }, + "DESC": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESC" + } + } + } + }, + "com.amazonaws.quicksight#Spacing": { + "type": "structure", + "members": { + "Top": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the top spacing.

" + } + }, + "Bottom": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the bottom spacing.

" + } + }, + "Left": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the left spacing.

" + } + }, + "Right": { + "target": "com.amazonaws.quicksight#Length", + "traits": { + "smithy.api#documentation": "

Define the right spacing.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of spacing (often a margin or padding).

" + } + }, + "com.amazonaws.quicksight#SparkParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Spark.

" + } + }, + "com.amazonaws.quicksight#SpecialValue": { + "type": "enum", + "members": { + "EMPTY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPTY" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + }, + "OTHER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "OTHER" + } + } + } + }, + "com.amazonaws.quicksight#SqlEndpointPath": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 4096 + } + } + }, + "com.amazonaws.quicksight#SqlQuery": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 168000 + } + } + }, + "com.amazonaws.quicksight#SqlServerParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for SQL Server.

" + } + }, + "com.amazonaws.quicksight#SslProperties": { + "type": "structure", + "members": { + "DisableSsl": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean option to control whether SSL should be disabled.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your\n underlying data source.

" + } + }, + "com.amazonaws.quicksight#StarburstParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Starburst data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Starburst data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

The catalog name for the Starburst data source.

", + "smithy.api#required": {} + } + }, + "ProductType": { + "target": "com.amazonaws.quicksight#StarburstProductType", + "traits": { + "smithy.api#documentation": "

The product type for the Starburst data source.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Starburst data source.

" + } + }, + "com.amazonaws.quicksight#StarburstProductType": { + "type": "enum", + "members": { + "GALAXY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "GALAXY" + } + }, + "ENTERPRISE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENTERPRISE" + } + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartAssetBundleExportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Asset Bundle export job.

\n

An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently.

\n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/asset-bundle-export-jobs/export", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account to export assets from.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", + "smithy.api#required": {} + } + }, + "ResourceArns": { + "target": "com.amazonaws.quicksight#AssetBundleResourceArns", + "traits": { + "smithy.api#documentation": "

An array of resource ARNs to export. The following resources are supported.

\n \n

The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.

", + "smithy.api#required": {} + } + }, + "IncludeAllDependencies": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all dependencies of each resource ARN are recursively\n exported with the job. For example, say you provided a Dashboard ARN to the\n ResourceArns parameter. If you set IncludeAllDependencies to\n TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also\n exported.

" + } + }, + "ExportFormat": { + "target": "com.amazonaws.quicksight#AssetBundleExportFormat", + "traits": { + "smithy.api#documentation": "

The export data format.

", + "smithy.api#required": {} + } + }, + "CloudFormationOverridePropertyConfiguration": { + "target": "com.amazonaws.quicksight#AssetBundleCloudFormationOverridePropertyConfiguration", + "traits": { + "smithy.api#documentation": "

An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template.

\n

Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.

" + } + }, + "IncludePermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.\n

" + } + }, + "IncludeTags": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleExportJobValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleExportJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the export job.

" + } + }, + "AssetBundleExportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartAssetBundleImportJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an Asset Bundle import job.

\n

An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently.

\n

The API caller must have the necessary \"create\", \"describe\", and \"update\" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/asset-bundle-import-jobs/import", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account to import assets into.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

", + "smithy.api#required": {} + } + }, + "AssetBundleImportSource": { + "target": "com.amazonaws.quicksight#AssetBundleImportSource", + "traits": { + "smithy.api#documentation": "

The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.\n

", + "smithy.api#required": {} + } + }, + "OverrideParameters": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideParameters", + "traits": { + "smithy.api#documentation": "

Optional overrides that are applied to the resource configuration before import.

" + } + }, + "FailureAction": { + "target": "com.amazonaws.quicksight#AssetBundleImportFailureAction", + "traits": { + "smithy.api#documentation": "

The failure action for the import job.

\n

If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job.

\n

If you choose DO_NOTHING, failed import jobs will not attempt to roll back\n any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.

" + } + }, + "OverridePermissions": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverridePermissions", + "traits": { + "smithy.api#documentation": "

Optional permission overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideTags": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideTags", + "traits": { + "smithy.api#documentation": "

Optional tag overrides that are applied to the resource configuration before import.

" + } + }, + "OverrideValidationStrategy": { + "target": "com.amazonaws.quicksight#AssetBundleImportJobOverrideValidationStrategy", + "traits": { + "smithy.api#documentation": "

An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartAssetBundleImportJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the import job.

" + } + }, + "AssetBundleImportJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services response ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the response.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" }, - "com.amazonaws.quicksight#WordCloudSortConfiguration": { - "type": "structure", - "members": { - "CategoryItemsLimit": { - "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", - "traits": { - "smithy.api#documentation": "

The limit on the number of groups that are displayed in a word cloud.

" - } - }, - "CategorySort": { - "target": "com.amazonaws.quicksight#FieldSortOptionsList", - "traits": { - "smithy.api#documentation": "

The sort configuration of group by fields.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" - } + { + "target": "com.amazonaws.quicksight#InternalFailureException" }, - "com.amazonaws.quicksight#WordCloudVisual": { - "type": "structure", - "members": { - "VisualId": { - "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", - "traits": { - "smithy.api#documentation": "

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..

", - "smithy.api#required": {} - } - }, - "Title": { - "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The title that is displayed on the visual.

" - } - }, - "Subtitle": { - "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", - "traits": { - "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" - } - }, - "ChartConfiguration": { - "target": "com.amazonaws.quicksight#WordCloudChartConfiguration", - "traits": { - "smithy.api#documentation": "

The configuration settings of the visual.

" - } - }, - "Actions": { - "target": "com.amazonaws.quicksight#VisualCustomActionList", - "traits": { - "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" - } - }, - "ColumnHierarchies": { - "target": "com.amazonaws.quicksight#ColumnHierarchyList", - "traits": { - "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" - } - } - }, - "traits": { - "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" - } + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" }, - "com.amazonaws.quicksight#WordCloudWordCasing": { - "type": "enum", - "members": { - "LOWER_CASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LOWER_CASE" - } - }, - "EXISTING_CASE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EXISTING_CASE" - } - } - } + { + "target": "com.amazonaws.quicksight#LimitExceededException" }, - "com.amazonaws.quicksight#WordCloudWordOrientation": { - "type": "enum", - "members": { - "HORIZONTAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL" - } - }, - "HORIZONTAL_AND_VERTICAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "HORIZONTAL_AND_VERTICAL" - } - } - } + { + "target": "com.amazonaws.quicksight#ResourceExistsException" }, - "com.amazonaws.quicksight#WordCloudWordPadding": { - "type": "enum", - "members": { - "NONE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NONE" - } - }, - "SMALL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "SMALL" - } - }, - "MEDIUM": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "MEDIUM" - } - }, - "LARGE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "LARGE" - } - } - } + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, - "com.amazonaws.quicksight#WordCloudWordScaling": { - "type": "enum", - "members": { - "EMPHASIZE": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "EMPHASIZE" - } - }, - "NORMAL": { - "target": "smithy.api#Unit", - "traits": { - "smithy.api#enumValue": "NORMAL" - } - } - } + { + "target": "com.amazonaws.quicksight#ThrottlingException" }, - "com.amazonaws.quicksight#WorkGroup": { - "type": "string", - "traits": { - "smithy.api#length": { - "min": 1, - "max": 128 - } - } + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" }, - "com.amazonaws.quicksight#YAxisOptions": { - "type": "structure", - "members": { - "YAxis": { - "target": "com.amazonaws.quicksight#SingleYAxisOption", - "traits": { - "smithy.api#documentation": "

The Y axis type to be used in the chart.

\n

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

", - "smithy.api#required": {} - } - } - }, - "traits": { - "smithy.api#documentation": "

The options that are available for a single Y axis in a chart.

" - } + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call.

\n \n

The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred.

\n

\n StartDashboardSnapshotJob API throttling\n

\n

Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users.

\n

\n Common throttling scenarios\n

\n

The following list provides information about the most commin throttling scenarios that can occur.

\n \n

If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account.

\n

\n Best practices to handle throttling\n

\n

If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline.

\n

The time that it takes to process a job can be impacted by the following factors:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/snapshot-jobs", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dashboard that you want to start a snapshot job for.\n

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.

", + "smithy.api#required": {} + } + }, + "UserConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotUserConfiguration", + "traits": { + "smithy.api#documentation": "

\n A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.

", + "smithy.api#required": {} + } + }, + "SnapshotConfiguration": { + "target": "com.amazonaws.quicksight#SnapshotConfiguration", + "traits": { + "smithy.api#documentation": "

A structure that describes the configuration of the dashboard snapshot.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#StartDashboardSnapshotJobResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the dashboard snapshot job.

" + } + }, + "SnapshotJobId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

\n The Amazon Web Services request ID for this operation.\n

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#StatePersistenceConfigurations": { + "type": "structure", + "members": { + "Enabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The state perssitence configuration of an embedded dashboard.

" + } + }, + "com.amazonaws.quicksight#Status": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#StatusCode": { + "type": "integer", + "traits": { + "smithy.api#default": 0 + } + }, + "com.amazonaws.quicksight#String": { + "type": "string" + }, + "com.amazonaws.quicksight#StringDatasetParameter": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.quicksight#DatasetParameterId", + "traits": { + "smithy.api#documentation": "

An identifier for the string parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DatasetParameterName", + "traits": { + "smithy.api#documentation": "

The name of the string parameter that is created in the dataset.

", + "smithy.api#required": {} + } + }, + "ValueType": { + "target": "com.amazonaws.quicksight#DatasetParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type of the dataset parameter. Valid values are single value or multi value.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValues", + "traits": { + "smithy.api#documentation": "

A list of default values for a given string dataset parameter type. This structure only accepts static values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A string parameter for a dataset.

" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValue": { + "type": "string", + "traits": { + "smithy.api#documentation": "

The default value for the string parameter.

", + "smithy.api#length": { + "min": 0, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#StringDatasetParameterDefaultValues": { + "type": "structure", + "members": { + "StaticValues": { + "target": "com.amazonaws.quicksight#StringDatasetParameterValueList", + "traits": { + "smithy.api#documentation": "

A list of static default values for a given string parameter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of a string parameter.

" + } + }, + "com.amazonaws.quicksight#StringDatasetParameterValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StringDatasetParameterDefaultValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#StringDefaultValueList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SensitiveStringObject" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50000 + } + } + }, + "com.amazonaws.quicksight#StringDefaultValues": { + "type": "structure", + "members": { + "DynamicValue": { + "target": "com.amazonaws.quicksight#DynamicDefaultValue", + "traits": { + "smithy.api#documentation": "

The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.

" + } + }, + "StaticValues": { + "target": "com.amazonaws.quicksight#StringDefaultValueList", + "traits": { + "smithy.api#documentation": "

The static values of the DecimalDefaultValues.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The default values of the StringParameterDeclaration.

" + } + }, + "com.amazonaws.quicksight#StringFormatConfiguration": { + "type": "structure", + "members": { + "NullValueFormatConfiguration": { + "target": "com.amazonaws.quicksight#NullValueFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The options that determine the null value format configuration.

" + } + }, + "NumericFormatConfiguration": { + "target": "com.amazonaws.quicksight#NumericFormatConfiguration", + "traits": { + "smithy.api#documentation": "

The formatting configuration for numeric strings.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Formatting configuration for string fields.

" + } + }, + "com.amazonaws.quicksight#StringList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + } + }, + "com.amazonaws.quicksight#StringParameter": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

A display name for a string parameter.

", + "smithy.api#required": {} + } + }, + "Values": { + "target": "com.amazonaws.quicksight#SensitiveStringList", + "traits": { + "smithy.api#documentation": "

The values of a string parameter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A string parameter.

" + } + }, + "com.amazonaws.quicksight#StringParameterDeclaration": { + "type": "structure", + "members": { + "ParameterValueType": { + "target": "com.amazonaws.quicksight#ParameterValueType", + "traits": { + "smithy.api#documentation": "

The value type determines whether the parameter is a single-value or multi-value parameter.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The name of the parameter that is being declared.

", + "smithy.api#required": {} + } + }, + "DefaultValues": { + "target": "com.amazonaws.quicksight#StringDefaultValues", + "traits": { + "smithy.api#documentation": "

The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.

" + } + }, + "ValueWhenUnset": { + "target": "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" + } + }, + "MappedDataSetParameters": { + "target": "com.amazonaws.quicksight#MappedDataSetParameters" + } + }, + "traits": { + "smithy.api#documentation": "

A parameter declaration for the String data type.

" + } + }, + "com.amazonaws.quicksight#StringParameterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#StringParameter" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#StringValueWhenUnsetConfiguration": { + "type": "structure", + "members": { + "ValueWhenUnsetOption": { + "target": "com.amazonaws.quicksight#ValueWhenUnsetOption", + "traits": { + "smithy.api#documentation": "

The built-in options for default values. The value can be one of the following:

\n " + } + }, + "CustomValue": { + "target": "com.amazonaws.quicksight#SensitiveString", + "traits": { + "smithy.api#documentation": "

A custom value that's used when the value of a parameter isn't set.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration that defines the default value of a String parameter when a value has not been set.

" + } + }, + "com.amazonaws.quicksight#StyledCellType": { + "type": "enum", + "members": { + "TOTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOTAL" + } + }, + "METRIC_HEADER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "METRIC_HEADER" + } + }, + "VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VALUE" + } + } + } + }, + "com.amazonaws.quicksight#SubnetId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^subnet-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#SubnetIdList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SubnetId" + }, + "traits": { + "smithy.api#length": { + "min": 2, + "max": 15 + } + } + }, + "com.amazonaws.quicksight#SubtotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the subtotal cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the subtotal cells.

" + } + }, + "FieldLevel": { + "target": "com.amazonaws.quicksight#PivotTableSubtotalLevel", + "traits": { + "smithy.api#documentation": "

The field level (all, custom, last) for the subtotal cells.

" + } + }, + "FieldLevelOptions": { + "target": "com.amazonaws.quicksight#PivotTableFieldSubtotalOptionsList", + "traits": { + "smithy.api#documentation": "

The optional configuration of subtotal cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotal cells.

" + } + }, + "ValueCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotals of value cells.

" + } + }, + "MetricHeaderCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The cell styling options for the subtotals of header cells.

" + } + }, + "StyleTargets": { + "target": "com.amazonaws.quicksight#TableStyleTargetList", + "traits": { + "smithy.api#documentation": "

The style targets options for subtotals.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The subtotal options.

" + } + }, + "com.amazonaws.quicksight#SucceededTopicReviewedAnswer": { + "type": "structure", + "members": { + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID for the SucceededTopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a SucceededTopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#SucceededTopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SucceededTopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry" + } + }, + "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntry": { + "type": "structure", + "members": { + "KeyArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the KMS key that is associated with the SuccessfulKeyRegistrationEntry entry.

", + "smithy.api#required": {} + } + }, + "StatusCode": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of a SuccessfulKeyRegistrationEntry entry.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A success entry that occurs when a KeyRegistration job is successfully applied to the Amazon QuickSight account.

" + } + }, + "com.amazonaws.quicksight#Suffix": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#Synonyms": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#TableAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well for a pivot table. Values are grouped by group by fields.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field well for the table.

" + } + }, + "com.amazonaws.quicksight#TableBorderOptions": { + "type": "structure", + "members": { + "Color": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of a table border.

" + } + }, + "Thickness": { + "target": "com.amazonaws.quicksight#TableBorderThickness", + "traits": { + "smithy.api#documentation": "

The thickness of a table border.

" + } + }, + "Style": { + "target": "com.amazonaws.quicksight#TableBorderStyle", + "traits": { + "smithy.api#documentation": "

The style (none, solid) of a table border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The border options for a table border.

" + } + }, + "com.amazonaws.quicksight#TableBorderStyle": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SOLID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOLID" + } + } + } + }, + "com.amazonaws.quicksight#TableBorderThickness": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 4 + } + } + }, + "com.amazonaws.quicksight#TableCellConditionalFormatting": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID of the cell for conditional formatting.

", + "smithy.api#required": {} + } + }, + "TextFormat": { + "target": "com.amazonaws.quicksight#TextConditionalFormat", + "traits": { + "smithy.api#documentation": "

The text format of the cell for conditional formatting.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a table.

" + } + }, + "com.amazonaws.quicksight#TableCellImageScalingConfiguration": { + "type": "enum", + "members": { + "FIT_TO_CELL_HEIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_CELL_HEIGHT" + } + }, + "FIT_TO_CELL_WIDTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FIT_TO_CELL_WIDTH" + } + }, + "DO_NOT_SCALE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DO_NOT_SCALE" + } + } + } + }, + "com.amazonaws.quicksight#TableCellImageSizingConfiguration": { + "type": "structure", + "members": { + "TableCellImageScalingConfiguration": { + "target": "com.amazonaws.quicksight#TableCellImageScalingConfiguration", + "traits": { + "smithy.api#documentation": "

The cell scaling configuration of the sizing options for the table image configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sizing options for the table image configuration.

" + } + }, + "com.amazonaws.quicksight#TableCellStyle": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the table cells.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the table cells.

" + } + }, + "TextWrap": { + "target": "com.amazonaws.quicksight#TextWrap", + "traits": { + "smithy.api#documentation": "

The text wrap (none, wrap) for the table cells.

" + } + }, + "HorizontalTextAlignment": { + "target": "com.amazonaws.quicksight#HorizontalTextAlignment", + "traits": { + "smithy.api#documentation": "

The horizontal text alignment (left, center, right, auto) for the table cells.

" + } + }, + "VerticalTextAlignment": { + "target": "com.amazonaws.quicksight#VerticalTextAlignment", + "traits": { + "smithy.api#documentation": "

The vertical text alignment (top, middle, bottom) for the table cells.

" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color for the table cells.

" + } + }, + "Height": { + "target": "com.amazonaws.quicksight#TableFieldHeight", + "traits": { + "smithy.api#documentation": "

The height color for the table cells.

" + } + }, + "Border": { + "target": "com.amazonaws.quicksight#GlobalTableBorderOptions", + "traits": { + "smithy.api#documentation": "

The borders for the table cells.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table cell style for a cell in pivot table or table visual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormatting": { + "type": "structure", + "members": { + "ConditionalFormattingOptions": { + "target": "com.amazonaws.quicksight#TableConditionalFormattingOptionList", + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormattingOption": { + "type": "structure", + "members": { + "Cell": { + "target": "com.amazonaws.quicksight#TableCellConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The cell conditional formatting option for a table.

" + } + }, + "Row": { + "target": "com.amazonaws.quicksight#TableRowConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The row conditional formatting option for a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Conditional formatting options for a PivotTableVisual.

" + } + }, + "com.amazonaws.quicksight#TableConditionalFormattingOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableConditionalFormattingOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#TableConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#TableFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#TableSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration for a TableVisual.

" + } + }, + "TableOptions": { + "target": "com.amazonaws.quicksight#TableOptions", + "traits": { + "smithy.api#documentation": "

The table options for a table visual.

" + } + }, + "TotalOptions": { + "target": "com.amazonaws.quicksight#TotalOptions", + "traits": { + "smithy.api#documentation": "

The total options for a table visual.

" + } + }, + "FieldOptions": { + "target": "com.amazonaws.quicksight#TableFieldOptions", + "traits": { + "smithy.api#documentation": "

The field options for a table visual.

" + } + }, + "PaginatedReportOptions": { + "target": "com.amazonaws.quicksight#TablePaginatedReportOptions", + "traits": { + "smithy.api#documentation": "

The paginated report options for a table visual.

" + } + }, + "TableInlineVisualizations": { + "target": "com.amazonaws.quicksight#TableInlineVisualizationList", + "traits": { + "smithy.api#documentation": "

A collection of inline visualizations to display within a chart.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a TableVisual.

" + } + }, + "com.amazonaws.quicksight#TableFieldCustomIconContent": { + "type": "structure", + "members": { + "Icon": { + "target": "com.amazonaws.quicksight#TableFieldIconSetType", + "traits": { + "smithy.api#documentation": "

The icon set type (link) of the custom icon content for table URL link content.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldCustomTextContent": { + "type": "structure", + "members": { + "Value": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The string value of the custom text content for the table URL link content.

" + } + }, + "FontConfiguration": { + "target": "com.amazonaws.quicksight#FontConfiguration", + "traits": { + "smithy.api#documentation": "

The font configuration of the custom text content for the table URL link content.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldHeight": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 8, + "max": 500 + } + } + }, + "com.amazonaws.quicksight#TableFieldIconSetType": { + "type": "enum", + "members": { + "LINK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINK" + } + } + } + }, + "com.amazonaws.quicksight#TableFieldImageConfiguration": { + "type": "structure", + "members": { + "SizingOptions": { + "target": "com.amazonaws.quicksight#TableCellImageSizingConfiguration", + "traits": { + "smithy.api#documentation": "

The sizing options for the table image configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The image configuration of a table field URL.

" + } + }, + "com.amazonaws.quicksight#TableFieldLinkConfiguration": { + "type": "structure", + "members": { + "Target": { + "target": "com.amazonaws.quicksight#URLTargetConfiguration", + "traits": { + "smithy.api#documentation": "

The URL target (new tab, new window, same tab) for the table link configuration.

", + "smithy.api#required": {} + } + }, + "Content": { + "target": "com.amazonaws.quicksight#TableFieldLinkContentConfiguration", + "traits": { + "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The link configuration of a table field URL.

" + } + }, + "com.amazonaws.quicksight#TableFieldLinkContentConfiguration": { + "type": "structure", + "members": { + "CustomTextContent": { + "target": "com.amazonaws.quicksight#TableFieldCustomTextContent", + "traits": { + "smithy.api#documentation": "

The custom text content (value, font configuration) for the table link content configuration.

" + } + }, + "CustomIconContent": { + "target": "com.amazonaws.quicksight#TableFieldCustomIconContent", + "traits": { + "smithy.api#documentation": "

The custom icon content for the table link content configuration.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL content (text, icon) for the table link configuration.

" + } + }, + "com.amazonaws.quicksight#TableFieldOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field ID for a table field.

", + "smithy.api#required": {} + } + }, + "Width": { + "target": "com.amazonaws.quicksight#PixelLength", + "traits": { + "smithy.api#documentation": "

The width for a table field.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#CustomLabel", + "traits": { + "smithy.api#documentation": "

The custom label for a table field.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of a table field.

" + } + }, + "URLStyling": { + "target": "com.amazonaws.quicksight#TableFieldURLConfiguration", + "traits": { + "smithy.api#documentation": "

The URL configuration for a table field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options for a table field.

" + } + }, + "com.amazonaws.quicksight#TableFieldOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableFieldOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TableFieldOptions": { + "type": "structure", + "members": { + "SelectedFieldOptions": { + "target": "com.amazonaws.quicksight#TableFieldOptionList", + "traits": { + "smithy.api#documentation": "

The field options to be configured to a table.

" + } + }, + "Order": { + "target": "com.amazonaws.quicksight#FieldOrderList", + "traits": { + "smithy.api#documentation": "

The order of the field IDs that are configured as field options for a table visual.

" + } + }, + "PinnedFieldOptions": { + "target": "com.amazonaws.quicksight#TablePinnedFieldOptions", + "traits": { + "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field options of a table visual.

" + } + }, + "com.amazonaws.quicksight#TableFieldOrderList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#FieldId" + }, + "traits": { + "smithy.api#documentation": "

A list of table field IDs.

", + "smithy.api#length": { + "min": 0, + "max": 201 + } + } + }, + "com.amazonaws.quicksight#TableFieldURLConfiguration": { + "type": "structure", + "members": { + "LinkConfiguration": { + "target": "com.amazonaws.quicksight#TableFieldLinkConfiguration", + "traits": { + "smithy.api#documentation": "

The link configuration of a table field URL.

" + } + }, + "ImageConfiguration": { + "target": "com.amazonaws.quicksight#TableFieldImageConfiguration", + "traits": { + "smithy.api#documentation": "

The image configuration of a table field URL.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The URL configuration for a table field.

" + } + }, + "com.amazonaws.quicksight#TableFieldWells": { + "type": "structure", + "members": { + "TableAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TableAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field well for the table.

" + } + }, + "TableUnaggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TableUnaggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The unaggregated field well for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells for a table visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TableInlineVisualization": { + "type": "structure", + "members": { + "DataBars": { + "target": "com.amazonaws.quicksight#DataBarsOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the inline visualization of the data bars within a chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The inline visualization of a specific type to display within a chart.

" + } + }, + "com.amazonaws.quicksight#TableInlineVisualizationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableInlineVisualization" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TableOptions": { + "type": "structure", + "members": { + "Orientation": { + "target": "com.amazonaws.quicksight#TableOrientation", + "traits": { + "smithy.api#documentation": "

The orientation (vertical, horizontal) for a table.

" + } + }, + "HeaderStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of a table header.

" + } + }, + "CellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

The table cell style of table cells.

" + } + }, + "RowAlternateColorOptions": { + "target": "com.amazonaws.quicksight#RowAlternateColorOptions", + "traits": { + "smithy.api#documentation": "

The row alternate color options (widget status, row alternate colors) for a table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The table options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TableOrientation": { + "type": "enum", + "members": { + "VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VERTICAL" + } + }, + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + } + } + }, + "com.amazonaws.quicksight#TablePaginatedReportOptions": { + "type": "structure", + "members": { + "VerticalOverflowVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of printing table overflow across pages.

" + } + }, + "OverflowColumnHeaderVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of repeating header rows on each page.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The paginated report options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TablePinnedFieldOptions": { + "type": "structure", + "members": { + "PinnedLeftFields": { + "target": "com.amazonaws.quicksight#TableFieldOrderList", + "traits": { + "smithy.api#documentation": "

A list of columns to be pinned to the left of a table visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The settings for the pinned columns of a table visual.

" + } + }, + "com.amazonaws.quicksight#TableRowConditionalFormatting": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the background for a table row.

" + } + }, + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting color (solid, gradient) of the text for a table row.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting of a table row.

" + } + }, + "com.amazonaws.quicksight#TableSideBorderOptions": { + "type": "structure", + "members": { + "InnerVertical": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the inner vertical border.

" + } + }, + "InnerHorizontal": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the inner horizontal border.

" + } + }, + "Left": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the left border.

" + } + }, + "Right": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the right border.

" + } + }, + "Top": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the top border.

" + } + }, + "Bottom": { + "target": "com.amazonaws.quicksight#TableBorderOptions", + "traits": { + "smithy.api#documentation": "

The table border options of the bottom border.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The side border options for a table.

" + } + }, + "com.amazonaws.quicksight#TableSortConfiguration": { + "type": "structure", + "members": { + "RowSort": { + "target": "com.amazonaws.quicksight#RowSortList", + "traits": { + "smithy.api#documentation": "

The field sort options for rows in the table.

" + } + }, + "PaginationConfiguration": { + "target": "com.amazonaws.quicksight#PaginationConfiguration", + "traits": { + "smithy.api#documentation": "

The pagination configuration (page size, page number) for the table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration for a TableVisual.

" + } + }, + "com.amazonaws.quicksight#TableStyleTarget": { + "type": "structure", + "members": { + "CellType": { + "target": "com.amazonaws.quicksight#StyledCellType", + "traits": { + "smithy.api#documentation": "

The cell type of the table style target.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The table style target.

" + } + }, + "com.amazonaws.quicksight#TableStyleTargetList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TableStyleTarget" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 3 + } + } + }, + "com.amazonaws.quicksight#TableTotalsPlacement": { + "type": "enum", + "members": { + "START": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "START" + } + }, + "END": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "END" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#TableTotalsScrollStatus": { + "type": "enum", + "members": { + "PINNED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PINNED" + } + }, + "SCROLLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SCROLLED" + } + } + } + }, + "com.amazonaws.quicksight#TableUnaggregatedFieldWells": { + "type": "structure", + "members": { + "Values": { + "target": "com.amazonaws.quicksight#UnaggregatedFieldList", + "traits": { + "smithy.api#documentation": "

The values field well for a pivot table. Values are unaggregated for an unaggregated table.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field well for the table.

" + } + }, + "com.amazonaws.quicksight#TableVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#TableConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "ConditionalFormatting": { + "target": "com.amazonaws.quicksight#TableConditionalFormatting", + "traits": { + "smithy.api#documentation": "

The conditional formatting for a PivotTableVisual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#Tag": { + "type": "structure", + "members": { + "Key": { + "target": "com.amazonaws.quicksight#TagKey", + "traits": { + "smithy.api#documentation": "

Tag key.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#TagValue", + "traits": { + "smithy.api#documentation": "

Tag value.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The key or keys of the key-value pairs for the resource tag or tags assigned to the\n resource.

" + } + }, + "com.amazonaws.quicksight#TagColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The column that this operation acts on.

", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#ColumnTagList", + "traits": { + "smithy.api#documentation": "

The dataset column tag, currently only used for geospatial type tagging.

\n \n

This is not tags for the Amazon Web Services tagging feature.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that tags a column with additional information.

" + } + }, + "com.amazonaws.quicksight#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TagList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Tag" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource.

\n

Tags can help you organize and categorize your resources. You can also use them to\n\t\t\tscope user permissions, by granting a user permission to access or change only resources\n\t\t\twith certain tag values. You can use the TagResource operation with a\n\t\t\tresource that already has tags. If you specify a new tag key for the resource, this tag\n\t\t\tis appended to the list of tags associated with the resource. If you specify a tag key\n\t\t\tthat is already associated with the resource, the new tag value that you specify\n\t\t\treplaces the previous value for that tag.

\n

You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, template, topic, and user.

\n

Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for\n\t\t\tthe following:

\n ", + "smithy.api#http": { + "method": "POST", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to tag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "

Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#TagResourceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#TargetVisualList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#TargetVisualOptions": { + "type": "enum", + "members": { + "ALL_VISUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL_VISUALS" + } + } + } + }, + "com.amazonaws.quicksight#Template": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The display name of the template.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#TemplateVersion", + "traits": { + "smithy.api#documentation": "

A structure describing the versions of the template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when this was last updated.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

Time when this was created.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A template object. A template is an entity in Amazon QuickSight that\n encapsulates the metadata required to create an analysis and that you can use to create\n a dashboard. A template adds a layer of abstraction by using placeholders to replace the\n dataset associated with an analysis. You can use templates to create dashboards by\n replacing dataset placeholders with datasets that follow the same schema that was used\n to create the source analysis and template.

\n

You can share templates across Amazon Web Services accounts by allowing users in other Amazon Web Services accounts to\n create a template or a dashboard from an existing template.

" + } + }, + "com.amazonaws.quicksight#TemplateAlias": { + "type": "structure", + "members": { + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The display name of the template alias.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template alias.

" + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template alias.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template alias.

" + } + }, + "com.amazonaws.quicksight#TemplateAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateAlias" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TemplateError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#TemplateErrorType", + "traits": { + "smithy.api#documentation": "

Type of error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

Description of the error type.

" + } + }, + "ViolatedEntities": { + "target": "com.amazonaws.quicksight#EntityList", + "traits": { + "smithy.api#documentation": "

An error path that shows which entities caused the template error.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

List of errors that occurred when the template version creation failed.

" + } + }, + "com.amazonaws.quicksight#TemplateErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#TemplateErrorType": { + "type": "enum", + "members": { + "SOURCE_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SOURCE_NOT_FOUND" + } + }, + "DATA_SET_NOT_FOUND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_SET_NOT_FOUND" + } + }, + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + }, + "ACCESS_DENIED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCESS_DENIED" + } + } + } + }, + "com.amazonaws.quicksight#TemplateName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TemplateSourceAnalysis": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + }, + "DataSetReferences": { + "target": "com.amazonaws.quicksight#DataSetReferenceList", + "traits": { + "smithy.api#documentation": "

A structure containing information about the dataset references used as placeholders\n in the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source analysis of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSourceEntity": { + "type": "structure", + "members": { + "SourceAnalysis": { + "target": "com.amazonaws.quicksight#TemplateSourceAnalysis", + "traits": { + "smithy.api#documentation": "

The source analysis, if it is based on an analysis.

" + } + }, + "SourceTemplate": { + "target": "com.amazonaws.quicksight#TemplateSourceTemplate", + "traits": { + "smithy.api#documentation": "

The source template, if it is based on an template.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The source entity of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSourceTemplate": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The source template of the template.

" + } + }, + "com.amazonaws.quicksight#TemplateSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

A summary of a template.

" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

A display name for the template.

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

A structure containing a list of version numbers for the template summary.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this template was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last time that this template was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template summary.

" + } + }, + "com.amazonaws.quicksight#TemplateSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TemplateVersion": { + "type": "structure", + "members": { + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this template version was created.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#TemplateErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with this template version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template version.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status that is associated with the template.

\n " + } + }, + "DataSetConfigurations": { + "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "traits": { + "smithy.api#documentation": "

Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the template.

" + } + }, + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the theme associated with this version of the template.

" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "

A list of the associated sheets with the unique identifier and name of each sheet.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of a template.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionDefinition": { + "type": "structure", + "members": { + "DataSetConfigurations": { + "target": "com.amazonaws.quicksight#DataSetConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

", + "smithy.api#required": {} + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetDefinitionList", + "traits": { + "smithy.api#documentation": "

An array of sheet definitions for a template.

" + } + }, + "CalculatedFields": { + "target": "com.amazonaws.quicksight#CalculatedFields", + "traits": { + "smithy.api#documentation": "

An array of calculated field definitions for the template.

" + } + }, + "ParameterDeclarations": { + "target": "com.amazonaws.quicksight#ParameterDeclarationList", + "traits": { + "smithy.api#documentation": "

An array of parameter declarations for a template.

\n

\n Parameters are named variables that can transfer a value for use by an action or an object.

\n

For more information, see Parameters in Amazon QuickSight in the\n Amazon QuickSight User Guide.\n

" + } + }, + "FilterGroups": { + "target": "com.amazonaws.quicksight#FilterGroupList", + "traits": { + "smithy.api#documentation": "

Filter definitions for a template.

\n

For more information, see Filtering Data in the Amazon QuickSight User Guide.\n

" + } + }, + "ColumnConfigurations": { + "target": "com.amazonaws.quicksight#ColumnConfigurationList", + "traits": { + "smithy.api#documentation": "

An array of template-level column\n configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

" + } + }, + "AnalysisDefaults": { + "target": "com.amazonaws.quicksight#AnalysisDefaults" + }, + "Options": { + "target": "com.amazonaws.quicksight#AssetOptions", + "traits": { + "smithy.api#documentation": "

An array of option definitions for a template.

" + } + }, + "QueryExecutionOptions": { + "target": "com.amazonaws.quicksight#QueryExecutionOptions" + } + }, + "traits": { + "smithy.api#documentation": "

The detailed definition of a template.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template version.

" + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that this template version was created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the template version.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the template version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The template version.

" + } + }, + "com.amazonaws.quicksight#TemplateVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TemplateVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TeradataParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

Host.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

Port.

", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "

Database.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Teradata.

" + } + }, + "com.amazonaws.quicksight#TextAreaControlDelimiter": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TextAreaControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "PlaceholderOptions": { + "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text area control.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#TextConditionalFormat": { + "type": "structure", + "members": { + "BackgroundColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text background color.

" + } + }, + "TextColor": { + "target": "com.amazonaws.quicksight#ConditionalFormattingColor", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text color.

" + } + }, + "Icon": { + "target": "com.amazonaws.quicksight#ConditionalFormattingIcon", + "traits": { + "smithy.api#documentation": "

The conditional formatting for the icon.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The conditional formatting for the text.

" + } + }, + "com.amazonaws.quicksight#TextControlPlaceholderOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration of the placeholder options in a text control.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text control.

" + } + }, + "com.amazonaws.quicksight#TextFieldControlDisplayOptions": { + "type": "structure", + "members": { + "TitleOptions": { + "target": "com.amazonaws.quicksight#LabelOptions", + "traits": { + "smithy.api#documentation": "

The options to configure the title visibility, name, and font size.

" + } + }, + "PlaceholderOptions": { + "target": "com.amazonaws.quicksight#TextControlPlaceholderOptions", + "traits": { + "smithy.api#documentation": "

The configuration of the placeholder options in a text field control.

" + } + }, + "InfoIconLabelOptions": { + "target": "com.amazonaws.quicksight#SheetControlInfoIconLabelOptions", + "traits": { + "smithy.api#documentation": "

The configuration of info icon label options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options of a control.

" + } + }, + "com.amazonaws.quicksight#TextQualifier": { + "type": "enum", + "members": { + "DOUBLE_QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOUBLE_QUOTE" + } + }, + "SINGLE_QUOTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SINGLE_QUOTE" + } + } + } + }, + "com.amazonaws.quicksight#TextWrap": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "WRAP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WRAP" + } + } + } + }, + "com.amazonaws.quicksight#Theme": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

The name that the user gives to the theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The identifier that the user gives to the theme.

" + } + }, + "Version": { + "target": "com.amazonaws.quicksight#ThemeVersion" + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the theme was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that the theme was last updated.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", + "traits": { + "smithy.api#documentation": "

The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT and CUSTOM.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Summary information about a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeAlias": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme alias.

" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The display name of the theme alias.

" + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme alias.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An alias for a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeAliasList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeAlias" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThemeConfiguration": { + "type": "structure", + "members": { + "DataColorPalette": { + "target": "com.amazonaws.quicksight#DataColorPalette", + "traits": { + "smithy.api#documentation": "

Color properties that apply to chart data colors.

" + } + }, + "UIColorPalette": { + "target": "com.amazonaws.quicksight#UIColorPalette", + "traits": { + "smithy.api#documentation": "

Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.

" + } + }, + "Sheet": { + "target": "com.amazonaws.quicksight#SheetStyle", + "traits": { + "smithy.api#documentation": "

Display options related to sheets.

" + } + }, + "Typography": { + "target": "com.amazonaws.quicksight#Typography" + } + }, + "traits": { + "smithy.api#documentation": "

The theme configuration. This configuration contains all of the display properties for\n a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeError": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#ThemeErrorType", + "traits": { + "smithy.api#documentation": "

The type of error.

" + } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The error message.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Theme error.

" + } + }, + "com.amazonaws.quicksight#ThemeErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeError" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#ThemeErrorType": { + "type": "enum", + "members": { + "INTERNAL_FAILURE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INTERNAL_FAILURE" + } + } + } + }, + "com.amazonaws.quicksight#ThemeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#ThemeSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

the display name for the theme.

" + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The latest version number for the theme.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The last date and time that this theme was updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme summary.

" + } + }, + "com.amazonaws.quicksight#ThemeSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThemeType": { + "type": "enum", + "members": { + "QUICKSIGHT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUICKSIGHT" + } + }, + "CUSTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CUSTOM" + } + }, + "ALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALL" + } + } + } + }, + "com.amazonaws.quicksight#ThemeVersion": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the theme.

" + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default Amazon QuickSight theme.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme version was created.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains all the theme display properties.

" + } + }, + "Errors": { + "target": "com.amazonaws.quicksight#ThemeErrorList", + "traits": { + "smithy.api#documentation": "

Errors associated with the theme.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the theme version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A version of a theme.

" + } + }, + "com.amazonaws.quicksight#ThemeVersionSummary": { + "type": "structure", + "members": { + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme version.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme version.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

The description of the theme version.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date and time that this theme version was created.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the theme version.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme version.

" + } + }, + "com.amazonaws.quicksight#ThemeVersionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ThemeVersionSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#ThousandSeparatorOptions": { + "type": "structure", + "members": { + "Symbol": { + "target": "com.amazonaws.quicksight#NumericSeparatorSymbol", + "traits": { + "smithy.api#documentation": "

Determines the thousands separator symbol.

" + } + }, + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines the visibility of the thousands separator.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the thousands separator configuration.

" + } + }, + "com.amazonaws.quicksight#ThrottlingException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Access is throttled.

", + "smithy.api#error": "client", + "smithy.api#httpError": 429 + } + }, + "com.amazonaws.quicksight#TileLayoutStyle": { + "type": "structure", + "members": { + "Gutter": { + "target": "com.amazonaws.quicksight#GutterStyle", + "traits": { + "smithy.api#documentation": "

The gutter settings that apply between tiles.

" + } + }, + "Margin": { + "target": "com.amazonaws.quicksight#MarginStyle", + "traits": { + "smithy.api#documentation": "

The margin settings that apply around the outside edge of sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the layout of tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#TileStyle": { + "type": "structure", + "members": { + "Border": { + "target": "com.amazonaws.quicksight#BorderStyle", + "traits": { + "smithy.api#documentation": "

The border around a tile.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Display options related to tiles on a sheet.

" + } + }, + "com.amazonaws.quicksight#TimeBasedForecastProperties": { + "type": "structure", + "members": { + "PeriodsForward": { + "target": "com.amazonaws.quicksight#PeriodsForward", + "traits": { + "smithy.api#documentation": "

The periods forward setup of a forecast computation.

" + } + }, + "PeriodsBackward": { + "target": "com.amazonaws.quicksight#PeriodsBackward", + "traits": { + "smithy.api#documentation": "

The periods backward setup of a forecast computation.

" + } + }, + "UpperBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The upper boundary setup of a forecast computation.

" + } + }, + "LowerBoundary": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The lower boundary setup of a forecast computation.

" + } + }, + "PredictionInterval": { + "target": "com.amazonaws.quicksight#PredictionInterval", + "traits": { + "smithy.api#documentation": "

The prediction interval setup of a forecast computation.

" + } + }, + "Seasonality": { + "target": "com.amazonaws.quicksight#Seasonality", + "traits": { + "smithy.api#documentation": "

The seasonality setup of a forecast computation. Choose one of the following options:

\n " + } + } + }, + "traits": { + "smithy.api#documentation": "

The forecast properties setup of a forecast in the line chart.

" + } + }, + "com.amazonaws.quicksight#TimeEqualityFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The value of a TimeEquality filter.

\n

This field is mutually exclusive to RollingDate and ParameterName.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

\n

This field is mutually exclusive to Value and RollingDate.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date input for the TimeEquality filter.

\n

This field is mutually exclusive to Value and ParameterName.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TimeEqualityFilter filters values that are equal to a given value.

" + } + }, + "com.amazonaws.quicksight#TimeGranularity": { + "type": "enum", + "members": { + "YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEAR" + } + }, + "QUARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTER" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "MINUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE" + } + }, + "SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECOND" + } + }, + "MILLISECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MILLISECOND" + } + } + } + }, + "com.amazonaws.quicksight#TimeRangeDrillDownFilter": { + "type": "structure", + "members": { + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "RangeMinimum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

", + "smithy.api#required": {} + } + }, + "RangeMaximum": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The time range drill down filter.

" + } + }, + "com.amazonaws.quicksight#TimeRangeFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "IncludeMinimum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the minimum value in the filter value range should be included in the filtered results.

" + } + }, + "IncludeMaximum": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Determines whether the maximum value in the filter value range should be included in the filtered results.

" + } + }, + "RangeMinimumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The minimum value for the filter value range.

" + } + }, + "RangeMaximumValue": { + "target": "com.amazonaws.quicksight#TimeRangeFilterValue", + "traits": { + "smithy.api#documentation": "

The maximum value for the filter value range.

" + } + }, + "NullOption": { + "target": "com.amazonaws.quicksight#FilterNullOption", + "traits": { + "smithy.api#documentation": "

This option determines how null values should be treated when filtering data.

\n ", + "smithy.api#required": {} + } + }, + "ExcludePeriodConfiguration": { + "target": "com.amazonaws.quicksight#ExcludePeriodConfiguration", + "traits": { + "smithy.api#documentation": "

The exclude period of the time range filter.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TimeRangeFilter filters values that are between two specified values.

" + } + }, + "com.amazonaws.quicksight#TimeRangeFilterValue": { + "type": "structure", + "members": { + "StaticValue": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The static input value.

" + } + }, + "RollingDate": { + "target": "com.amazonaws.quicksight#RollingDateConfiguration", + "traits": { + "smithy.api#documentation": "

The rolling date input value.

" + } + }, + "Parameter": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter type input value.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The value of a time range filter.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#Timestamp": { + "type": "timestamp" + }, + "com.amazonaws.quicksight#TooltipItem": { + "type": "structure", + "members": { + "FieldTooltipItem": { + "target": "com.amazonaws.quicksight#FieldTooltipItem", + "traits": { + "smithy.api#documentation": "

The tooltip item for the fields.

" + } + }, + "ColumnTooltipItem": { + "target": "com.amazonaws.quicksight#ColumnTooltipItem", + "traits": { + "smithy.api#documentation": "

The tooltip item for the columns that are not part of a field well.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The tooltip.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TooltipItemList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TooltipItem" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#TooltipOptions": { + "type": "structure", + "members": { + "TooltipVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

Determines whether or not the tooltip is visible.

" + } + }, + "SelectedTooltipType": { + "target": "com.amazonaws.quicksight#SelectedTooltipType", + "traits": { + "smithy.api#documentation": "

The selected type for the tooltip. Choose one of the following options:

\n " + } + }, + "FieldBasedTooltip": { + "target": "com.amazonaws.quicksight#FieldBasedTooltip", + "traits": { + "smithy.api#documentation": "

The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The display options for the visual tooltip.

" + } + }, + "com.amazonaws.quicksight#TooltipTarget": { + "type": "enum", + "members": { + "BOTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTH" + } + }, + "BAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BAR" + } + }, + "LINE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LINE" + } + } + } + }, + "com.amazonaws.quicksight#TooltipTitleType": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "PRIMARY_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY_VALUE" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomComputationType": { + "type": "enum", + "members": { + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + } + } + }, + "com.amazonaws.quicksight#TopBottomFilter": { + "type": "structure", + "members": { + "FilterId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

An identifier that uniquely identifies a filter within a dashboard, analysis, or template.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that the filter is applied to.

", + "smithy.api#required": {} + } + }, + "Limit": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

The number of items to include in the top bottom filter results.

" + } + }, + "AggregationSortConfigurations": { + "target": "com.amazonaws.quicksight#AggregationSortConfigurationList", + "traits": { + "smithy.api#documentation": "

The aggregation and sort configuration of the top bottom filter.

", + "smithy.api#required": {} + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "ParameterName": { + "target": "com.amazonaws.quicksight#ParameterName", + "traits": { + "smithy.api#documentation": "

The parameter whose value should be used for the filter value.

" + } + }, + "DefaultFilterControlConfiguration": { + "target": "com.amazonaws.quicksight#DefaultFilterControlConfiguration", + "traits": { + "smithy.api#documentation": "

The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A TopBottomFilter filters values that are at the top or the bottom.

" + } + }, + "com.amazonaws.quicksight#TopBottomMoversComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Time": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The time field that is used in a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "MoverSize": { + "target": "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize", + "traits": { + "smithy.api#documentation": "

The mover size setup of the top and bottom movers computation.

" + } + }, + "SortOrder": { + "target": "com.amazonaws.quicksight#TopBottomSortOrder", + "traits": { + "smithy.api#documentation": "

The sort order setup of the top and bottom movers computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "

The computation type. Choose from the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The top movers and bottom movers computation setup.

" + } + }, + "com.amazonaws.quicksight#TopBottomMoversComputationMoverSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + }, + "ResultSize": { + "target": "com.amazonaws.quicksight#TopBottomRankedComputationResultSize", + "traits": { + "smithy.api#documentation": "

The result size of a top and bottom ranked computation.

" + } + }, + "Type": { + "target": "com.amazonaws.quicksight#TopBottomComputationType", + "traits": { + "smithy.api#documentation": "

The computation type. Choose one of the following options:

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The top ranked and bottom ranked computation configuration.

" + } + }, + "com.amazonaws.quicksight#TopBottomRankedComputationResultSize": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 20 + } + } + }, + "com.amazonaws.quicksight#TopBottomSortOrder": { + "type": "enum", + "members": { + "PERCENT_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PERCENT_DIFFERENCE" + } + }, + "ABSOLUTE_DIFFERENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ABSOLUTE_DIFFERENCE" + } + } + } + }, + "com.amazonaws.quicksight#TopicCalculatedField": { + "type": "structure", + "members": { + "CalculatedFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The calculated field name.

", + "smithy.api#required": {} + } + }, + "CalculatedFieldDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The calculated field description.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The calculated field expression.

", + "smithy.api#required": {} + } + }, + "CalculatedFieldSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the calculated field.

" + } + }, + "IsIncludedInTopic": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that indicates if a calculated field is included in the topic.

" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates if a calculated field is visible in the autocomplete.

" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "DefaultFormatting": { + "target": "com.amazonaws.quicksight#DefaultFormatting", + "traits": { + "smithy.api#documentation": "

The default formatting definition.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#DefaultAggregation", + "traits": { + "smithy.api#documentation": "

The default aggregation. Valid values for this structure are SUM,\n MAX, MIN, COUNT,\n DISTINCT_COUNT,\n and AVERAGE.

" + } + }, + "ComparativeOrder": { + "target": "com.amazonaws.quicksight#ComparativeOrder", + "traits": { + "smithy.api#documentation": "

The order in which data is displayed for the calculated field when\n it's used in a comparative context.

" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "

The semantic type.

" + } + }, + "AllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are allowed for the calculated field. Valid values\n for this structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" + } + }, + "NotAllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are not allowed for the calculated field. Valid\n values for this structure are COUNT, DISTINCT_COUNT,\n MIN, MAX, MEDIAN, SUM,\n AVERAGE, STDEV, STDEVP, VAR,\n VARP, and PERCENTILE.

" + } + }, + "NeverAggregateInFilter": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether to never aggregate calculated field in filters.

" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", + "traits": { + "smithy.api#documentation": "

The other\n names or aliases for the calculated field cell value.

" + } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The non additive for the table style target.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a calculated field.

" + } + }, + "com.amazonaws.quicksight#TopicCalculatedFields": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicCalculatedField" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilter": { + "type": "structure", + "members": { + "CategoryFilterFunction": { + "target": "com.amazonaws.quicksight#CategoryFilterFunction", + "traits": { + "smithy.api#documentation": "

The category filter function. Valid values for this structure are EXACT and CONTAINS.

" + } + }, + "CategoryFilterType": { + "target": "com.amazonaws.quicksight#CategoryFilterType", + "traits": { + "smithy.api#documentation": "

The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicCategoryFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a category filter.

" + } + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates if the filter is inverse.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a category filter.

" + } + }, + "com.amazonaws.quicksight#TopicCategoryFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.

" + } + }, + "SingularConstant": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A singular constant used in a category filter. This element is used to specify a single value for the constant.

" + } + }, + "CollectiveConstant": { + "target": "com.amazonaws.quicksight#CollectiveConstant", + "traits": { + "smithy.api#documentation": "

A collective constant used in a category filter. This element is used to specify a list of values for the constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A constant used in a category filter.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicColumn": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the column.

", + "smithy.api#required": {} + } + }, + "ColumnFriendlyName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A user-friendly name for the column.

" + } + }, + "ColumnDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A description of the column and its contents.

" + } + }, + "ColumnSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the column.

" + } + }, + "ColumnDataRole": { + "target": "com.amazonaws.quicksight#ColumnDataRole", + "traits": { + "smithy.api#documentation": "

The role of the column in the data. Valid values are DIMENSION and MEASURE.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#DefaultAggregation", + "traits": { + "smithy.api#documentation": "

The type of aggregation that is performed on the column data when\n it's queried.

" + } + }, + "IsIncludedInTopic": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the column is included in the query results.

" + } + }, + "DisableIndexing": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that indicates whether the column shows in the autocomplete functionality.

" + } + }, + "ComparativeOrder": { + "target": "com.amazonaws.quicksight#ComparativeOrder", + "traits": { + "smithy.api#documentation": "

The order in which data is displayed for the column when\n it's used in a comparative context.

" + } + }, + "SemanticType": { + "target": "com.amazonaws.quicksight#SemanticType", + "traits": { + "smithy.api#documentation": "

The semantic type of data contained in the column.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "AllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" + } + }, + "NotAllowedAggregations": { + "target": "com.amazonaws.quicksight#AuthorSpecifiedAggregations", + "traits": { + "smithy.api#documentation": "

The list of aggregation types that are not allowed for the column. Valid values for this\n structure are COUNT, DISTINCT_COUNT, MIN,\n MAX, MEDIAN, SUM, AVERAGE,\n STDEV, STDEVP, VAR,\n VARP,\n and PERCENTILE.

" + } + }, + "DefaultFormatting": { + "target": "com.amazonaws.quicksight#DefaultFormatting", + "traits": { + "smithy.api#documentation": "

The default formatting used for values in the column.

" + } + }, + "NeverAggregateInFilter": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean\n value that indicates whether to aggregate the column data when\n it's used in a filter context.

" + } + }, + "CellValueSynonyms": { + "target": "com.amazonaws.quicksight#CellValueSynonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the column cell value.

" + } + }, + "NonAdditive": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

The non additive value for the column.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Represents a column in a dataset.

" + } + }, + "com.amazonaws.quicksight#TopicColumns": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicColumn" + } + }, + "com.amazonaws.quicksight#TopicConstantValue": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The constant type of a TopicConstantValue.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The value of the TopicConstantValue.

" + } + }, + "Minimum": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The minimum for the TopicConstantValue.

" + } + }, + "Maximum": { + "target": "com.amazonaws.quicksight#ConstantValueString", + "traits": { + "smithy.api#documentation": "

The maximum for the TopicConstantValue.

" + } + }, + "ValueList": { + "target": "com.amazonaws.quicksight#CollectiveConstantEntryList", + "traits": { + "smithy.api#documentation": "

The value list of the TopicConstantValue.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicConstantValue.

" + } + }, + "com.amazonaws.quicksight#TopicDateRangeFilter": { + "type": "structure", + "members": { + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the date range filter should include the boundary values. If\n set to true, the filter includes the start and end dates. If set to false, the filter\n excludes them.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a date range filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter used to restrict data based on a range of dates or times.

" + } + }, + "com.amazonaws.quicksight#TopicDetails": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the topic.

" + } + }, + "Description": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the topic.

" + } + }, + "UserExperienceVersion": { + "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", + "traits": { + "smithy.api#documentation": "

The user experience version of a topic.

" + } + }, + "DataSets": { + "target": "com.amazonaws.quicksight#Datasets", + "traits": { + "smithy.api#documentation": "

The data sets that the topic is associated with.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that describes the details of a topic, such as its name, description, and associated data sets.

" + } + }, + "com.amazonaws.quicksight#TopicFilter": { + "type": "structure", + "members": { + "FilterDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

A description of the filter used to select items for a topic.

" + } + }, + "FilterClass": { + "target": "com.amazonaws.quicksight#FilterClass", + "traits": { + "smithy.api#documentation": "

The class of the filter. Valid values for this structure are\n ENFORCED_VALUE_FILTER,\n CONDITIONAL_VALUE_FILTER,\n and NAMED_VALUE_FILTER.

" + } + }, + "FilterName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the filter.

", + "smithy.api#required": {} + } + }, + "FilterSynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other names or aliases for the filter.

" + } + }, + "OperandFieldName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the field that the filter operates on.

", + "smithy.api#required": {} + } + }, + "FilterType": { + "target": "com.amazonaws.quicksight#NamedFilterType", + "traits": { + "smithy.api#documentation": "

The type of the filter. Valid values for this structure are\n CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER,\n NUMERIC_RANGE_FILTER,\n DATE_RANGE_FILTER,\n and RELATIVE_DATE_FILTER.

" + } + }, + "CategoryFilter": { + "target": "com.amazonaws.quicksight#TopicCategoryFilter", + "traits": { + "smithy.api#documentation": "

The category filter that is associated with this filter.

" + } + }, + "NumericEqualityFilter": { + "target": "com.amazonaws.quicksight#TopicNumericEqualityFilter", + "traits": { + "smithy.api#documentation": "

The numeric equality filter.

" + } + }, + "NumericRangeFilter": { + "target": "com.amazonaws.quicksight#TopicNumericRangeFilter", + "traits": { + "smithy.api#documentation": "

The numeric range filter.

" + } + }, + "DateRangeFilter": { + "target": "com.amazonaws.quicksight#TopicDateRangeFilter", + "traits": { + "smithy.api#documentation": "

The date range filter.

" + } + }, + "RelativeDateFilter": { + "target": "com.amazonaws.quicksight#TopicRelativeDateFilter", + "traits": { + "smithy.api#documentation": "

The relative date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a filter used to select items for a topic.

" + } + }, + "com.amazonaws.quicksight#TopicFilters": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicFilter" + } + }, + "com.amazonaws.quicksight#TopicIR": { + "type": "structure", + "members": { + "Metrics": { + "target": "com.amazonaws.quicksight#TopicIRMetricList", + "traits": { + "smithy.api#documentation": "

The metrics for the TopicIR.

" + } + }, + "GroupByList": { + "target": "com.amazonaws.quicksight#TopicIRGroupByList", + "traits": { + "smithy.api#documentation": "

The GroupBy list for the TopicIR.

" + } + }, + "Filters": { + "target": "com.amazonaws.quicksight#TopicIRFilterList", + "traits": { + "smithy.api#documentation": "

The filters for the TopicIR.

" + } + }, + "Sort": { + "target": "com.amazonaws.quicksight#TopicSortClause", + "traits": { + "smithy.api#documentation": "

The sort for the TopicIR.

" + } + }, + "ContributionAnalysis": { + "target": "com.amazonaws.quicksight#TopicIRContributionAnalysis", + "traits": { + "smithy.api#documentation": "

The contribution analysis for the TopicIR.

" + } + }, + "Visual": { + "target": "com.amazonaws.quicksight#VisualOptions", + "traits": { + "smithy.api#documentation": "

The visual for the TopicIR.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIR.

" + } + }, + "com.amazonaws.quicksight#TopicIRComparisonMethod": { + "type": "structure", + "members": { + "Type": { + "target": "com.amazonaws.quicksight#ComparisonMethodType", + "traits": { + "smithy.api#documentation": "

The type for the TopicIRComparisonMethod.

" + } + }, + "Period": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The period for the TopicIRComparisonMethod.

" + } + }, + "WindowSize": { + "target": "com.amazonaws.quicksight#Integer", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The window size for the TopicIRComparisonMethod.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition of a TopicIRComparisonMethod.

" + } + }, + "com.amazonaws.quicksight#TopicIRContributionAnalysis": { + "type": "structure", + "members": { + "Factors": { + "target": "com.amazonaws.quicksight#ContributionAnalysisFactorsList", + "traits": { + "smithy.api#documentation": "

The factors for a TopicIRContributionAnalysis.

" + } + }, + "TimeRanges": { + "target": "com.amazonaws.quicksight#ContributionAnalysisTimeRanges", + "traits": { + "smithy.api#documentation": "

The time ranges for the TopicIRContributionAnalysis.

" + } + }, + "Direction": { + "target": "com.amazonaws.quicksight#ContributionAnalysisDirection", + "traits": { + "smithy.api#documentation": "

The direction for the TopicIRContributionAnalysis.

" + } + }, + "SortType": { + "target": "com.amazonaws.quicksight#ContributionAnalysisSortType", + "traits": { + "smithy.api#documentation": "

The sort type for the TopicIRContributionAnalysis.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRContributionAnalysis.

" + } + }, + "com.amazonaws.quicksight#TopicIRFilterEntry": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRFilterOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterFunction": { + "type": "enum", + "members": { + "CONTAINS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS" + } + }, + "EXACT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXACT" + } + }, + "STARTS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STARTS_WITH" + } + }, + "ENDS_WITH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENDS_WITH" + } + }, + "CONTAINS_STRING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CONTAINS_STRING" + } + }, + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRFilterEntry" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRFilterOption": { + "type": "structure", + "members": { + "FilterType": { + "target": "com.amazonaws.quicksight#TopicIRFilterType", + "traits": { + "smithy.api#documentation": "

The filter type for the TopicIRFilterOption.

" + } + }, + "FilterClass": { + "target": "com.amazonaws.quicksight#FilterClass", + "traits": { + "smithy.api#documentation": "

The filter class for the TopicIRFilterOption.

" + } + }, + "OperandField": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The operand field for the TopicIRFilterOption.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#TopicIRFilterFunction", + "traits": { + "smithy.api#documentation": "

The function for the TopicIRFilterOption.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The constant for the TopicIRFilterOption.

" + } + }, + "Inverse": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The inverse for the TopicIRFilterOption.

" + } + }, + "NullFilter": { + "target": "com.amazonaws.quicksight#NullFilterOption", + "traits": { + "smithy.api#documentation": "

The null filter for the TopicIRFilterOption.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#AggType", + "traits": { + "smithy.api#documentation": "

The aggregation for the TopicIRFilterOption.

" + } + }, + "AggregationFunctionParameters": { + "target": "com.amazonaws.quicksight#AggFunctionParamMap", + "traits": { + "smithy.api#documentation": "

The aggregation function parameters for the TopicIRFilterOption.

" + } + }, + "AggregationPartitionBy": { + "target": "com.amazonaws.quicksight#AggregationPartitionByList", + "traits": { + "smithy.api#documentation": "

The AggregationPartitionBy for the TopicIRFilterOption.

" + } + }, + "Range": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The range for the TopicIRFilterOption.

" + } + }, + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The inclusive for the TopicIRFilterOption.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity for the TopicIRFilterOption.

" + } + }, + "LastNextOffset": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The last next offset for the TopicIRFilterOption.

" + } + }, + "AggMetrics": { + "target": "com.amazonaws.quicksight#FilterAggMetricsList", + "traits": { + "smithy.api#documentation": "

The agg metrics for the TopicIRFilterOption.

" + } + }, + "TopBottomLimit": { + "target": "com.amazonaws.quicksight#TopicConstantValue", + "traits": { + "smithy.api#documentation": "

The TopBottomLimit for the TopicIRFilterOption.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for the TopicIRFilterOption.

" + } + }, + "Anchor": { + "target": "com.amazonaws.quicksight#Anchor", + "traits": { + "smithy.api#documentation": "

The anchor for the TopicIRFilterOption.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRFilterOption.

" + } + }, + "com.amazonaws.quicksight#TopicIRFilterType": { + "type": "enum", + "members": { + "CATEGORY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CATEGORY_FILTER" + } + }, + "NUMERIC_EQUALITY_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_EQUALITY_FILTER" + } + }, + "NUMERIC_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NUMERIC_RANGE_FILTER" + } + }, + "DATE_RANGE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATE_RANGE_FILTER" + } + }, + "RELATIVE_DATE_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RELATIVE_DATE_FILTER" + } + }, + "TOP_BOTTOM_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP_BOTTOM_FILTER" + } + }, + "EQUALS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EQUALS" + } + }, + "RANK_LIMIT_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RANK_LIMIT_FILTER" + } + }, + "ACCEPT_ALL_FILTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ACCEPT_ALL_FILTER" + } + } + } + }, + "com.amazonaws.quicksight#TopicIRGroupBy": { + "type": "structure", + "members": { + "FieldName": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The field name for the TopicIRGroupBy.

" + } + }, + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The time granularity for the TopicIRGroupBy.

" + } + }, + "Sort": { + "target": "com.amazonaws.quicksight#TopicSortClause", + "traits": { + "smithy.api#documentation": "

The sort for the TopicIRGroupBy.

" + } + }, + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format for the TopicIRGroupBy.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions" + }, + "NamedEntity": { + "target": "com.amazonaws.quicksight#NamedEntityRef", + "traits": { + "smithy.api#documentation": "

The named entity for the TopicIRGroupBy.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRGroupBy.

" + } + }, + "com.amazonaws.quicksight#TopicIRGroupByList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRGroupBy" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicIRMetric": { + "type": "structure", + "members": { + "MetricId": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The metric ID for the TopicIRMetric.

" + } + }, + "Function": { + "target": "com.amazonaws.quicksight#AggFunction", + "traits": { + "smithy.api#documentation": "

The function for the TopicIRMetric.

" + } + }, + "Operands": { + "target": "com.amazonaws.quicksight#OperandList", + "traits": { + "smithy.api#documentation": "

The operands for the TopicIRMetric.

" + } + }, + "ComparisonMethod": { + "target": "com.amazonaws.quicksight#TopicIRComparisonMethod", + "traits": { + "smithy.api#documentation": "

The comparison method for the TopicIRMetric.

" + } + }, + "Expression": { + "target": "com.amazonaws.quicksight#Expression", + "traits": { + "smithy.api#documentation": "

The expression for the TopicIRMetric.

" + } + }, + "CalculatedFieldReferences": { + "target": "com.amazonaws.quicksight#CalculatedFieldReferenceList", + "traits": { + "smithy.api#documentation": "

The calculated field references for the TopicIRMetric.

" + } + }, + "DisplayFormat": { + "target": "com.amazonaws.quicksight#DisplayFormat", + "traits": { + "smithy.api#documentation": "

The display format for the TopicIRMetric.

" + } + }, + "DisplayFormatOptions": { + "target": "com.amazonaws.quicksight#DisplayFormatOptions" + }, + "NamedEntity": { + "target": "com.amazonaws.quicksight#NamedEntityRef", + "traits": { + "smithy.api#documentation": "

The named entity for the TopicIRMetric.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicIRMetric.

" + } + }, + "com.amazonaws.quicksight#TopicIRMetricList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicIRMetric" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 2000 + } + } + }, + "com.amazonaws.quicksight#TopicId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + }, + "smithy.api#pattern": "^[A-Za-z0-9-_.\\\\+]*$" + } + }, + "com.amazonaws.quicksight#TopicNamedEntities": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicNamedEntity" + } + }, + "com.amazonaws.quicksight#TopicNamedEntity": { + "type": "structure", + "members": { + "EntityName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the named entity.

", + "smithy.api#required": {} + } + }, + "EntityDescription": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The description of the named entity.

" + } + }, + "EntitySynonyms": { + "target": "com.amazonaws.quicksight#Synonyms", + "traits": { + "smithy.api#documentation": "

The other\n names or aliases for the named entity.

" + } + }, + "SemanticEntityType": { + "target": "com.amazonaws.quicksight#SemanticEntityType", + "traits": { + "smithy.api#documentation": "

The type of named entity that a topic represents.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#NamedEntityDefinitions", + "traits": { + "smithy.api#documentation": "

The definition of a named entity.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a named entity.

" + } + }, + "com.amazonaws.quicksight#TopicNumericEqualityFilter": { + "type": "structure", + "members": { + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a numeric equality filter.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", + "traits": { + "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic. Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value matches the specified value.

" + } + }, + "com.amazonaws.quicksight#TopicNumericRangeFilter": { + "type": "structure", + "members": { + "Inclusive": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether the endpoints of the numeric range are included in the filter.\n If set to true, topics whose numeric field value is equal to the endpoint values will be\n included in the filter. If set to false, topics whose numeric field value is equal to the\n endpoint values will be excluded from the filter.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicRangeFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a\n numeric range filter.

" + } + }, + "Aggregation": { + "target": "com.amazonaws.quicksight#NamedFilterAggType", + "traits": { + "smithy.api#documentation": "

An aggregation function that specifies how to calculate the value of a numeric field for\n a topic, Valid values for this structure are NO_AGGREGATION, SUM,\n AVERAGE, COUNT, DISTINCT_COUNT, MAX,\n MEDIAN, MIN, STDEV, STDEVP,\n VAR,\n and VARP.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A filter that filters topics based on the value of a numeric field. The filter includes only topics whose numeric field value falls within the specified range.

" + } + }, + "com.amazonaws.quicksight#TopicNumericSeparatorSymbol": { + "type": "enum", + "members": { + "COMMA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMMA" + } + }, + "DOT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DOT" + } + } + } + }, + "com.amazonaws.quicksight#TopicRangeFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.

" + } + }, + "RangeConstant": { + "target": "com.amazonaws.quicksight#RangeConstant", + "traits": { + "smithy.api#documentation": "

The value of the constant that is used to specify the endpoints of a range filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A constant value that is used in a range filter to specify the endpoints of the range.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicRefreshDetails": { + "type": "structure", + "members": { + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RefreshId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the refresh, which occurs as a result of topic creation or topic update.

" + } + }, + "RefreshStatus": { + "target": "com.amazonaws.quicksight#TopicRefreshStatus", + "traits": { + "smithy.api#documentation": "

The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The details about the refresh of a topic.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshSchedule": { + "type": "structure", + "members": { + "IsEnabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A Boolean value that controls whether to schedule is enabled.

", + "smithy.api#required": {} + } + }, + "BasedOnSpiceSchedule": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that controls whether to schedule runs at the same schedule that is specified in\n SPICE dataset.

", + "smithy.api#required": {} + } + }, + "StartingAt": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The starting date and time for the refresh schedule.

" + } + }, + "Timezone": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The timezone that you want the refresh schedule to use.

" + } + }, + "RepeatAt": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The time of day when the refresh should run, for\n example, Monday-Sunday.

" + } + }, + "TopicScheduleType": { + "target": "com.amazonaws.quicksight#TopicScheduleType", + "traits": { + "smithy.api#documentation": "

The type of refresh schedule. Valid values for this structure are HOURLY,\n DAILY,\n WEEKLY,\n and MONTHLY.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a topic refresh schedule.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshScheduleSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicRefreshScheduleSummary" + } + }, + "com.amazonaws.quicksight#TopicRefreshScheduleSummary": { + "type": "structure", + "members": { + "DatasetId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DatasetName": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The name of the dataset.

" + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A summary of the refresh schedule details for a dataset.

" + } + }, + "com.amazonaws.quicksight#TopicRefreshStatus": { + "type": "enum", + "members": { + "INITIALIZED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "INITIALIZED" + } + }, + "RUNNING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RUNNING" + } + }, + "FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FAILED" + } + }, + "COMPLETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLETED" + } + }, + "CANCELLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CANCELLED" + } + } + } + }, + "com.amazonaws.quicksight#TopicRelativeDateFilter": { + "type": "structure", + "members": { + "TimeGranularity": { + "target": "com.amazonaws.quicksight#TopicTimeGranularity", + "traits": { + "smithy.api#documentation": "

The level of time precision that is used to aggregate DateTime values.

" + } + }, + "RelativeDateFilterFunction": { + "target": "com.amazonaws.quicksight#TopicRelativeDateFilterFunction", + "traits": { + "smithy.api#documentation": "

The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.

" + } + }, + "Constant": { + "target": "com.amazonaws.quicksight#TopicSingularFilterConstant", + "traits": { + "smithy.api#documentation": "

The constant used in a\n relative date filter.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a relative date filter.

" + } + }, + "com.amazonaws.quicksight#TopicRelativeDateFilterFunction": { + "type": "enum", + "members": { + "PREVIOUS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PREVIOUS" + } + }, + "THIS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "THIS" + } + }, + "LAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LAST" + } + }, + "NEXT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEXT" + } + }, + "NOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NOW" + } + } + } + }, + "com.amazonaws.quicksight#TopicReviewedAnswer": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the reviewed answer.

" + } + }, + "AnswerId": { + "target": "com.amazonaws.quicksight#AnswerId", + "traits": { + "smithy.api#documentation": "

The answer ID of the reviewed answer.

", + "smithy.api#required": {} + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Dataset ARN for the TopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Question": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The question for the TopicReviewedAnswer.

", + "smithy.api#required": {} + } + }, + "Mir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The mir for the TopicReviewedAnswer.

" + } + }, + "PrimaryVisual": { + "target": "com.amazonaws.quicksight#TopicVisual", + "traits": { + "smithy.api#documentation": "

The primary visual for the TopicReviewedAnswer.

" + } + }, + "Template": { + "target": "com.amazonaws.quicksight#TopicTemplate", + "traits": { + "smithy.api#documentation": "

The template for the TopicReviewedAnswer.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The deinition for a TopicReviewedAnswer.

" + } + }, + "com.amazonaws.quicksight#TopicReviewedAnswers": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicReviewedAnswer" + } + }, + "com.amazonaws.quicksight#TopicScheduleType": { + "type": "enum", + "members": { + "HOURLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOURLY" + } + }, + "DAILY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAILY" + } + }, + "WEEKLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEKLY" + } + }, + "MONTHLY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTHLY" + } + } + } + }, + "com.amazonaws.quicksight#TopicSingularFilterConstant": { + "type": "structure", + "members": { + "ConstantType": { + "target": "com.amazonaws.quicksight#ConstantType", + "traits": { + "smithy.api#documentation": "

The type of the singular filter constant. Valid values for this structure are SINGULAR.

" + } + }, + "SingularConstant": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The value of the singular filter constant.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A structure that represents a singular filter constant, used in filters to specify a single value to match against.

", + "smithy.api#sensitive": {} + } + }, + "com.amazonaws.quicksight#TopicSortClause": { + "type": "structure", + "members": { + "Operand": { + "target": "com.amazonaws.quicksight#Identifier", + "traits": { + "smithy.api#documentation": "

The operand for a TopicSortClause.

" + } + }, + "SortDirection": { + "target": "com.amazonaws.quicksight#TopicSortDirection", + "traits": { + "smithy.api#documentation": "

The sort direction for the TopicSortClause.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicSortClause.

" + } + }, + "com.amazonaws.quicksight#TopicSortDirection": { + "type": "enum", + "members": { + "ASCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ASCENDING" + } + }, + "DESCENDING": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DESCENDING" + } + } + } + }, + "com.amazonaws.quicksight#TopicSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicSummary" + } + }, + "com.amazonaws.quicksight#TopicSummary": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The name of the topic.

" + } + }, + "UserExperienceVersion": { + "target": "com.amazonaws.quicksight#TopicUserExperienceVersion", + "traits": { + "smithy.api#documentation": "

The user experience version of the topic.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A topic summary.

" + } + }, + "com.amazonaws.quicksight#TopicTemplate": { + "type": "structure", + "members": { + "TemplateType": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The template type for the TopicTemplate.

" + } + }, + "Slots": { + "target": "com.amazonaws.quicksight#Slots", + "traits": { + "smithy.api#documentation": "

The slots for the TopicTemplate.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicTemplate.

" + } + }, + "com.amazonaws.quicksight#TopicTimeGranularity": { + "type": "enum", + "members": { + "SECOND": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SECOND" + } + }, + "MINUTE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MINUTE" + } + }, + "HOUR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HOUR" + } + }, + "DAY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DAY" + } + }, + "WEEK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "WEEK" + } + }, + "MONTH": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MONTH" + } + }, + "QUARTER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "QUARTER" + } + }, + "YEAR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "YEAR" + } + } + } + }, + "com.amazonaws.quicksight#TopicUserExperienceVersion": { + "type": "enum", + "members": { + "LEGACY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEGACY" + } + }, + "NEW_READER_EXPERIENCE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_READER_EXPERIENCE" + } + } + } + }, + "com.amazonaws.quicksight#TopicVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The visual ID for the TopicVisual.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#VisualRole", + "traits": { + "smithy.api#documentation": "

The role for the TopicVisual.

" + } + }, + "Ir": { + "target": "com.amazonaws.quicksight#TopicIR", + "traits": { + "smithy.api#documentation": "

The ir for the TopicVisual.

" + } + }, + "SupportingVisuals": { + "target": "com.amazonaws.quicksight#TopicVisuals", + "traits": { + "smithy.api#documentation": "

The supporting visuals for the TopicVisual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a TopicVisual.

" + } + }, + "com.amazonaws.quicksight#TopicVisuals": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TopicVisual" + } + }, + "com.amazonaws.quicksight#TotalAggregationComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Value": { + "target": "com.amazonaws.quicksight#MeasureField", + "traits": { + "smithy.api#documentation": "

The value field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total aggregation computation configuration.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationFunction": { + "type": "structure", + "members": { + "SimpleTotalAggregationFunction": { + "target": "com.amazonaws.quicksight#SimpleTotalAggregationFunction", + "traits": { + "smithy.api#documentation": "

A built in aggregation function for total values.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

An aggregation function that aggregates the total values of a measure.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationOption": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The field id that's associated with the total aggregation option.

", + "smithy.api#required": {} + } + }, + "TotalAggregationFunction": { + "target": "com.amazonaws.quicksight#TotalAggregationFunction", + "traits": { + "smithy.api#documentation": "

The total aggregation function that you want to set for a specified field id.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The total aggregation settings map of a field id.

" + } + }, + "com.amazonaws.quicksight#TotalAggregationOptionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TotalAggregationOption" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#TotalOptions": { + "type": "structure", + "members": { + "TotalsVisibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility configuration for the total cells.

" + } + }, + "Placement": { + "target": "com.amazonaws.quicksight#TableTotalsPlacement", + "traits": { + "smithy.api#documentation": "

The placement (start, end) for the total cells.

" + } + }, + "ScrollStatus": { + "target": "com.amazonaws.quicksight#TableTotalsScrollStatus", + "traits": { + "smithy.api#documentation": "

The scroll status (pinned, scrolled) for the total cells.

" + } + }, + "CustomLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The custom label string for the total cells.

" + } + }, + "TotalCellStyle": { + "target": "com.amazonaws.quicksight#TableCellStyle", + "traits": { + "smithy.api#documentation": "

Cell styling options for the total cells.

" + } + }, + "TotalAggregationOptions": { + "target": "com.amazonaws.quicksight#TotalAggregationOptionList", + "traits": { + "smithy.api#documentation": "

The total aggregation settings for each value field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The total options for a table visual.

" + } + }, + "com.amazonaws.quicksight#TransformOperation": { + "type": "union", + "members": { + "ProjectOperation": { + "target": "com.amazonaws.quicksight#ProjectOperation", + "traits": { + "smithy.api#documentation": "

An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.

" + } + }, + "FilterOperation": { + "target": "com.amazonaws.quicksight#FilterOperation", + "traits": { + "smithy.api#documentation": "

An operation that filters rows based on some condition.

" + } + }, + "CreateColumnsOperation": { + "target": "com.amazonaws.quicksight#CreateColumnsOperation", + "traits": { + "smithy.api#documentation": "

An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.

" + } + }, + "RenameColumnOperation": { + "target": "com.amazonaws.quicksight#RenameColumnOperation", + "traits": { + "smithy.api#documentation": "

An operation that renames a column.

" + } + }, + "CastColumnTypeOperation": { + "target": "com.amazonaws.quicksight#CastColumnTypeOperation", + "traits": { + "smithy.api#documentation": "

A transform operation that casts a column to a different type.

" + } + }, + "TagColumnOperation": { + "target": "com.amazonaws.quicksight#TagColumnOperation", + "traits": { + "smithy.api#documentation": "

An operation that tags a column with additional information.

" + } + }, + "UntagColumnOperation": { + "target": "com.amazonaws.quicksight#UntagColumnOperation" + }, + "OverrideDatasetParameterOperation": { + "target": "com.amazonaws.quicksight#OverrideDatasetParameterOperation" + } + }, + "traits": { + "smithy.api#documentation": "

A data transformation on a logical table. This is a variant type structure. For this\n structure to be valid, only one of the attributes can be non-null.

" + } + }, + "com.amazonaws.quicksight#TransformOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#TransformOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#TreeMapAggregatedFieldWells": { + "type": "structure", + "members": { + "Groups": { + "target": "com.amazonaws.quicksight#TreeMapDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a tree map. Values are grouped based on group by fields.

" + } + }, + "Sizes": { + "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a tree map. Values are aggregated based on group by fields.

" + } + }, + "Colors": { + "target": "com.amazonaws.quicksight#TreeMapMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The color field well of a tree map. Values are grouped by aggregations based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Aggregated field wells of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#TreeMapFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#TreeMapSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a tree map.

" + } + }, + "GroupLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) of the groups that are displayed in a tree map.

" + } + }, + "SizeLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) of the sizes that are displayed in a tree map.

" + } + }, + "ColorLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility) for the colors displayed in a tree map.

" + } + }, + "ColorScale": { + "target": "com.amazonaws.quicksight#ColorScale", + "traits": { + "smithy.api#documentation": "

The color options (gradient color, point of divergence) of a tree map.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend display setup of the visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine if visual data labels are displayed.

" + } + }, + "Tooltip": { + "target": "com.amazonaws.quicksight#TooltipOptions", + "traits": { + "smithy.api#documentation": "

The tooltip display setup of the visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#TreeMapFieldWells": { + "type": "structure", + "members": { + "TreeMapAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#TreeMapAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a tree map.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a tree map.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#TreeMapMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#TreeMapSortConfiguration": { + "type": "structure", + "members": { + "TreeMapSort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of group by fields.

" + } + }, + "TreeMapGroupItemsLimitConfiguration": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of groups that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a tree map.

" + } + }, + "com.amazonaws.quicksight#TreeMapVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#TreeMapConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#TrendArrowOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the trend arrows.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of trend arrows in a KPI visual.

" + } + }, + "com.amazonaws.quicksight#TrinoParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "

The host name of the Trino data source.

", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "

The port for the Trino data source.

", + "smithy.api#required": {} + } + }, + "Catalog": { + "target": "com.amazonaws.quicksight#Catalog", + "traits": { + "smithy.api#documentation": "

The catalog name for the Trino data source.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters that are required to connect to a Trino data source.

" + } + }, + "com.amazonaws.quicksight#TwitterParameters": { + "type": "structure", + "members": { + "Query": { + "target": "com.amazonaws.quicksight#Query", + "traits": { + "smithy.api#documentation": "

Twitter query string.

", + "smithy.api#required": {} + } + }, + "MaxRows": { + "target": "com.amazonaws.quicksight#PositiveInteger", + "traits": { + "smithy.api#documentation": "

Maximum number of rows to query Twitter.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The parameters for Twitter.

" + } + }, + "com.amazonaws.quicksight#TypeCastFormat": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 32 + } + } + }, + "com.amazonaws.quicksight#TypeParameters": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#LimitedString" + }, + "value": { + "target": "com.amazonaws.quicksight#LimitedString" + } + }, + "com.amazonaws.quicksight#Typography": { + "type": "structure", + "members": { + "FontFamilies": { + "target": "com.amazonaws.quicksight#FontList", + "traits": { + "smithy.api#documentation": "

Determines the list of font families.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Determines the typography options.

" + } + }, + "com.amazonaws.quicksight#UIColorPalette": { + "type": "structure", + "members": { + "PrimaryForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.

" + } + }, + "PrimaryBackground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color that applies to visuals and other high emphasis UI.

" + } + }, + "SecondaryForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.

" + } + }, + "SecondaryBackground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The background color that applies to the sheet background and sheet controls.

" + } + }, + "Accent": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

This color is that applies to selected states and buttons.

" + } + }, + "AccentForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n accent color.

" + } + }, + "Danger": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to error messages.

" + } + }, + "DangerForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n error color.

" + } + }, + "Warning": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

This color that applies to warning and informational messages.

" + } + }, + "WarningForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n warning color.

" + } + }, + "Success": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to success messages, for example the check mark for a\n successful download.

" + } + }, + "SuccessForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n success color.

" + } + }, + "Dimension": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to the names of fields that are identified as\n dimensions.

" + } + }, + "DimensionForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n dimension color.

" + } + }, + "Measure": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The color that applies to the names of fields that are identified as measures.

" + } + }, + "MeasureForeground": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The foreground color that applies to any text or other elements that appear over the\n measure color.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The theme colors that apply to UI and to charts, excluding data colors. The colors\n description is a hexadecimal color code that consists of six alphanumerical characters,\n prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User\n Guide.\n

" + } + }, + "com.amazonaws.quicksight#URLOperationTemplate": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2048 + } + } + }, + "com.amazonaws.quicksight#URLTargetConfiguration": { + "type": "enum", + "members": { + "NEW_TAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_TAB" + } + }, + "NEW_WINDOW": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NEW_WINDOW" + } + }, + "SAME_TAB": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SAME_TAB" + } + } + } + }, + "com.amazonaws.quicksight#UnaggregatedField": { + "type": "structure", + "members": { + "FieldId": { + "target": "com.amazonaws.quicksight#FieldId", + "traits": { + "smithy.api#documentation": "

The custom field ID.

", + "smithy.api#required": {} + } + }, + "Column": { + "target": "com.amazonaws.quicksight#ColumnIdentifier", + "traits": { + "smithy.api#documentation": "

The column that is used in the UnaggregatedField.

", + "smithy.api#required": {} + } + }, + "FormatConfiguration": { + "target": "com.amazonaws.quicksight#FormatConfiguration", + "traits": { + "smithy.api#documentation": "

The format configuration of the field.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unaggregated field for a table.

" + } + }, + "com.amazonaws.quicksight#UnaggregatedFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#UnaggregatedField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.quicksight#UndefinedSpecifiedValueType": { + "type": "enum", + "members": { + "LEAST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LEAST" + } + }, + "MOST": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MOST" + } + } + } + }, + "com.amazonaws.quicksight#UnicodeIcon": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[^\\u0000-\\u00FF]$" + } + }, + "com.amazonaws.quicksight#UniqueValuesComputation": { + "type": "structure", + "members": { + "ComputationId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for a computation.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The name of a computation.

" + } + }, + "Category": { + "target": "com.amazonaws.quicksight#DimensionField", + "traits": { + "smithy.api#documentation": "

The category field that is used in a computation.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The unique values computation configuration.

" + } + }, + "com.amazonaws.quicksight#UnlimitedPixelLength": { + "type": "string", + "traits": { + "smithy.api#documentation": "String based length that is composed of value and unit in px with Integer.MAX_VALUE as maximum value" + } + }, + "com.amazonaws.quicksight#UnsupportedPricingPlanException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This error indicates that you are calling an embedding operation in Amazon QuickSight\n\t\t\twithout the required pricing plan on your Amazon Web Services account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to Amazon QuickSight. You \n\t\t can do this on the Manage Amazon QuickSight page.

\n

After capacity pricing is added, you can use the \n \n GetDashboardEmbedUrl\n API operation with the \n --identity-type ANONYMOUS option.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#UnsupportedUserEditionException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this request.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

This error indicates that you are calling an operation on an Amazon QuickSight\n\t\t\tsubscription where the edition doesn't include support for that operation. Amazon\n\t\t\tAmazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and\n\t\t\tcapability is available in every edition.

", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.quicksight#UntagColumnOperation": { + "type": "structure", + "members": { + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", + "traits": { + "smithy.api#documentation": "

The column that this operation acts on.

", + "smithy.api#required": {} + } + }, + "TagNames": { + "target": "com.amazonaws.quicksight#ColumnTagNames", + "traits": { + "smithy.api#documentation": "

The column tags to remove from this column.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A transform operation that removes tags associated with a column.

" + } + }, + "com.amazonaws.quicksight#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Removes a tag or tags from a resource.

", + "smithy.api#http": { + "method": "DELETE", + "uri": "/resources/{ResourceArn}/tags", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource that you want to untag.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.quicksight#TagKeyList", + "traits": { + "smithy.api#documentation": "

The keys of the key-value pairs for the resource tag or tags assigned to the resource.

", + "smithy.api#httpQuery": "keys", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UntagResourceResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomization": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomizationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAccountCustomizationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme.

\n

You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a\n Amazon QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an Amazon Web Services account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/customizations", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that you want to update Amazon QuickSight customizations for.

", + "smithy.api#httpQuery": "namespace" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountCustomizationResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations\n for.

" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace associated with the customization that you're updating.

" + } + }, + "AccountCustomization": { + "target": "com.amazonaws.quicksight#AccountCustomization", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAccountSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAccountSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the Amazon QuickSight settings in your Amazon Web Services account.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAccountSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to\n list.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DefaultNamespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The default namespace for this Amazon Web Services account. Currently, the default is\n default. IAM users that\n register for the first time with Amazon QuickSight provide an email address that becomes\n associated with the default namespace.\n

", + "smithy.api#required": {} + } + }, + "NotificationEmail": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address that you want Amazon QuickSight to send notifications to regarding your\n Amazon Web Services account or Amazon QuickSight subscription.

" + } + }, + "TerminationProtectionEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysis": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an analysis in Amazon QuickSight

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the read and write permissions for an analysis.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/analyses/{AnalysisId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis whose permissions you're\n updating. You must be using the Amazon Web Services account that the analysis is in.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the permissions to add and the principal to add them\n to.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the permissions to remove and the principal to remove them\n from.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { + "type": "structure", + "members": { + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the analysis that you updated.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis that you updated permissions for.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A structure that describes the principals and the resource-level permissions on an\n analysis.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the analysis that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the analysis that you're updating. This ID displays in the URL of the\n analysis.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", + "traits": { + "smithy.api#documentation": "

A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the Amazon QuickSight console.

", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.

" + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "

A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're\n creating. To see the theme in the Amazon QuickSight console, make sure that you have access to\n it.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#AnalysisDefinition", + "traits": { + "smithy.api#documentation": "

The definition of an analysis.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateAnalysisResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the analysis that you're updating.

" + } + }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the analysis.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the last update that was made to the analysis.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboard": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a dashboard in an Amazon Web Services account.

\n \n

Updating a Dashboard creates a new dashboard version but does not immediately publish\n the new version. You can update the published version of a dashboard by\n using the \n UpdateDashboardPublishedVersion\n API operation.

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinks": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardLinksRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardLinksResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the linked analyses on a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/linked-entities", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinksRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardLinksResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "LinkEntities": { + "target": "com.amazonaws.quicksight#LinkEntityArnList", + "traits": { + "smithy.api#documentation": "

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates read and write permissions on a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard whose permissions you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to grant on this resource.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to revoke from this resource.

" + } + }, + "GrantLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "

Grants link permissions to all users in a defined namespace.

" + } + }, + "RevokeLinkPermissions": { + "target": "com.amazonaws.quicksight#UpdateLinkPermissionList", + "traits": { + "smithy.api#documentation": "

Revokes link permissions from all users in a defined namespace.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse": { + "type": "structure", + "members": { + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions on the dashboard.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "LinkSharingConfiguration": { + "target": "com.amazonaws.quicksight#LinkSharingConfiguration", + "traits": { + "smithy.api#documentation": "

Updates the permissions of a shared link to an Amazon QuickSight dashboard.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the published version of a dashboard.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions/{VersionNumber}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { + "type": "structure", + "members": { + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dashboard.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the dashboard that you're\n updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "

The display name of the dashboard.

", + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you update the dashboard. In\n SourceEntity, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the \n CreateTemplate\n API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any Amazon Web Services account and any\n Amazon QuickSight-supported Amazon Web Services Region.

\n

Use the DataSetReferences entity within SourceTemplate to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.

" + } + }, + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", + "traits": { + "smithy.api#documentation": "

A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description for the first version of the dashboard being created.

" + } + }, + "DashboardPublishOptions": { + "target": "com.amazonaws.quicksight#DashboardPublishOptions", + "traits": { + "smithy.api#documentation": "

Options for publishing the dashboard when you create it:

\n " + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the\n dashboard.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#DashboardVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a dashboard.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDashboardResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the resource.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN of the dashboard, including the version number.

" + } + }, + "DashboardId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dashboard.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the request.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSet": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSetRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions on a dataset.

\n

The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to grant to the dataset.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to revoke from the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetPermissionsResponse": { + "type": "structure", + "members": { + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset whose permissions you want to update. This ID is unique per\n\t\t\tAmazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each\n\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the dataset.

", + "smithy.api#required": {} + } + }, + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", + "traits": { + "smithy.api#documentation": "

Declares the physical tables that are available in the underlying data sources.

", + "smithy.api#required": {} + } + }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "

Configures the combination and transformation of the data from the physical tables.

" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "

Indicates whether you want to import the data into SPICE.

", + "smithy.api#required": {} + } + }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

" + } + }, + "FieldFolders": { + "target": "com.amazonaws.quicksight#FieldFolderMap", + "traits": { + "smithy.api#documentation": "

The folder that contains fields and nested subfolders for your dataset.

" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "

The row-level security configuration for the data you want to create.

" + } + }, + "RowLevelPermissionTagConfiguration": { + "target": "com.amazonaws.quicksight#RowLevelPermissionTagConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.

" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "

A set of one or more definitions of a \n ColumnLevelPermissionRule\n .

" + } + }, + "DataSetUsageConfiguration": { + "target": "com.amazonaws.quicksight#DataSetUsageConfiguration" + }, + "DatasetParameters": { + "target": "com.amazonaws.quicksight#DatasetParameterList", + "traits": { + "smithy.api#documentation": "

The parameter declarations of the dataset.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSetResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

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.

" + } + }, + "IngestionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "IngestionId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSource": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSourceRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#CustomerManagedKeyUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a data source.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions to a data source.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/data-sources/{DataSourceId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that you want to grant on the data source.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions that you want to revoke on the data source.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { + "type": "structure", + "members": { + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourceRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

A display name for the data source.

", + "smithy.api#required": {} + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "

The parameters that Amazon QuickSight uses to connect to your underlying source.

" + } + }, + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", + "traits": { + "smithy.api#documentation": "

The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.

" + } + }, + "VpcConnectionProperties": { + "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "traits": { + "smithy.api#documentation": "

Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.

" + } + }, + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "

Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying\n\t\t\tsource.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateDataSourceResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the data source.

" + } + }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the data source's last update.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateFolder": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the name of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateFolderPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates permissions of a folder.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/folders/{FolderId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderPermissionsResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

Information about the permissions for the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that contains the folder to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#FolderName", + "traits": { + "smithy.api#documentation": "

The name of the folder.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateFolderResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the folder.

" + } + }, + "FolderId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the folder.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateGroup": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateGroupRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateGroupResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Changes a group description.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateGroupRequest": { + "type": "structure", + "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "

The name of the group that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "

The description for the group that you want to update.

" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the group that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateGroupResponse": { + "type": "structure", + "members": { + "Group": { + "target": "com.amazonaws.quicksight#Group", + "traits": { + "smithy.api#documentation": "

The name of the group.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignment": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConcurrentUpdatingException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an existing IAM policy assignment. This operation updates only\n\t\t\tthe optional parameter or parameters that are specified in the request. This overwrites\n\t\t\tall of the users included in Identities.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments/{AssignmentName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IAM policy\n\t\t\tassignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment, also called a rule.\n\t\t\tThe\n\t\t\tname must be unique within the\n\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace of the assignment.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy to apply to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that you want to assign the policy\n\t\t\tto.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { + "type": "structure", + "members": { + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "

The name of the assignment or rule.

" + } + }, + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the assignment.

" + } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the IAM policy applied to the Amazon QuickSight users and\n\t\t\tgroups specified in this assignment.

" + } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight users, groups, or both that the IAM policy is\n\t\t\tassigned to.

" + } + }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "

The status of the assignment. Possible values are as follows:

\n " + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfig": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access.

\n

This operation is only supported for Amazon QuickSight accounts using IAM Identity Center

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/identity-propagation-config/{Service}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfigRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Service": { + "target": "com.amazonaws.quicksight#ServiceType", + "traits": { + "smithy.api#documentation": "

The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AuthorizedTargets": { + "target": "com.amazonaws.quicksight#AuthorizedTargetsList", + "traits": { + "smithy.api#documentation": "

Specifies a list of application ARNs that represent the authorized targets for a service.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIdentityPropagationConfigResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateIpRestriction": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateIpRestrictionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/ip-restriction", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IpRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#IpRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map that describes the updated IP rules with CIDR ranges and descriptions.

" + } + }, + "VpcIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.

" + } + }, + "VpcEndpointIdRestrictionRuleMap": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap", + "traits": { + "smithy.api#documentation": "

A map of allowed VPC endpoint IDs and their corresponding rule descriptions.

" + } + }, + "Enabled": { + "target": "com.amazonaws.quicksight#NullableBoolean", + "traits": { + "smithy.api#documentation": "

A value that specifies whether IP rules are turned on.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateIpRestrictionResponse": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the IP rules.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateKeyRegistrationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateKeyRegistrationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a customer managed key in a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/key-registration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistrationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the customer managed key registration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "KeyRegistration": { + "target": "com.amazonaws.quicksight#KeyRegistration", + "traits": { + "smithy.api#documentation": "

A list of RegisteredCustomerManagedKey objects to be updated to the Amazon QuickSight account.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateKeyRegistrationResponse": { + "type": "structure", + "members": { + "FailedKeyRegistration": { + "target": "com.amazonaws.quicksight#FailedKeyRegistrationEntries", + "traits": { + "smithy.api#documentation": "

A list of all customer managed key registrations that failed to update.

" + } + }, + "SuccessfulKeyRegistration": { + "target": "com.amazonaws.quicksight#SuccessfulKeyRegistrationEntries", + "traits": { + "smithy.api#documentation": "

A list of all customer managed key registrations that were successfully updated.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateLinkPermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettings": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedPricingPlanException" + } + ], + "traits": { + "smithy.api#documentation": "

Use the UpdatePublicSharingSettings operation to turn on or turn off the\n public sharing settings of an Amazon QuickSight dashboard.

\n

To use this operation, turn on session capacity pricing for your Amazon QuickSight\n account.

\n

Before you can turn on public sharing on your account, make sure to give public sharing\n permissions to an administrative user in the Identity and Access Management (IAM)\n console. For more information on using IAM with Amazon QuickSight, see\n Using Amazon QuickSight with IAM in the Amazon QuickSight\n User Guide.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/public-sharing-settings", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID associated with your Amazon QuickSight subscription.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PublicSharingEnabled": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdatePublicSharingSettingsResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a refresh schedule for a dataset.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/data-sets/{DataSetId}/refresh-schedules", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleRequest": { + "type": "structure", + "members": { + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Schedule": { + "target": "com.amazonaws.quicksight#RefreshSchedule", + "traits": { + "smithy.api#documentation": "

The refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRefreshScheduleResponse": { + "type": "structure", + "members": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "ScheduleId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the refresh schedule.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the refresh schedule.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateResourcePermissionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ResourcePermission" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermission": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the custom permissions that are associated with a role.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/roles/{Role}/custom-permission", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionRequest": { + "type": "structure", + "members": { + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The name of the custom permission that you want to update the role with.

", + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#Role", + "traits": { + "smithy.api#documentation": "

The name of role tht you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace that contains the role that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateRoleCustomPermissionResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the SPICE capacity configuration for a Amazon QuickSight account.

", + "smithy.api#http": { + "method": "POST", + "uri": "/accounts/{AwsAccountId}/spice-capacity-configuration", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PurchaseMode": { + "target": "com.amazonaws.quicksight#PurchaseMode", + "traits": { + "smithy.api#documentation": "

Determines how SPICE capacity can be purchased. The following options are available.

\n ", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateSPICECapacityConfigurationResponse": { + "type": "structure", + "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplate": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplateRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplateResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a template from an existing Amazon QuickSight analysis or another template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplateAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the template alias of a template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template alias that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The alias of the template that you want to update. If you name a specific alias, you update\n\t\t\tthe version that the alias points to. You can specify the latest version of the template\n\t\t\tby providing the keyword $LATEST in the AliasName parameter.\n\t\t\tThe keyword $PUBLISHED doesn't apply to templates.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the template.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateAliasResponse": { + "type": "structure", + "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "

The template alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the resource permissions for a template.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/templates/{TemplateId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be granted on the template.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be revoked from the template.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "TemplateArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the template.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be set on the template.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the template that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", + "traits": { + "smithy.api#documentation": "

The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity, you specify the type of object you're using as source:\n\t\t\tSourceTemplate for a template or SourceAnalysis for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate, specify the ARN of the source template. For\n\t\t\tSourceAnalysis, specify the ARN of the source analysis. The SourceTemplate\n\t\t\tARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;.

\n

Use the DataSetReferences entity within SourceTemplate or\n\t\t\tSourceAnalysis to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.

" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription field.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", + "traits": { + "smithy.api#documentation": "

The name for the template.

" + } + }, + "Definition": { + "target": "com.amazonaws.quicksight#TemplateVersionDefinition", + "traits": { + "smithy.api#documentation": "

The definition of a template.

\n

A definition is the data model of all features in a Dashboard, Template, or Analysis.

" + } + }, + "ValidationStrategy": { + "target": "com.amazonaws.quicksight#ValidationStrategy", + "traits": { + "smithy.api#documentation": "

The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTemplateResponse": { + "type": "structure", + "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the template.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the template.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The ARN for the template, including the version information of the first version.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the template.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTheme": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemeRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a theme.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemeAlias": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemeAliasRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemeAliasResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an alias of a theme.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemeAliasRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme alias that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "

The name of the theme alias that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "

The version number of the theme that the alias should reference.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeAliasResponse": { + "type": "structure", + "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "

Information about the theme alias.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateThemePermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateThemePermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateThemePermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the resource permissions for a theme. Permissions apply to the action to grant or\n\t\t\trevoke permissions on, for example \"quicksight:DescribeTheme\".

\n

Theme permissions apply in groupings. Valid groupings include the following for the three\n\t\t\tlevels of permissions, which are user, owner, or no permissions:

\n ", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be granted for the theme.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions to be revoked from the theme.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the theme.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resulting list of resource permissions for the theme.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the theme that you're updating.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "

The name for the theme.

" + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default Amazon QuickSight theme.

", + "smithy.api#required": {} + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "

A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription.

" + } + }, + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", + "traits": { + "smithy.api#documentation": "

The theme configuration, which contains the theme display properties.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateThemeResponse": { + "type": "structure", + "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID for the theme.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the theme.

" + } + }, + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the new version of the theme.

" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "

The creation status of the theme.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopic": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a topic.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissions": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicPermissionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates the permissions of a topic.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/permissions", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissionsRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to update\n the permissions for.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to grant to the topic.

" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "

The resource permissions that you want to revoke from the topic.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicPermissionsResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "

A list of resource permissions on the topic.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceExistsException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a topic refresh schedule.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/topics/{TopicId}/schedules/{DatasetId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic whose refresh schedule\n you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "DatasetId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ID of the dataset.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RefreshSchedule": { + "target": "com.amazonaws.quicksight#TopicRefreshSchedule", + "traits": { + "smithy.api#documentation": "

The definition of a refresh schedule.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRefreshScheduleResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "TopicArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "DatasetArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the dataset.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID of the Amazon Web Services account that contains the topic that you want to\n update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Topic": { + "target": "com.amazonaws.quicksight#TopicDetails", + "traits": { + "smithy.api#documentation": "

The definition of the topic that you want to update.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateTopicResponse": { + "type": "structure", + "members": { + "TopicId": { + "target": "com.amazonaws.quicksight#TopicId", + "traits": { + "smithy.api#documentation": "

The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic.

" + } + }, + "RefreshArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the topic refresh.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateUserRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#PreconditionNotMetException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ResourceUnavailableException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates an Amazon QuickSight user.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateUserRequest": { + "type": "structure", + "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user name that you want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the\n\t\t\tAmazon Web Services account that contains your Amazon QuickSight account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "

The namespace. Currently, you should set this to default.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The email address of the user that you want to update.

", + "smithy.api#required": {} + } + }, + "Role": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role of the user. The role can be one of the\n\t\t\tfollowing default security cohorts:

\n \n

The name of the Amazon QuickSight role is invisible to the user except for the console\n\t screens dealing with permissions.

", + "smithy.api#required": {} + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:

\n \n

A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the Amazon QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a Amazon QuickSight user.

\n

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning Amazon QuickSight users to one of the\n default security cohorts in Amazon QuickSight (admin, author, reader).

\n

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

" + } + }, + "UnapplyCustomPermissions": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

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.

\n " + } + }, + "CustomFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for a user in the external login provider.

" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateUserResponse": { + "type": "structure", + "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight user.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UpdateVPCConnection": { + "type": "operation", + "input": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionRequest" + }, + "output": { + "target": "com.amazonaws.quicksight#UpdateVPCConnectionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.quicksight#AccessDeniedException" + }, + { + "target": "com.amazonaws.quicksight#ConflictException" + }, + { + "target": "com.amazonaws.quicksight#InternalFailureException" + }, + { + "target": "com.amazonaws.quicksight#InvalidParameterValueException" + }, + { + "target": "com.amazonaws.quicksight#LimitExceededException" + }, + { + "target": "com.amazonaws.quicksight#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.quicksight#ThrottlingException" + }, + { + "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" + } + ], + "traits": { + "smithy.api#documentation": "

Updates a VPC connection.

", + "smithy.api#http": { + "method": "PUT", + "uri": "/accounts/{AwsAccountId}/vpc-connections/{VPCConnectionId}", + "code": 200 + } + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionRequest": { + "type": "structure", + "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services account ID of the account that contains the VPC connection that\n\t\t\tyou want to update.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n\t\t\tyou're updating. This ID is a unique identifier for each Amazon Web Services Region in an\n\t\t\t\tAmazon Web Services account.

", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SubnetIds": { + "target": "com.amazonaws.quicksight#SubnetIdList", + "traits": { + "smithy.api#documentation": "

A list of subnet IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

A list of security group IDs for the VPC connection.

", + "smithy.api#required": {} + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#DnsResolverList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#RoleArn", + "traits": { + "smithy.api#documentation": "

An IAM role associated with the VPC connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.quicksight#UpdateVPCConnectionResponse": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.

" + } + }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The update status of the VPC connection's last update.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon Web Services request ID for this operation.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The HTTP status of the request.

", + "smithy.api#httpResponseCode": {} + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, + "com.amazonaws.quicksight#UploadSettings": { + "type": "structure", + "members": { + "Format": { + "target": "com.amazonaws.quicksight#FileFormat", + "traits": { + "smithy.api#documentation": "

File format.

" + } + }, + "StartFromRow": { + "target": "com.amazonaws.quicksight#PositiveInteger", + "traits": { + "smithy.api#documentation": "

A row number to start reading data from.

" + } + }, + "ContainsHeader": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "

Whether the file has a header row, or the files each have a header row.

" + } + }, + "TextQualifier": { + "target": "com.amazonaws.quicksight#TextQualifier", + "traits": { + "smithy.api#documentation": "

Text qualifier.

" + } + }, + "Delimiter": { + "target": "com.amazonaws.quicksight#Delimiter", + "traits": { + "smithy.api#documentation": "

The delimiter between values in the file.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

Information about the format for a source file or files.

" + } + }, + "com.amazonaws.quicksight#User": { + "type": "structure", + "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the user.

" + } + }, + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "

The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is\n N/A when the value for IdentityType is IAM\n and the corresponding IAM user is deleted.

" + } + }, + "Email": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The user's email address.

" + } + }, + "Role": { + "target": "com.amazonaws.quicksight#UserRole", + "traits": { + "smithy.api#documentation": "

The Amazon QuickSight role for the user. The user role can be one of the\n following:.

\n " + } + }, + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", + "traits": { + "smithy.api#documentation": "

The type of identity authentication used by the user.

" + } + }, + "Active": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "

The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a\n password.

" + } + }, + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The principal ID of the user.

" + } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "

The custom permissions profile associated with this user.

" + } + }, + "ExternalLoginFederationProviderType": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The type of supported external login provider that provides identity to let the user\n federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.

\n " + } + }, + "ExternalLoginFederationProviderUrl": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The URL of the external login provider.

" + } + }, + "ExternalLoginId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The identity ID for the user in the external login provider.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A registered user of Amazon QuickSight.

" + } + }, + "com.amazonaws.quicksight#UserList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#User" + } + }, + "com.amazonaws.quicksight#UserName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1 + }, + "smithy.api#pattern": "^[\\u0020-\\u00FF]+$" + } + }, + "com.amazonaws.quicksight#UserRole": { + "type": "enum", + "members": { + "ADMIN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN" + } + }, + "AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR" + } + }, + "READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER" + } + }, + "RESTRICTED_AUTHOR": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED_AUTHOR" + } + }, + "RESTRICTED_READER": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RESTRICTED_READER" + } + }, + "ADMIN_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ADMIN_PRO" + } + }, + "AUTHOR_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTHOR_PRO" + } + }, + "READER_PRO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "READER_PRO" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnection": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

A list of network interfaces.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the\n IAM role associated with the VPC\n connection.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The structure of a VPC connection.

" + } + }, + "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus": { + "type": "enum", + "members": { + "AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AVAILABLE" + } + }, + "UNAVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UNAVAILABLE" + } + }, + "PARTIALLY_AVAILABLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PARTIALLY_AVAILABLE" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdRestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + }, + "smithy.api#pattern": "^[\\w\\-]+$" + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1000 + } + } + }, + "com.amazonaws.quicksight#VPCConnectionResourceStatus": { + "type": "enum", + "members": { + "CREATION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_IN_PROGRESS" + } + }, + "CREATION_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_SUCCESSFUL" + } + }, + "CREATION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "CREATION_FAILED" + } + }, + "UPDATE_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_IN_PROGRESS" + } + }, + "UPDATE_SUCCESSFUL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_SUCCESSFUL" + } + }, + "UPDATE_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "UPDATE_FAILED" + } + }, + "DELETION_IN_PROGRESS": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_IN_PROGRESS" + } + }, + "DELETION_FAILED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETION_FAILED" + } + }, + "DELETED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DELETED" + } + } + } + }, + "com.amazonaws.quicksight#VPCConnectionSummary": { + "type": "structure", + "members": { + "VPCConnectionId": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceIdUnrestricted", + "traits": { + "smithy.api#documentation": "

The ID of the VPC connection that\n you're\n creating. This ID is a unique identifier for each Amazon Web Services Region in an\n Amazon Web Services account.

" + } + }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the VPC connection.

" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", + "traits": { + "smithy.api#documentation": "

The display name for the VPC connection.

" + } + }, + "VPCId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 VPC ID associated with the VPC connection.

" + } + }, + "SecurityGroupIds": { + "target": "com.amazonaws.quicksight#SecurityGroupIdList", + "traits": { + "smithy.api#documentation": "

The Amazon EC2 security group IDs associated with the VPC connection.

" + } + }, + "DnsResolvers": { + "target": "com.amazonaws.quicksight#StringList", + "traits": { + "smithy.api#documentation": "

A list of IP addresses of DNS resolver endpoints for the VPC connection.

" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#VPCConnectionResourceStatus", + "traits": { + "smithy.api#documentation": "

The status of the VPC connection.

" + } + }, + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#VPCConnectionAvailabilityStatus", + "traits": { + "smithy.api#documentation": "

The availability status of the VPC connection.

" + } + }, + "NetworkInterfaces": { + "target": "com.amazonaws.quicksight#NetworkInterfaceList", + "traits": { + "smithy.api#documentation": "

A list of network interfaces.

" + } + }, + "RoleArn": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

The ARN of the IAM role associated\n with the VPC connection.

" + } + }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was created.

" + } + }, + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The time that the VPC connection was last updated.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The summary metadata that describes a VPC connection.

" + } + }, + "com.amazonaws.quicksight#VPCConnectionSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VPCConnectionSummary" + } + }, + "com.amazonaws.quicksight#ValidationStrategy": { + "type": "structure", + "members": { + "Mode": { + "target": "com.amazonaws.quicksight#ValidationStrategyMode", + "traits": { + "smithy.api#documentation": "

The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

" + } + }, + "com.amazonaws.quicksight#ValidationStrategyMode": { + "type": "enum", + "members": { + "STRICT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "STRICT" + } + }, + "LENIENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LENIENT" + } + } + } + }, + "com.amazonaws.quicksight#ValueWhenUnsetOption": { + "type": "enum", + "members": { + "RECOMMENDED_VALUE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "RECOMMENDED_VALUE" + } + }, + "NULL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NULL" + } + } + } + }, + "com.amazonaws.quicksight#VersionDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.quicksight#VersionNumber": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1 + } + } + }, + "com.amazonaws.quicksight#VerticalTextAlignment": { + "type": "enum", + "members": { + "TOP": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "TOP" + } + }, + "MIDDLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MIDDLE" + } + }, + "BOTTOM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "BOTTOM" + } + }, + "AUTO": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "AUTO" + } + } + } + }, + "com.amazonaws.quicksight#Visibility": { + "type": "enum", + "members": { + "HIDDEN": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HIDDEN" + } + }, + "VISIBLE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "VISIBLE" + } + } + } + }, + "com.amazonaws.quicksight#VisiblePanelColumns": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisiblePanelRows": { + "type": "long", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisibleRangeOptions": { + "type": "structure", + "members": { + "PercentRange": { + "target": "com.amazonaws.quicksight#PercentVisibleRange", + "traits": { + "smithy.api#documentation": "

The percent range in the visible range.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The range options for the data zoom scroll bar.

" + } + }, + "com.amazonaws.quicksight#Visual": { + "type": "structure", + "members": { + "TableVisual": { + "target": "com.amazonaws.quicksight#TableVisual", + "traits": { + "smithy.api#documentation": "

A table visual.

\n

For more information, see Using tables as visuals in the Amazon QuickSight User Guide.

" + } + }, + "PivotTableVisual": { + "target": "com.amazonaws.quicksight#PivotTableVisual", + "traits": { + "smithy.api#documentation": "

A pivot table.

\n

For more information, see Using pivot tables in the Amazon QuickSight User Guide.

" + } + }, + "BarChartVisual": { + "target": "com.amazonaws.quicksight#BarChartVisual", + "traits": { + "smithy.api#documentation": "

A bar chart.

\n

For more information, see Using bar charts in the Amazon QuickSight User Guide.

" + } + }, + "KPIVisual": { + "target": "com.amazonaws.quicksight#KPIVisual", + "traits": { + "smithy.api#documentation": "

A key performance indicator (KPI).

\n

For more information, see Using KPIs in the Amazon QuickSight User Guide.

" + } + }, + "PieChartVisual": { + "target": "com.amazonaws.quicksight#PieChartVisual", + "traits": { + "smithy.api#documentation": "

A pie or donut chart.

\n

For more information, see Using pie charts in the Amazon QuickSight User Guide.

" + } + }, + "GaugeChartVisual": { + "target": "com.amazonaws.quicksight#GaugeChartVisual", + "traits": { + "smithy.api#documentation": "

A gauge chart.

\n

For more information, see Using gauge charts in the Amazon QuickSight User Guide.

" + } + }, + "LineChartVisual": { + "target": "com.amazonaws.quicksight#LineChartVisual", + "traits": { + "smithy.api#documentation": "

A line chart.

\n

For more information, see Using line charts in the Amazon QuickSight User Guide.

" + } + }, + "HeatMapVisual": { + "target": "com.amazonaws.quicksight#HeatMapVisual", + "traits": { + "smithy.api#documentation": "

A heat map.

\n

For more information, see Using heat maps in the Amazon QuickSight User Guide.

" + } + }, + "TreeMapVisual": { + "target": "com.amazonaws.quicksight#TreeMapVisual", + "traits": { + "smithy.api#documentation": "

A tree map.

\n

For more information, see Using tree maps in the Amazon QuickSight User Guide.

" + } + }, + "GeospatialMapVisual": { + "target": "com.amazonaws.quicksight#GeospatialMapVisual", + "traits": { + "smithy.api#documentation": "

A geospatial map or a points on map visual.

\n

For more information, see Creating point maps in the Amazon QuickSight User Guide.

" + } + }, + "FilledMapVisual": { + "target": "com.amazonaws.quicksight#FilledMapVisual", + "traits": { + "smithy.api#documentation": "

A filled map.

\n

For more information, see Creating filled maps in the Amazon QuickSight User Guide.

" + } + }, + "FunnelChartVisual": { + "target": "com.amazonaws.quicksight#FunnelChartVisual", + "traits": { + "smithy.api#documentation": "

A funnel chart.

\n

For more information, see Using funnel charts in the Amazon QuickSight User Guide.

" + } + }, + "ScatterPlotVisual": { + "target": "com.amazonaws.quicksight#ScatterPlotVisual", + "traits": { + "smithy.api#documentation": "

A scatter plot.

\n

For more information, see Using scatter plots in the Amazon QuickSight User Guide.

" + } + }, + "ComboChartVisual": { + "target": "com.amazonaws.quicksight#ComboChartVisual", + "traits": { + "smithy.api#documentation": "

A combo chart.

\n

For more information, see Using combo charts in the Amazon QuickSight User Guide.

" + } + }, + "BoxPlotVisual": { + "target": "com.amazonaws.quicksight#BoxPlotVisual", + "traits": { + "smithy.api#documentation": "

A box plot.

\n

For more information, see Using box plots in the Amazon QuickSight User Guide.

" + } + }, + "WaterfallVisual": { + "target": "com.amazonaws.quicksight#WaterfallVisual", + "traits": { + "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" + } + }, + "HistogramVisual": { + "target": "com.amazonaws.quicksight#HistogramVisual", + "traits": { + "smithy.api#documentation": "

A histogram.

\n

For more information, see Using histograms in the Amazon QuickSight User Guide.

" + } + }, + "WordCloudVisual": { + "target": "com.amazonaws.quicksight#WordCloudVisual", + "traits": { + "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" + } + }, + "InsightVisual": { + "target": "com.amazonaws.quicksight#InsightVisual", + "traits": { + "smithy.api#documentation": "

An insight visual.

\n

For more information, see Working with insights in the Amazon QuickSight User Guide.

" + } + }, + "SankeyDiagramVisual": { + "target": "com.amazonaws.quicksight#SankeyDiagramVisual", + "traits": { + "smithy.api#documentation": "

A sankey diagram.

\n

For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.

" + } + }, + "CustomContentVisual": { + "target": "com.amazonaws.quicksight#CustomContentVisual", + "traits": { + "smithy.api#documentation": "

A visual that contains custom content.

\n

For more information, see Using custom visual content in the Amazon QuickSight User Guide.

" + } + }, + "EmptyVisual": { + "target": "com.amazonaws.quicksight#EmptyVisual", + "traits": { + "smithy.api#documentation": "

An empty visual.

" + } + }, + "RadarChartVisual": { + "target": "com.amazonaws.quicksight#RadarChartVisual", + "traits": { + "smithy.api#documentation": "

A radar chart visual.

\n

For more information, see Using radar charts in the Amazon QuickSight User Guide.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A visual displayed on a sheet in an analysis, dashboard, or template.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#VisualAxisSortOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availaiblity status of a visual's axis sort options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The axis sort options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualCustomAction": { + "type": "structure", + "members": { + "CustomActionId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

The ID of the VisualCustomAction.

", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.quicksight#VisualCustomActionName", + "traits": { + "smithy.api#documentation": "

The name of the VisualCustomAction.

", + "smithy.api#required": {} + } + }, + "Status": { + "target": "com.amazonaws.quicksight#WidgetStatus", + "traits": { + "smithy.api#documentation": "

The status of the VisualCustomAction.

" + } + }, + "Trigger": { + "target": "com.amazonaws.quicksight#VisualCustomActionTrigger", + "traits": { + "smithy.api#documentation": "

The trigger of the VisualCustomAction.

\n

Valid values are defined as follows:

\n ", + "smithy.api#required": {} + } + }, + "ActionOperations": { + "target": "com.amazonaws.quicksight#VisualCustomActionOperationList", + "traits": { + "smithy.api#documentation": "

A list of VisualCustomActionOperations.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

A custom action defined on a visual.

" + } + }, + "com.amazonaws.quicksight#VisualCustomActionList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VisualCustomAction" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 256 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionOperation": { + "type": "structure", + "members": { + "FilterOperation": { + "target": "com.amazonaws.quicksight#CustomActionFilterOperation", + "traits": { + "smithy.api#documentation": "

The filter operation that filters data included in a visual or in an entire sheet.

" + } + }, + "NavigationOperation": { + "target": "com.amazonaws.quicksight#CustomActionNavigationOperation", + "traits": { + "smithy.api#documentation": "

The navigation operation that navigates between different sheets in the same analysis.

" + } + }, + "URLOperation": { + "target": "com.amazonaws.quicksight#CustomActionURLOperation", + "traits": { + "smithy.api#documentation": "

The URL operation that opens a link to another webpage.

" + } + }, + "SetParametersOperation": { + "target": "com.amazonaws.quicksight#CustomActionSetParametersOperation", + "traits": { + "smithy.api#documentation": "

The set parameter operation that sets parameters in custom action.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The operation that is defined by the custom action.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#VisualCustomActionOperationList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#VisualCustomActionOperation" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2 + } + } + }, + "com.amazonaws.quicksight#VisualCustomActionTrigger": { + "type": "enum", + "members": { + "DATA_POINT_CLICK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_CLICK" + } + }, + "DATA_POINT_MENU": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DATA_POINT_MENU" + } + } + } + }, + "com.amazonaws.quicksight#VisualInteractionOptions": { + "type": "structure", + "members": { + "VisualMenuOption": { + "target": "com.amazonaws.quicksight#VisualMenuOption", + "traits": { + "smithy.api#documentation": "

The on-visual menu options for a visual.

" + } + }, + "ContextMenuOption": { + "target": "com.amazonaws.quicksight#ContextMenuOption", + "traits": { + "smithy.api#documentation": "

The context menu options for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for visual publish options

" + } + }, + "com.amazonaws.quicksight#VisualList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#Visual" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.quicksight#VisualMenuOption": { + "type": "structure", + "members": { + "AvailabilityStatus": { + "target": "com.amazonaws.quicksight#DashboardBehavior", + "traits": { + "smithy.api#documentation": "

The availaiblity status of a visual's menu options.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The menu options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualOptions": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.quicksight#LimitedString", + "traits": { + "smithy.api#documentation": "

The type for a VisualOptions.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The definition for a VisualOptions.

" + } + }, + "com.amazonaws.quicksight#VisualPalette": { + "type": "structure", + "members": { + "ChartColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

The chart color options for the visual palette.

" + } + }, + "ColorMap": { + "target": "com.amazonaws.quicksight#DataPathColorList", + "traits": { + "smithy.api#documentation": "

The color map options for the visual palette.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The visual display options for the visual palette.

" + } + }, + "com.amazonaws.quicksight#VisualRole": { + "type": "enum", + "members": { + "PRIMARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "PRIMARY" + } + }, + "COMPLIMENTARY": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "COMPLIMENTARY" + } + }, + "MULTI_INTENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MULTI_INTENT" + } + }, + "FALLBACK": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FALLBACK" + } + }, + "FRAGMENT": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FRAGMENT" + } + } + } + }, + "com.amazonaws.quicksight#VisualSubtitleLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the subtitle label.

" + } + }, + "FormatText": { + "target": "com.amazonaws.quicksight#LongFormatText", + "traits": { + "smithy.api#documentation": "

The long text format of the subtitle label, such as plain text or rich text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The subtitle label options for a visual.

" + } + }, + "com.amazonaws.quicksight#VisualTitleLabelOptions": { + "type": "structure", + "members": { + "Visibility": { + "target": "com.amazonaws.quicksight#Visibility", + "traits": { + "smithy.api#documentation": "

The visibility of the title label.

" + } + }, + "FormatText": { + "target": "com.amazonaws.quicksight#ShortFormatText", + "traits": { + "smithy.api#documentation": "

The short text format of the title label, such as plain text or rich text.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The title label options for a visual.

" + } + }, + "com.amazonaws.quicksight#VpcConnectionProperties": { + "type": "structure", + "members": { + "VpcConnectionArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "

The Amazon Resource Name (ARN) for the VPC connection.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

VPC connection properties.

" + } + }, + "com.amazonaws.quicksight#VpcEndpointId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpce-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#VpcEndpointId" + }, + "value": { + "target": "com.amazonaws.quicksight#VpcEndpointIdRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#VpcId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^vpc-[0-9a-z]*$" + } + }, + "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 150 + } + } + }, + "com.amazonaws.quicksight#VpcIdRestrictionRuleMap": { + "type": "map", + "key": { + "target": "com.amazonaws.quicksight#VpcId" + }, + "value": { + "target": "com.amazonaws.quicksight#VpcIdRestrictionRuleDescription" + } + }, + "com.amazonaws.quicksight#Warehouse": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells": { + "type": "structure", + "members": { + "Categories": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The category field wells of a waterfall visual.

" + } + }, + "Values": { + "target": "com.amazonaws.quicksight#MeasureFieldList", + "traits": { + "smithy.api#documentation": "

The value field wells of a waterfall visual.

" + } + }, + "Breakdowns": { + "target": "com.amazonaws.quicksight#DimensionFieldList", + "traits": { + "smithy.api#documentation": "

The breakdown field wells of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartColorConfiguration": { + "type": "structure", + "members": { + "GroupColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#WaterfallChartFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" + } + }, + "WaterfallChartOptions": { + "target": "com.amazonaws.quicksight#WaterfallChartOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" + } + }, + "CategoryAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the category axis label.

" + } + }, + "CategoryAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the category axis.

" + } + }, + "PrimaryYAxisLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis label.

" + } + }, + "PrimaryYAxisDisplayOptions": { + "target": "com.amazonaws.quicksight#AxisDisplayOptions", + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of the y-axis.

" + } + }, + "Legend": { + "target": "com.amazonaws.quicksight#LegendOptions", + "traits": { + "smithy.api#documentation": "

The legend configuration of a waterfall visual.

" + } + }, + "DataLabels": { + "target": "com.amazonaws.quicksight#DataLabelOptions", + "traits": { + "smithy.api#documentation": "

The data label configuration of a waterfall visual.

" + } + }, + "VisualPalette": { + "target": "com.amazonaws.quicksight#VisualPalette", + "traits": { + "smithy.api#documentation": "

The visual palette configuration of a waterfall visual.

" + } + }, + "ColorConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartColorConfiguration", + "traits": { + "smithy.api#documentation": "

The color configuration of a waterfall visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration for a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartFieldWells": { + "type": "structure", + "members": { + "WaterfallChartAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#WaterfallChartAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field well configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartGroupColorConfiguration": { + "type": "structure", + "members": { + "PositiveBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the positive bars of a waterfall chart.

" + } + }, + "NegativeBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the negative bars of a waterfall chart.

" + } + }, + "TotalBarColor": { + "target": "com.amazonaws.quicksight#HexColor", + "traits": { + "smithy.api#documentation": "

Defines the color for the total bars of a waterfall chart.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The color configuration for individual groups within a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartOptions": { + "type": "structure", + "members": { + "TotalBarLabel": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "

This option determines the total bar label of a waterfall visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The options that determine the presentation of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallChartSortConfiguration": { + "type": "structure", + "members": { + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of the category fields.

" + } + }, + "BreakdownItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of bar groups that are displayed.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a waterfall visual.

" + } + }, + "com.amazonaws.quicksight#WaterfallVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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.

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#WaterfallChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration for a waterfall visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A waterfall chart.

\n

For more information, see Using waterfall charts in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#WhatIfPointScenario": { + "type": "structure", + "members": { + "Date": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The date that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The target value that you want to meet for the provided date.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date.

" + } + }, + "com.amazonaws.quicksight#WhatIfRangeScenario": { + "type": "structure", + "members": { + "StartDate": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The start date in the date range that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "EndDate": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "

The end date in the date range that you need the forecast results for.

", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.quicksight#Double", + "traits": { + "smithy.api#default": 0, + "smithy.api#documentation": "

The target value that you want to meet for the provided date range.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

Provides the forecast to meet the target for a particular date range.

" + } + }, + "com.amazonaws.quicksight#WidgetStatus": { + "type": "enum", + "members": { + "ENABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ENABLED" + } + }, + "DISABLED": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "DISABLED" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudAggregatedFieldWells": { + "type": "structure", + "members": { + "GroupBy": { + "target": "com.amazonaws.quicksight#WordCloudDimensionFieldList", + "traits": { + "smithy.api#documentation": "

The group by field well of a word cloud. Values are grouped by group by fields.

" + } + }, + "Size": { + "target": "com.amazonaws.quicksight#WordCloudMeasureFieldList", + "traits": { + "smithy.api#documentation": "

The size field well of a word cloud. Values are aggregated based on group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" + } + }, + "com.amazonaws.quicksight#WordCloudChartConfiguration": { + "type": "structure", + "members": { + "FieldWells": { + "target": "com.amazonaws.quicksight#WordCloudFieldWells", + "traits": { + "smithy.api#documentation": "

The field wells of the visual.

" + } + }, + "SortConfiguration": { + "target": "com.amazonaws.quicksight#WordCloudSortConfiguration", + "traits": { + "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" + } + }, + "CategoryLabelOptions": { + "target": "com.amazonaws.quicksight#ChartAxisLabelOptions", + "traits": { + "smithy.api#documentation": "

The label options (label text, label visibility, and sort icon visibility) for the word cloud category.

" + } + }, + "WordCloudOptions": { + "target": "com.amazonaws.quicksight#WordCloudOptions", + "traits": { + "smithy.api#documentation": "

The options for a word cloud visual.

" + } + }, + "Interactions": { + "target": "com.amazonaws.quicksight#VisualInteractionOptions", + "traits": { + "smithy.api#documentation": "

The general visual interactions setup for a visual.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The configuration of a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudCloudLayout": { + "type": "enum", + "members": { + "FLUID": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "FLUID" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudDimensionFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#DimensionField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, + "com.amazonaws.quicksight#WordCloudFieldWells": { + "type": "structure", + "members": { + "WordCloudAggregatedFieldWells": { + "target": "com.amazonaws.quicksight#WordCloudAggregatedFieldWells", + "traits": { + "smithy.api#documentation": "

The aggregated field wells of a word cloud.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The field wells of a word cloud visual.

\n

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

" + } + }, + "com.amazonaws.quicksight#WordCloudMaximumStringLength": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.quicksight#WordCloudMeasureFieldList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#MeasureField" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1 + } + } + }, + "com.amazonaws.quicksight#WordCloudOptions": { + "type": "structure", + "members": { + "WordOrientation": { + "target": "com.amazonaws.quicksight#WordCloudWordOrientation", + "traits": { + "smithy.api#documentation": "

The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.

" + } + }, + "WordScaling": { + "target": "com.amazonaws.quicksight#WordCloudWordScaling", + "traits": { + "smithy.api#documentation": "

The word scaling options (emphasize, normal) for the words in a word cloud.

" + } + }, + "CloudLayout": { + "target": "com.amazonaws.quicksight#WordCloudCloudLayout", + "traits": { + "smithy.api#documentation": "

The cloud layout options (fluid, normal) of a word cloud.

" + } + }, + "WordCasing": { + "target": "com.amazonaws.quicksight#WordCloudWordCasing", + "traits": { + "smithy.api#documentation": "

The word casing options (lower_case, existing_case) for the words in a word cloud.

" + } + }, + "WordPadding": { + "target": "com.amazonaws.quicksight#WordCloudWordPadding", + "traits": { + "smithy.api#documentation": "

The word padding options (none, small, medium, large) for the words in a word cloud.

" + } + }, + "MaximumStringLength": { + "target": "com.amazonaws.quicksight#WordCloudMaximumStringLength", + "traits": { + "smithy.api#documentation": "

The length limit of each word from 1-100.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The word cloud options for a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudSortConfiguration": { + "type": "structure", + "members": { + "CategoryItemsLimit": { + "target": "com.amazonaws.quicksight#ItemsLimitConfiguration", + "traits": { + "smithy.api#documentation": "

The limit on the number of groups that are displayed in a word cloud.

" + } + }, + "CategorySort": { + "target": "com.amazonaws.quicksight#FieldSortOptionsList", + "traits": { + "smithy.api#documentation": "

The sort configuration of group by fields.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

The sort configuration of a word cloud visual.

" + } + }, + "com.amazonaws.quicksight#WordCloudVisual": { + "type": "structure", + "members": { + "VisualId": { + "target": "com.amazonaws.quicksight#ShortRestrictiveResourceId", + "traits": { + "smithy.api#documentation": "

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..

", + "smithy.api#required": {} + } + }, + "Title": { + "target": "com.amazonaws.quicksight#VisualTitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The title that is displayed on the visual.

" + } + }, + "Subtitle": { + "target": "com.amazonaws.quicksight#VisualSubtitleLabelOptions", + "traits": { + "smithy.api#documentation": "

The subtitle that is displayed on the visual.

" + } + }, + "ChartConfiguration": { + "target": "com.amazonaws.quicksight#WordCloudChartConfiguration", + "traits": { + "smithy.api#documentation": "

The configuration settings of the visual.

" + } + }, + "Actions": { + "target": "com.amazonaws.quicksight#VisualCustomActionList", + "traits": { + "smithy.api#documentation": "

The list of custom actions that are configured for a visual.

" + } + }, + "ColumnHierarchies": { + "target": "com.amazonaws.quicksight#ColumnHierarchyList", + "traits": { + "smithy.api#documentation": "

The column hierarchy that is used during drill-downs and drill-ups.

" + } + } + }, + "traits": { + "smithy.api#documentation": "

A word cloud.

\n

For more information, see Using word clouds in the Amazon QuickSight User Guide.

" + } + }, + "com.amazonaws.quicksight#WordCloudWordCasing": { + "type": "enum", + "members": { + "LOWER_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOWER_CASE" + } + }, + "EXISTING_CASE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EXISTING_CASE" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordOrientation": { + "type": "enum", + "members": { + "HORIZONTAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL" + } + }, + "HORIZONTAL_AND_VERTICAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "HORIZONTAL_AND_VERTICAL" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordPadding": { + "type": "enum", + "members": { + "NONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NONE" + } + }, + "SMALL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "SMALL" + } + }, + "MEDIUM": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "MEDIUM" + } + }, + "LARGE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LARGE" + } + } + } + }, + "com.amazonaws.quicksight#WordCloudWordScaling": { + "type": "enum", + "members": { + "EMPHASIZE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "EMPHASIZE" + } + }, + "NORMAL": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "NORMAL" + } + } + } + }, + "com.amazonaws.quicksight#WorkGroup": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.quicksight#YAxisOptions": { + "type": "structure", + "members": { + "YAxis": { + "target": "com.amazonaws.quicksight#SingleYAxisOption", + "traits": { + "smithy.api#documentation": "

The Y axis type to be used in the chart.

\n

If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.

", + "smithy.api#required": {} + } } + }, + "traits": { + "smithy.api#documentation": "

The options that are available for a single Y axis in a chart.

" + } } + } }