The AWS 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 access keys.
", "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 QuickSight subscription.
" } } }, "traits": { "smithy.api#documentation": "The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.
" } }, "com.amazonaws.quicksight#AccountSettings": { "type": "structure", "members": { "AccountName": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The \"account name\" you provided for the QuickSight subscription in your AWS account. \n You create this name when you sign up for QuickSight. It is unique in all of AWS and \n it appears only in the console when users sign in.
" } }, "Edition": { "target": "com.amazonaws.quicksight#Edition", "traits": { "smithy.api#documentation": "The edition of 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 QuickSight namespace for your AWS account.
" } }, "NotificationEmail": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The main notification email for your QuickSight subscription.
" } } }, "traits": { "smithy.api#documentation": "The QuickSight settings associated with your AWS account.
" } }, "com.amazonaws.quicksight#ActionList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#String" }, "traits": { "smithy.api#length": { "min": 1, "max": 16 } } }, "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 AWS 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": "Ad hoc (one-time) filtering option.
" } }, "com.amazonaws.quicksight#AdditionalDashboardIdList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#RestrictiveResourceId" }, "traits": { "smithy.api#length": { "min": 1, "max": 20 } } }, "com.amazonaws.quicksight#AliasName": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\w\\-]+|(\\$LATEST)|(\\$PUBLISHED)$" } }, "com.amazonaws.quicksight#AmazonElasticsearchParameters": { "type": "structure", "members": { "Domain": { "target": "com.amazonaws.quicksight#Domain", "traits": { "smithy.api#documentation": "The Amazon Elasticsearch Service domain.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Amazon Elasticsearch Service parameters.
" } }, "com.amazonaws.quicksight#Analysis": { "type": "structure", "members": { "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#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.
" } } }, "traits": { "smithy.api#documentation": "A metadata error structure for an analysis.
" } }, "com.amazonaws.quicksight#AnalysisErrorList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#AnalysisError" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.quicksight#AnalysisErrorType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ACCESS_DENIED", "name": "ACCESS_DENIED" }, { "value": "SOURCE_NOT_FOUND", "name": "SOURCE_NOT_FOUND" }, { "value": "DATA_SET_NOT_FOUND", "name": "DATA_SET_NOT_FOUND" }, { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" }, { "value": "PARAMETER_VALUE_INCOMPATIBLE", "name": "PARAMETER_VALUE_INCOMPATIBLE" }, { "value": "PARAMETER_TYPE_INVALID", "name": "PARAMETER_TYPE_INVALID" }, { "value": "PARAMETER_NOT_FOUND", "name": "PARAMETER_NOT_FOUND" }, { "value": "COLUMN_TYPE_MISMATCH", "name": "COLUMN_TYPE_MISMATCH" }, { "value": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "name": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" }, { "value": "COLUMN_REPLACEMENT_MISSING", "name": "COLUMN_REPLACEMENT_MISSING" } ] } }, "com.amazonaws.quicksight#AnalysisFilterAttribute": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "QUICKSIGHT_USER", "name": "QUICKSIGHT_USER" } ] } }, "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\n \"Operator\": \"StringEquals\".
The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_USER\".
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\".
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#RestrictiveResourceId", "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 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#Arn": { "type": "string" }, "com.amazonaws.quicksight#AssignmentStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DRAFT", "name": "DRAFT" }, { "value": "DISABLED", "name": "DISABLED" } ] } }, "com.amazonaws.quicksight#AthenaParameters": { "type": "structure", "members": { "WorkGroup": { "target": "com.amazonaws.quicksight#WorkGroup", "traits": { "smithy.api#documentation": "The workgroup that Amazon Athena uses.
" } } }, "traits": { "smithy.api#documentation": "Amazon Athena parameters.
" } }, "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": "Amazon Aurora parameters.
" } }, "com.amazonaws.quicksight#AuroraPostgreSqlParameters": { "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": "Amazon Aurora with PostgreSQL compatibility parameters.
" } }, "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": "AWS IoT Analytics parameters.
" } }, "com.amazonaws.quicksight#Boolean": { "type": "boolean" }, "com.amazonaws.quicksight#BorderStyle": { "type": "structure", "members": { "Show": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, "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#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#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 AWS 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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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": {} } }, "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#ClusterId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.quicksight#ColorList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#HexColor" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.quicksight#ColumnDataType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STRING", "name": "STRING" }, { "value": "INTEGER", "name": "INTEGER" }, { "value": "DECIMAL", "name": "DECIMAL" }, { "value": "DATETIME", "name": "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#ColumnId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "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 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#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#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 TagColumnOperation 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#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#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.quicksight#String" }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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#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#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 the current AWS Region. Currently, you can\n add a custom default theme by using the CreateAccountCustomization or\n UpdateAccountCustomization API operation. To further customize\n QuickSight by removing QuickSight sample assets and videos for all new users, see Customizing QuickSight in the Amazon QuickSight User\n Guide.\n
You can create customizations for your AWS 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 AWS account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
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 API operation.\n To share the theme, grant permissions by using the \n \n UpdateThemePermissions\n API operation.
The ID for the AWS account that you want to customize QuickSight for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { "smithy.api#documentation": "The QuickSight namespace that you want to add customizations to.
", "smithy.api#httpQuery": "namespace" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { "smithy.api#documentation": "The QuickSight customizations you're adding in the current AWS Region. You can add\n these to an AWS account and a QuickSight namespace.
\nFor 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 }.
A list of the tags that you want to attach to this resource.
" } } } }, "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 AWS account.
" } }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that you want to customize 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 QuickSight customizations you're adding in the current AWS Region.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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.
", "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 AWS account where you are creating an analysis.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 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 AWS Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions.
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.
", "smithy.api#required": {} } }, "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 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.
" } } } }, "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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#ResourceExistsException" }, { "target": "com.amazonaws.quicksight#ResourceNotFoundException" }, { "target": "com.amazonaws.quicksight#ThrottlingException" }, { "target": "com.amazonaws.quicksight#UnsupportedUserEditionException" } ], "traits": { "smithy.api#documentation": "Creates a dashboard from a template. To first create a template, see the \n CreateTemplate\n API operation.
A dashboard is an entity in QuickSight that identifies QuickSight reports, created\n from analyses. You can share 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 AWS 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 AWS account where you want to create the dashboard.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 \nTo 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 CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplateARN can contain any AWS Account and any\n QuickSight-supported AWS Region.
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.
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\n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.
\n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.
\n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.
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 AWS account where you create the\n dashboard.
" } } } }, "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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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.
", "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 AWS 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 AWS Region for each AWS 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 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.
" } }, "ColumnLevelPermissionRules": { "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", "traits": { "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
" } } } }, "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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 AWS 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 AWS Region for each AWS 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. Currently, the supported types for this operation are:\n\t\t\tATHENA, AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3,\n\t\t\tSNOWFLAKE, SPARK, SQLSERVER, TERADATA. \n\t\t\tUse ListDataSources to return a\n\t\t\tlist of all data sources.
\n AMAZON_ELASTICSEARCH is for Amazon managed Elasticsearch Service.
The parameters that QuickSight uses to connect to your underlying source.
" } }, "Credentials": { "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { "smithy.api#documentation": "The credentials 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 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 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.
" } } } }, "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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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": "Creates an Amazon QuickSight group.
\n\t\tThe permissions resource is\n\t\t\t\t\tarn:aws:quicksight:us-east-1:.
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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The group member.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The request object for this operation.
" } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } }, "traits": { "smithy.api#documentation": "The response object for this operation.
" } }, "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 Amazon Resource Name \n\t\t\t(ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.\n\t\t\tAssignment names are unique per AWS account. To avoid overwriting rules in other namespaces, \n\t\t\tuse assignment names that are unique.
", "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 AWS account where you want to assign an IAM policy to QuickSight users or\n\t\t\tgroups.
", "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. It must be unique within an AWS 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\t\t\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\t\tdata source.
The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { "smithy.api#documentation": "The QuickSight users, groups, or both that you want to assign the policy to.
" } }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { "smithy.api#documentation": "The namespace that contains the assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { "type": "structure", "members": { "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { "smithy.api#documentation": "The name of the assignment. This name must be unique within the AWS 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\t\t\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { "smithy.api#documentation": "The QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 on a dataset
\n\t\t \n\t\tAny 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 AWS 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 AWS account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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.
\nA namespace allows you to isolate the 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 AWS account is subscribed to\n QuickSight. The namespace must be unique within the AWS account. By default, there is a\n limit of 100 namespaces per AWS account. To increase your limit, create a ticket with\n AWS 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 AWS account that you want to create the 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.
The tags that you want to associate with the namespace that you're creating.
" } } } }, "com.amazonaws.quicksight#CreateNamespaceResponse": { "type": "structure", "members": { "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The ARN of the 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 AWS 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.
Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 from an existing QuickSight analysis or template. You can use the resulting\n\t\t\ttemplate to create a dashboard.
\n\t\tA template is an entity in 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 AWS account that contains the template that you creating an alias for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 QuickSight.
The version number of the template.
", "smithy.api#required": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#CreateTemplateRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "An ID for the template that you want to create. This template is unique per AWS Region in\n\t\t\teach AWS 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 AWS Account and any QuickSight-supported AWS Region.
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.
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.
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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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\t\tA 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 AWS account that contains the theme for the new theme alias.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
The version number of the theme.
", "smithy.api#required": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#CreateThemeRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account where you want to store the new theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "An ID for the theme that you want to create. The theme ID is unique per AWS Region in\n\t\t\teach AWS 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#RestrictiveResourceId", "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 a QuickSight analysis.
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.
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.
" } } } }, "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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#CredentialPair": { "type": "structure", "members": { "Username": { "target": "com.amazonaws.quicksight#UserName2", "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.
The combination of user name and password that are used as credentials.
" } }, "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#Dashboard": { "type": "structure", "members": { "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 dataset was created.
" } }, "LastPublishedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "The last time that this dataset was published.
" } }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "The last time that this dataset was updated.
" } } }, "traits": { "smithy.api#documentation": "Dashboard.
" } }, "com.amazonaws.quicksight#DashboardBehavior": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ENABLED", "name": "ENABLED" }, { "value": "DISABLED", "name": "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.
" } } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "ACCESS_DENIED", "name": "ACCESS_DENIED" }, { "value": "SOURCE_NOT_FOUND", "name": "SOURCE_NOT_FOUND" }, { "value": "DATA_SET_NOT_FOUND", "name": "DATA_SET_NOT_FOUND" }, { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" }, { "value": "PARAMETER_VALUE_INCOMPATIBLE", "name": "PARAMETER_VALUE_INCOMPATIBLE" }, { "value": "PARAMETER_TYPE_INVALID", "name": "PARAMETER_TYPE_INVALID" }, { "value": "PARAMETER_NOT_FOUND", "name": "PARAMETER_NOT_FOUND" }, { "value": "COLUMN_TYPE_MISMATCH", "name": "COLUMN_TYPE_MISMATCH" }, { "value": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH", "name": "COLUMN_GEOGRAPHIC_ROLE_MISMATCH" }, { "value": "COLUMN_REPLACEMENT_MISSING", "name": "COLUMN_REPLACEMENT_MISSING" } ] } }, "com.amazonaws.quicksight#DashboardFilterAttribute": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "QUICKSIGHT_USER", "name": "QUICKSIGHT_USER" } ] } }, "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.
" } } }, "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,\n \"Operator\": \"StringEquals\".
The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_USER\".
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\".
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#RestrictiveResourceId", "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": "string", "traits": { "smithy.api#enum": [ { "value": "EXPANDED", "name": "EXPANDED" }, { "value": "COLLAPSED", "name": "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#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#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.
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#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.
" } }, "ColumnLevelPermissionRules": { "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", "traits": { "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
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#DataSetImportMode": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "SPICE", "name": "SPICE" }, { "value": "DIRECT_QUERY", "name": "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#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#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.
" } }, "ColumnLevelPermissionRulesApplied": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "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#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 AWS Region for each AWS\n 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.
The VPC connection information. You need to use this parameter only when you want\n 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 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.
" } } }, "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 CredentialPair.
" } }, "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.
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": "string", "traits": { "smithy.api#enum": [ { "value": "ACCESS_DENIED", "name": "ACCESS_DENIED" }, { "value": "COPY_SOURCE_NOT_FOUND", "name": "COPY_SOURCE_NOT_FOUND" }, { "value": "TIMEOUT", "name": "TIMEOUT" }, { "value": "ENGINE_VERSION_NOT_SUPPORTED", "name": "ENGINE_VERSION_NOT_SUPPORTED" }, { "value": "UNKNOWN_HOST", "name": "UNKNOWN_HOST" }, { "value": "GENERIC_SQL_FAILURE", "name": "GENERIC_SQL_FAILURE" }, { "value": "CONFLICT", "name": "CONFLICT" }, { "value": "UNKNOWN", "name": "UNKNOWN" } ] } }, "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": "Amazon Elasticsearch Service parameters.
" } }, "AthenaParameters": { "target": "com.amazonaws.quicksight#AthenaParameters", "traits": { "smithy.api#documentation": "Amazon Athena parameters.
" } }, "AuroraParameters": { "target": "com.amazonaws.quicksight#AuroraParameters", "traits": { "smithy.api#documentation": "Amazon Aurora MySQL parameters.
" } }, "AuroraPostgreSqlParameters": { "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", "traits": { "smithy.api#documentation": "Aurora PostgreSQL parameters.
" } }, "AwsIotAnalyticsParameters": { "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", "traits": { "smithy.api#documentation": "AWS IoT Analytics parameters.
" } }, "JiraParameters": { "target": "com.amazonaws.quicksight#JiraParameters", "traits": { "smithy.api#documentation": "Jira parameters.
" } }, "MariaDbParameters": { "target": "com.amazonaws.quicksight#MariaDbParameters", "traits": { "smithy.api#documentation": "MariaDB parameters.
" } }, "MySqlParameters": { "target": "com.amazonaws.quicksight#MySqlParameters", "traits": { "smithy.api#documentation": "MySQL parameters.
" } }, "OracleParameters": { "target": "com.amazonaws.quicksight#OracleParameters", "traits": { "smithy.api#documentation": "Oracle parameters.
" } }, "PostgreSqlParameters": { "target": "com.amazonaws.quicksight#PostgreSqlParameters", "traits": { "smithy.api#documentation": "PostgreSQL parameters.
" } }, "PrestoParameters": { "target": "com.amazonaws.quicksight#PrestoParameters", "traits": { "smithy.api#documentation": "Presto parameters.
" } }, "RdsParameters": { "target": "com.amazonaws.quicksight#RdsParameters", "traits": { "smithy.api#documentation": "Amazon RDS parameters.
" } }, "RedshiftParameters": { "target": "com.amazonaws.quicksight#RedshiftParameters", "traits": { "smithy.api#documentation": "Amazon Redshift parameters.
" } }, "S3Parameters": { "target": "com.amazonaws.quicksight#S3Parameters", "traits": { "smithy.api#documentation": "S3 parameters.
" } }, "ServiceNowParameters": { "target": "com.amazonaws.quicksight#ServiceNowParameters", "traits": { "smithy.api#documentation": "ServiceNow parameters.
" } }, "SnowflakeParameters": { "target": "com.amazonaws.quicksight#SnowflakeParameters", "traits": { "smithy.api#documentation": "Snowflake parameters.
" } }, "SparkParameters": { "target": "com.amazonaws.quicksight#SparkParameters", "traits": { "smithy.api#documentation": "Spark parameters.
" } }, "SqlServerParameters": { "target": "com.amazonaws.quicksight#SqlServerParameters", "traits": { "smithy.api#documentation": "SQL Server parameters.
" } }, "TeradataParameters": { "target": "com.amazonaws.quicksight#TeradataParameters", "traits": { "smithy.api#documentation": "Teradata parameters.
" } }, "TwitterParameters": { "target": "com.amazonaws.quicksight#TwitterParameters", "traits": { "smithy.api#documentation": "Twitter parameters.
" } } }, "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#DataSourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ADOBE_ANALYTICS", "name": "ADOBE_ANALYTICS" }, { "value": "AMAZON_ELASTICSEARCH", "name": "AMAZON_ELASTICSEARCH" }, { "value": "ATHENA", "name": "ATHENA" }, { "value": "AURORA", "name": "AURORA" }, { "value": "AURORA_POSTGRESQL", "name": "AURORA_POSTGRESQL" }, { "value": "AWS_IOT_ANALYTICS", "name": "AWS_IOT_ANALYTICS" }, { "value": "GITHUB", "name": "GITHUB" }, { "value": "JIRA", "name": "JIRA" }, { "value": "MARIADB", "name": "MARIADB" }, { "value": "MYSQL", "name": "MYSQL" }, { "value": "ORACLE", "name": "ORACLE" }, { "value": "POSTGRESQL", "name": "POSTGRESQL" }, { "value": "PRESTO", "name": "PRESTO" }, { "value": "REDSHIFT", "name": "REDSHIFT" }, { "value": "S3", "name": "S3" }, { "value": "SALESFORCE", "name": "SALESFORCE" }, { "value": "SERVICENOW", "name": "SERVICENOW" }, { "value": "SNOWFLAKE", "name": "SNOWFLAKE" }, { "value": "SPARK", "name": "SPARK" }, { "value": "SQLSERVER", "name": "SQLSERVER" }, { "value": "TERADATA", "name": "TERADATA" }, { "value": "TWITTER", "name": "TWITTER" }, { "value": "TIMESTREAM", "name": "TIMESTREAM" } ] } }, "com.amazonaws.quicksight#Database": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } }, "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#TimestampList", "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#DateTimeParameterList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#DateTimeParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "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#DoubleList", "traits": { "smithy.api#documentation": "The values for the decimal parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A decimal parameter.
" } }, "com.amazonaws.quicksight#DecimalParameterList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#DecimalParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "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#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": "Deletes all Amazon QuickSight customizations in this AWS Region for the specified AWS\n account and 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 AWS account that you want to delete QuickSight customizations from in\n this AWS Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { "smithy.api#documentation": "The QuickSight namespace that you're deleting the customizations from.
", "smithy.api#httpQuery": "namespace" } } } }, "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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. 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, QuickSight deletes the analysis permanently.
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.
An analysis that's scheduled for deletion isn't accessible in the 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 AWS account where you want to delete an analysis.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 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.
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.
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#RestrictiveResourceId", "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 AWS request ID for this operation.
" } } } }, "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 AWS account that contains the dashboard that you're\n deleting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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" } } } }, "com.amazonaws.quicksight#DeleteDashboardResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "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#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the dashboard.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#DeleteDataSetRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS Region for each AWS account.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS Region for each AWS account.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account ID where you want to delete the IAM policy 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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that you want to delete the 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": {} } } } }, "com.amazonaws.quicksight#DeleteNamespaceResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that contains the item to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#DeleteTemplateRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the template that you're deleting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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
The AWS 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#RestrictiveResourceId", "traits": { "smithy.api#documentation": "An ID for the template.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that contains the theme alias to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "An ID for the theme associated with the deletion.
" } } } }, "com.amazonaws.quicksight#DeleteThemeRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're deleting.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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\t\t\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.
The Amazon Resource Name (ARN) of the resource.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "An ID for the theme.
" } } } }, "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 AWS\n\t\t\tIdentity and Access Management (IAM) 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 AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account and Amazon\n QuickSight namespace in an AWS Region. The QuickSight console evaluates which\n customizations to apply by running this API operation with the Resolved flag\n included.
To determine what customizations display when you run this command, it can help to\n visualize the relationship of the entities involved.
\n\n AWS Account - The AWS account exists at the top of the hierarchy.\n It has the potential to use all of the AWS Regions and AWS Services. When you\n subscribe to QuickSight, you choose one AWS Region to use as your home Region.\n That's where your free SPICE capacity is located. You can use QuickSight in any\n supported AWS Region.
\n AWS Region - In each AWS Region where you sign in to QuickSight\n at least once, QuickSight acts as a separate instance of the same service. If\n you have a user directory, it resides in us-east-1, which is the US East (N.\n Virginia). Generally speaking, these users have access to QuickSight in any AWS\n Region, unless they are constrained to a namespace.
To run the command in a different AWS Region, you change your Region settings.\n If you're using the AWS CLI, you can use one of the following options:
\nUse command line options.
\nUse named profiles.
\nRun aws configure to change your default AWS Region. Use\n Enter to key the same settings for your keys. For more information, see\n Configuring the AWS CLI.
\n Namespace - A QuickSight namespace is a partition that contains\n users and assets (data sources, datasets, dashboards, and so on). To access\n assets that are in a specific namespace, users and groups must also be part of\n the same namespace. People who share a namespace are completely isolated from\n users and assets in other namespaces, even if they are in the same AWS account\n and AWS Region.
\n Applied customizations - Within an AWS Region, a set of\n QuickSight customizations can apply to an AWS account or to a namespace.\n Settings that you apply to a namespace override settings that you apply to an\n AWS account. All settings are isolated to a single AWS Region. To apply them in\n other AWS Regions, run the CreateAccountCustomization command in\n each AWS Region where you want to apply the same customizations.
The ID for the AWS account that you want to describe QuickSight customizations\n for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { "smithy.api#documentation": "The QuickSight namespace that you want to describe QuickSight customizations\n for.
", "smithy.api#httpQuery": "namespace" } }, "Resolved": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#documentation": "The Resolved flag works with the other parameters to determine which view\n of QuickSight customizations is returned. You can add this flag to your command to use\n the same view that 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.
The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
" } }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that you're describing.
" } }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { "smithy.api#documentation": "The QuickSight namespace that you're describing.
" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { "smithy.api#documentation": "The QuickSight customizations that exist in the current AWS Region.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 QuickSight subscription was first\n created in this AWS 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 AWS account that contains the settings that you want to list.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { "type": "structure", "members": { "AccountSettings": { "target": "com.amazonaws.quicksight#AccountSettings", "traits": { "smithy.api#documentation": "The QuickSight settings for this AWS account. This information includes the edition of Amazon\n QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the\n QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes\n referred to as a QuickSight \"account\" even though it's technically not an account\n by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The\n edition that you subscribe to applies to QuickSight in every AWS Region where you use it.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 AWS account that contains the analysis whose permissions you're\n describing. You must be using the AWS account that the analysis is in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { "type": "structure", "members": { "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#DescribeAnalysisRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the analysis. You must be using the AWS\n account that the analysis is in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#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 AWS account that contains the dashboard that you're describing\n permissions for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { "type": "structure", "members": { "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#DescribeDashboardRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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" } } } }, "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#documentation": "The HTTP status of this request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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.
", "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\t\tThe permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
The AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#DescribeDataSetRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#DescribeDataSourceRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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 AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The name of the group.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 assignment 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 AWS account that contains the assignment that you want to describe.
", "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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS 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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that contains the 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": {} } } } }, "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, AWS 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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that contains the template alias that you're\n\t\t\tdescribing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
Information about the template alias.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that contains the template that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { "type": "structure", "members": { "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#DescribeTemplateRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the template that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
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.
The template structure for the object you want to describe.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that contains the theme alias that you're\n\t\t\tdescribing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that contains the theme that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the theme that you want to describe permissions for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { "type": "structure", "members": { "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#DescribeThemeRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAndAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
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.
The information about the theme that you are describing.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The user name.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS 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#Double": { "type": "double" }, "com.amazonaws.quicksight#DoubleList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#Double" } }, "com.amazonaws.quicksight#Edition": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STANDARD", "name": "STANDARD" }, { "value": "ENTERPRISE", "name": "ENTERPRISE" } ] } }, "com.amazonaws.quicksight#EmbeddingIdentityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IAM", "name": "IAM" }, { "value": "QUICKSIGHT", "name": "QUICKSIGHT" }, { "value": "ANONYMOUS", "name": "ANONYMOUS" } ] } }, "com.amazonaws.quicksight#EmbeddingUrl": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "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#ExceptionResourceType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "USER", "name": "USER" }, { "value": "GROUP", "name": "GROUP" }, { "value": "NAMESPACE", "name": "NAMESPACE" }, { "value": "ACCOUNT_SETTINGS", "name": "ACCOUNT_SETTINGS" }, { "value": "IAMPOLICY_ASSIGNMENT", "name": "IAMPOLICY_ASSIGNMENT" }, { "value": "DATA_SOURCE", "name": "DATA_SOURCE" }, { "value": "DATA_SET", "name": "DATA_SET" }, { "value": "VPC_CONNECTION", "name": "VPC_CONNECTION" }, { "value": "INGESTION", "name": "INGESTION" } ] } }, "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#Expression": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 4096 } } }, "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#FileFormat": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "CSV", "name": "CSV" }, { "value": "TSV", "name": "TSV" }, { "value": "CLF", "name": "CLF" }, { "value": "ELF", "name": "ELF" }, { "value": "XLSX", "name": "XLSX" }, { "value": "JSON", "name": "JSON" } ] } }, "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#FilterOperator": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "StringEquals", "name": "StringEquals" } ] } }, "com.amazonaws.quicksight#FolderColumnList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#String" }, "traits": { "smithy.api#length": { "min": 0, "max": 5000 } } }, "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.
", "smithy.api#required": {} } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "US", "name": "US" } ] } }, "com.amazonaws.quicksight#GeoSpatialDataRole": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "COUNTRY", "name": "COUNTRY" }, { "value": "STATE", "name": "STATE" }, { "value": "COUNTY", "name": "COUNTY" }, { "value": "CITY", "name": "CITY" }, { "value": "POSTCODE", "name": "POSTCODE" }, { "value": "LONGITUDE", "name": "LONGITUDE" }, { "value": "LATITUDE", "name": "LATITUDE" } ] } }, "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 session URL and authorization code that you can use to embed an Amazon\n QuickSight read-only dashboard in your web server code. Before you use this command,\n make sure that you have configured the dashboards and permissions.
\nCurrently, you can use GetDashboardEmbedURL only from the server, not\n from the user's browser. The following rules apply to the combination of URL and\n authorization code:
They must be used together.
\nThey can be used one time only.
\nThey are valid for 5 minutes after you run this command.
\nThe resulting user session is valid for 10 hours.
\nFor more information, see Embedded Analytics in the Amazon QuickSight User\n Guide.
", "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 AWS account that contains the dashboard that you're embedding.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the dashboard, also added to the AWS 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#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#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#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 (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 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.
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:
Active Directory (AD) users or group members
\n\t\t\tInvited nonfederated users
\n\t\t\tIAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.
\n\t\t\tOmit 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 QuickSight namespace that contains the dashboard IDs in this request.\n \t If you're not using a custom namespace, set this to \n \t \"default\".
A list of one or more dashboard IDs that you want to add to a session that includes\n anonymous users. The IdentityType parameter must be set to\n ANONYMOUS for this to work, because other identity types authenticate\n as QuickSight or IAM users. For example, if you set \"--dashboard-id dash_id1\n --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS\", the session\n can access all three dashboards.
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.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } }, "traits": { "smithy.api#documentation": "Output returned from the GetDashboardEmbedUrl operation.
Generates a session URL and authorization code that you can use to embed the Amazon\n 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 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 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:
The ID for the AWS account associated with your 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\n /start\n
\n /start/analyses\n
\n /start/dashboards\n
\n /start/favorites\n
\n /dashboards/DashboardId\n - where DashboardId is the actual ID key from the QuickSight console URL of the dashboard
\n /analyses/AnalysisId\n - where AnalysisId is the actual ID key from the QuickSight console URL of the analysis
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:
Active Directory (AD) users or group members
\n\t\t\tInvited nonfederated users
\n\t\t\tAWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated\n through Federated Single Sign-On using SAML, OpenID Connect, or IAM\n federation
\n\t\t\tOmit this parameter for users in the third group, IAM users and IAM role-based\n sessions.
", "smithy.api#httpQuery": "user-arn" } } } }, "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\tQuickSight 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.
The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#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#GutterStyle": { "type": "structure", "members": { "Show": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, "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#HexColor": { "type": "string", "traits": { "smithy.api#pattern": "^#[A-F0-9]{6}$" } }, "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 AWS 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 AWS 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#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": "string", "traits": { "smithy.api#enum": [ { "value": "QUICKSIGHT", "name": "QUICKSIGHT" } ] } }, "com.amazonaws.quicksight#IdentityType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "IAM", "name": "IAM" }, { "value": "QUICKSIGHT", "name": "QUICKSIGHT" } ] } }, "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.quicksight#String" }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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.
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#box": {}, "smithy.api#documentation": "The time that this ingestion took, measured in seconds.
" } }, "IngestionSizeInBytes": { "target": "com.amazonaws.quicksight#Long", "traits": { "smithy.api#box": {}, "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": "string", "traits": { "smithy.api#enum": [ { "value": "FAILURE_TO_ASSUME_ROLE", "name": "FAILURE_TO_ASSUME_ROLE" }, { "value": "INGESTION_SUPERSEDED", "name": "INGESTION_SUPERSEDED" }, { "value": "INGESTION_CANCELED", "name": "INGESTION_CANCELED" }, { "value": "DATA_SET_DELETED", "name": "DATA_SET_DELETED" }, { "value": "DATA_SET_NOT_SPICE", "name": "DATA_SET_NOT_SPICE" }, { "value": "S3_UPLOADED_FILE_DELETED", "name": "S3_UPLOADED_FILE_DELETED" }, { "value": "S3_MANIFEST_ERROR", "name": "S3_MANIFEST_ERROR" }, { "value": "DATA_TOLERANCE_EXCEPTION", "name": "DATA_TOLERANCE_EXCEPTION" }, { "value": "SPICE_TABLE_NOT_FOUND", "name": "SPICE_TABLE_NOT_FOUND" }, { "value": "DATA_SET_SIZE_LIMIT_EXCEEDED", "name": "DATA_SET_SIZE_LIMIT_EXCEEDED" }, { "value": "ROW_SIZE_LIMIT_EXCEEDED", "name": "ROW_SIZE_LIMIT_EXCEEDED" }, { "value": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED", "name": "ACCOUNT_CAPACITY_LIMIT_EXCEEDED" }, { "value": "CUSTOMER_ERROR", "name": "CUSTOMER_ERROR" }, { "value": "DATA_SOURCE_NOT_FOUND", "name": "DATA_SOURCE_NOT_FOUND" }, { "value": "IAM_ROLE_NOT_AVAILABLE", "name": "IAM_ROLE_NOT_AVAILABLE" }, { "value": "CONNECTION_FAILURE", "name": "CONNECTION_FAILURE" }, { "value": "SQL_TABLE_NOT_FOUND", "name": "SQL_TABLE_NOT_FOUND" }, { "value": "PERMISSION_DENIED", "name": "PERMISSION_DENIED" }, { "value": "SSL_CERTIFICATE_VALIDATION_FAILURE", "name": "SSL_CERTIFICATE_VALIDATION_FAILURE" }, { "value": "OAUTH_TOKEN_FAILURE", "name": "OAUTH_TOKEN_FAILURE" }, { "value": "SOURCE_API_LIMIT_EXCEEDED_FAILURE", "name": "SOURCE_API_LIMIT_EXCEEDED_FAILURE" }, { "value": "PASSWORD_AUTHENTICATION_FAILURE", "name": "PASSWORD_AUTHENTICATION_FAILURE" }, { "value": "SQL_SCHEMA_MISMATCH_ERROR", "name": "SQL_SCHEMA_MISMATCH_ERROR" }, { "value": "INVALID_DATE_FORMAT", "name": "INVALID_DATE_FORMAT" }, { "value": "INVALID_DATAPREP_SYNTAX", "name": "INVALID_DATAPREP_SYNTAX" }, { "value": "SOURCE_RESOURCE_LIMIT_EXCEEDED", "name": "SOURCE_RESOURCE_LIMIT_EXCEEDED" }, { "value": "SQL_INVALID_PARAMETER_VALUE", "name": "SQL_INVALID_PARAMETER_VALUE" }, { "value": "QUERY_TIMEOUT", "name": "QUERY_TIMEOUT" }, { "value": "SQL_NUMERIC_OVERFLOW", "name": "SQL_NUMERIC_OVERFLOW" }, { "value": "UNRESOLVABLE_HOST", "name": "UNRESOLVABLE_HOST" }, { "value": "UNROUTABLE_HOST", "name": "UNROUTABLE_HOST" }, { "value": "SQL_EXCEPTION", "name": "SQL_EXCEPTION" }, { "value": "S3_FILE_INACCESSIBLE", "name": "S3_FILE_INACCESSIBLE" }, { "value": "IOT_FILE_NOT_FOUND", "name": "IOT_FILE_NOT_FOUND" }, { "value": "IOT_DATA_SET_FILE_EMPTY", "name": "IOT_DATA_SET_FILE_EMPTY" }, { "value": "INVALID_DATA_SOURCE_CONFIG", "name": "INVALID_DATA_SOURCE_CONFIG" }, { "value": "DATA_SOURCE_AUTH_FAILED", "name": "DATA_SOURCE_AUTH_FAILED" }, { "value": "DATA_SOURCE_CONNECTION_FAILED", "name": "DATA_SOURCE_CONNECTION_FAILED" }, { "value": "FAILURE_TO_PROCESS_JSON_FILE", "name": "FAILURE_TO_PROCESS_JSON_FILE" }, { "value": "INTERNAL_SERVICE_ERROR", "name": "INTERNAL_SERVICE_ERROR" } ] } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "MANUAL", "name": "MANUAL" }, { "value": "SCHEDULED", "name": "SCHEDULED" } ] } }, "com.amazonaws.quicksight#IngestionRequestType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INITIAL_INGESTION", "name": "INITIAL_INGESTION" }, { "value": "EDIT", "name": "EDIT" }, { "value": "INCREMENTAL_REFRESH", "name": "INCREMENTAL_REFRESH" }, { "value": "FULL_REFRESH", "name": "FULL_REFRESH" } ] } }, "com.amazonaws.quicksight#IngestionStatus": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INITIALIZED", "name": "INITIALIZED" }, { "value": "QUEUED", "name": "QUEUED" }, { "value": "RUNNING", "name": "RUNNING" }, { "value": "FAILED", "name": "FAILED" }, { "value": "COMPLETED", "name": "COMPLETED" }, { "value": "CANCELLED", "name": "CANCELLED" } ] } }, "com.amazonaws.quicksight#Ingestions": { "type": "list", "member": { "target": "com.amazonaws.quicksight#Ingestion" } }, "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": {} } } }, "traits": { "smithy.api#documentation": "Metadata for a column that is used as the input of a transform operation.
" } }, "com.amazonaws.quicksight#InputColumnDataType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "STRING", "name": "STRING" }, { "value": "INTEGER", "name": "INTEGER" }, { "value": "DECIMAL", "name": "DECIMAL" }, { "value": "DATETIME", "name": "DATETIME" }, { "value": "BIT", "name": "BIT" }, { "value": "BOOLEAN", "name": "BOOLEAN" }, { "value": "JSON", "name": "JSON" } ] } }, "com.amazonaws.quicksight#InputColumnList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#InputColumn" }, "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.quicksight#InstanceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "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#LongList", "traits": { "smithy.api#documentation": "The values for the integer parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "An integer parameter.
" } }, "com.amazonaws.quicksight#IntegerParameterList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#IntegerParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "com.amazonaws.quicksight#InternalFailureException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.quicksight#String" }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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 AWS request ID for this request.
" } } }, "traits": { "smithy.api#documentation": "The NextToken value isn't valid.
The AWS 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#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": "Jira parameters.
" } }, "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.
The instructions associated with a join.
" } }, "com.amazonaws.quicksight#JoinKeyProperties": { "type": "structure", "members": { "UniqueKey": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, "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 QuickSight to optimize query performance.
" } } }, "traits": { "smithy.api#documentation": "Properties associated with the columns participating in a join.
" } }, "com.amazonaws.quicksight#JoinType": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "INNER", "name": "INNER" }, { "value": "OUTER", "name": "OUTER" }, { "value": "LEFT", "name": "LEFT" }, { "value": "RIGHT", "name": "RIGHT" } ] } }, "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 AWS request ID for this request.
" } } }, "traits": { "smithy.api#documentation": "A limit is exceeded.
", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "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 AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/analyses", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListAnalysesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "max-results" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 QuickSight subscription.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListDashboardVersionsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're listing versions\n for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/dashboards", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListDashboardsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS 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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account in an AWS Region.
\n\t\tThe permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
The AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS Region that belong to this AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/data-sources", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListDataSourcesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 } } }, "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#box": {}, "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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 } } }, "com.amazonaws.quicksight#ListGroupsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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#box": {}, "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. Currently, you should set this to default.
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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 IAM policy assignments in the current Amazon QuickSight account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", "code": 200 } } }, "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 the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM\n\t\t\tpolicies assigned to the specified user and group or groups that the user belongs\n\t\t\tto.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/iam-policy-assignments", "code": 200 } } }, "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "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": {} } } } }, "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 AWS 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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains these IAM policy assignments.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { "smithy.api#documentation": "The status of the assignments.
" } }, "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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", "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 AWS account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.quicksight#IngestionMaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/namespaces", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListNamespacesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that contains the QuickSight namespaces that you want to list.
", "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#box": {}, "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "max-results" } } } }, "com.amazonaws.quicksight#ListNamespacesResponse": { "type": "structure", "members": { "Namespaces": { "target": "com.amazonaws.quicksight#Namespaces", "traits": { "smithy.api#documentation": "The information about the namespaces in this AWS account. The response includes \n the namespace ARN, name, AWS Region, notification email address, creation status, and \n identity store.
" } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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": {} } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListTemplateAliasesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the template aliases that you're listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-result" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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.
" } } } }, "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", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListTemplateVersionsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the templates that you're listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListTemplatesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-result" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that contains the theme aliases that you're listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-result" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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.
" } } } }, "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 AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/themes/{ThemeId}/versions", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListThemeVersionsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the themes that you're listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account.
", "smithy.api#http": { "method": "GET", "uri": "/accounts/{AwsAccountId}/themes", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#ListThemesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "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 \t\n ALL (default)- Display all existing themes.
\n CUSTOM - Display only the themes created by people using Amazon QuickSight.
\n QUICKSIGHT - Display only the starting themes defined by QuickSight.
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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 } } }, "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 AWS account ID that the user is in. Currently, you use the ID for the AWS 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.
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#box": {}, "smithy.api#documentation": "The maximum number of results to return from this request.
", "smithy.api#httpQuery": "max-results" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 } } }, "com.amazonaws.quicksight#ListUsersRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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#box": {}, "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.
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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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.
" } }, "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#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.
" } } }, "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" }, "com.amazonaws.quicksight#LongList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#Long" } }, "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#MarginStyle": { "type": "structure", "members": { "Show": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, "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": "MariaDB parameters.
" } }, "com.amazonaws.quicksight#MaxResults": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 100 } } }, "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": "MySQL parameters.
" } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "PERMISSION_DENIED", "name": "PERMISSION_DENIED" }, { "value": "INTERNAL_SERVICE_ERROR", "name": "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 AWS 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": "string", "traits": { "smithy.api#enum": [ { "value": "CREATED", "name": "CREATED" }, { "value": "CREATING", "name": "CREATING" }, { "value": "DELETING", "name": "DELETING" }, { "value": "RETRYABLE_FAILURE", "name": "RETRYABLE_FAILURE" }, { "value": "NON_RETRYABLE_FAILURE", "name": "NON_RETRYABLE_FAILURE" } ] } }, "com.amazonaws.quicksight#Namespaces": { "type": "list", "member": { "target": "com.amazonaws.quicksight#NamespaceInfoV2" } }, "com.amazonaws.quicksight#NonEmptyString": { "type": "string", "traits": { "smithy.api#pattern": "\\S" } }, "com.amazonaws.quicksight#OnClause": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.quicksight#OptionalPort": { "type": "integer", "traits": { "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": "Port.
", "smithy.api#required": {} } }, "Database": { "target": "com.amazonaws.quicksight#Database", "traits": { "smithy.api#documentation": "Database.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "Oracle parameters.
" } }, "com.amazonaws.quicksight#OutputColumn": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.quicksight#ColumnName", "traits": { "smithy.api#documentation": "A display name for the dataset.
" } }, "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": "Type.
" } } }, "traits": { "smithy.api#documentation": "Output column.
" } }, "com.amazonaws.quicksight#OutputColumnList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#OutputColumn" } }, "com.amazonaws.quicksight#Parameters": { "type": "structure", "members": { "StringParameters": { "target": "com.amazonaws.quicksight#StringParameterList", "traits": { "smithy.api#documentation": "String parameters.
" } }, "IntegerParameters": { "target": "com.amazonaws.quicksight#IntegerParameterList", "traits": { "smithy.api#documentation": "Integer parameters.
" } }, "DecimalParameters": { "target": "com.amazonaws.quicksight#DecimalParameterList", "traits": { "smithy.api#documentation": "Decimal parameters.
" } }, "DateTimeParameters": { "target": "com.amazonaws.quicksight#DateTimeParameterList", "traits": { "smithy.api#documentation": "Date-time parameters.
" } } }, "traits": { "smithy.api#documentation": "A list of 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#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": 1, "max": 32 } } }, "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#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": "PostgreSQL parameters.
" } }, "com.amazonaws.quicksight#PreconditionNotMetException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.quicksight#String" }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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#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": "Presto parameters.
" } }, "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#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#Query": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "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 AWS 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.
Amazon QuickSight is a fully managed, serverless business intelligence service for the\n AWS 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" } }, "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": "Amazon RDS parameters.
" } }, "com.amazonaws.quicksight#RecoveryWindowInDays": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 7, "max": 30 } } }, "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. This field can be blank if the ClusterId is provided.
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.
Amazon Redshift parameters. The ClusterId field can be blank if\n Host and Port are both set. The Host and\n Port fields can be blank if the ClusterId field is set.
Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity\n\t\t\tand Access Management (IAM) identity or role specified in the request.
", "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": "Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\t\t\n IAM: A user whose identity maps to an existing IAM user or role.\n\t\t\t\t
\n QUICKSIGHT: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
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\t\t\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
\n RESTRICTED_READER: This role isn't currently available for\n\t\t\t\t\tuse.
\n RESTRICTED_AUTHOR: This role isn't currently available for\n\t\t\t\t\tuse.
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 AWS CLI Reference.\n
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
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:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n instead.
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 QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" } }, "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 AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
The identity ID for a user in the external login provider.
" } } } }, "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.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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": 64 } } }, "com.amazonaws.quicksight#RelationalTableSchema": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 64 } } }, "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#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 AWS 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 AWS 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:
\nThe ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)
\nThe ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)
\nThe ARN of an AWS account root: This is an IAM ARN rather than a QuickSight\n ARN. Use this option only to share resources (templates) across AWS accounts.\n (This is less common.)
\nThe 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": "string", "traits": { "smithy.api#enum": [ { "value": "CREATION_IN_PROGRESS", "name": "CREATION_IN_PROGRESS" }, { "value": "CREATION_SUCCESSFUL", "name": "CREATION_SUCCESSFUL" }, { "value": "CREATION_FAILED", "name": "CREATION_FAILED" }, { "value": "UPDATE_IN_PROGRESS", "name": "UPDATE_IN_PROGRESS" }, { "value": "UPDATE_SUCCESSFUL", "name": "UPDATE_SUCCESSFUL" }, { "value": "UPDATE_FAILED", "name": "UPDATE_FAILED" }, { "value": "DELETED", "name": "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 AWS 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 AWS account that contains the analysis.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the analysis that you're restoring.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } } }, "com.amazonaws.quicksight#RestoreAnalysisResponse": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "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#RestrictiveResourceId", "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 AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#RestrictiveResourceId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\w\\-]+$" } }, "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#RowInfo": { "type": "structure", "members": { "RowsIngested": { "target": "com.amazonaws.quicksight#Long", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "The number of rows that were ingested.
" } }, "RowsDropped": { "target": "com.amazonaws.quicksight#Long", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "The number of rows that were not ingested.
" } } }, "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 interpretting the permissions for RLS. DENY_ACCESS \n is included for backward compatibility only.
The user or group rules associated with the dataset that contains permissions for RLS.
\nBy 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.
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.
\nThe option to deny permissions by setting PermissionPolicy to DENY_ACCESS is \n not supported for new RLS datasets.
Location of the Amazon S3 manifest file. This is NULL if the manifest file was\n uploaded in the console.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "S3 parameters.
" } }, "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 as S3 data source.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A physical table type for as S3 data source.
" } }, "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.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/search/analyses", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#SearchAnalysesRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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#box": {}, "smithy.api#documentation": "The maximum number of results to return.
" } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/search/dashboards", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" } } }, "com.amazonaws.quicksight#SearchDashboardsRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS 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
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#box": {}, "smithy.api#documentation": "The maximum number of results to be returned per request.
" } } } }, "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.
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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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": "ServiceNow parameters.
" } }, "com.amazonaws.quicksight#SessionLifetimeInMinutes": { "type": "long", "traits": { "smithy.api#box": {}, "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 AWS 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#Sheet": { "type": "structure", "members": { "SheetId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The unique identifier associated with a sheet.
" } }, "Name": { "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { "smithy.api#documentation": "The name of a sheet. This name is displayed on the sheet's tab in the 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 the Amazon QuickSight console. 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#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#SheetList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#Sheet" }, "traits": { "smithy.api#length": { "min": 0, "max": 20 } } }, "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#SiteBaseUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "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": "Snowflake parameters.
" } }, "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": "Spark parameters.
" } }, "com.amazonaws.quicksight#SqlQuery": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 65536 } } }, "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": "SQL Server parameters.
" } }, "com.amazonaws.quicksight#SslProperties": { "type": "structure", "members": { "DisableSsl": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "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 QuickSight connects to your\n underlying data source.
" } }, "com.amazonaws.quicksight#StatusCode": { "type": "integer" }, "com.amazonaws.quicksight#String": { "type": "string" }, "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#StringList", "traits": { "smithy.api#documentation": "The values of a string parameter.
", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "A string parameter.
" } }, "com.amazonaws.quicksight#StringParameterList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#StringParameter" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "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. .
\nThis is not tags for the AWS tagging feature. .
\nA 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 QuickSight resource.
\n\t\tTags 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.
You can associate as many as 50 tags with a resource. QuickSight supports tagging on data\n\t\t\tset, data source, dashboard, and template.
\n\t\tTagging for QuickSight works in a similar way to tagging for other AWS services, except for\n\t\t\tthe following:
\n\t\tYou can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight\n\t\t\t\t\tcosts are based on users and SPICE capacity, which aren't taggable\n\t\t\t\t\tresources.
\nQuickSight doesn't currently support the Tag Editor for AWS Resource Groups.
\nThe 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": {} } } } }, "com.amazonaws.quicksight#TagResourceResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#TagValue": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "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#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the template. This is unique per AWS Region for each AWS 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 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.
\nYou can share templates across AWS accounts by allowing users in other AWS 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.
" } } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "SOURCE_NOT_FOUND", "name": "SOURCE_NOT_FOUND" }, { "value": "DATA_SET_NOT_FOUND", "name": "DATA_SET_NOT_FOUND" }, { "value": "INTERNAL_FAILURE", "name": "INTERNAL_FAILURE" }, { "value": "ACCESS_DENIED", "name": "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#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the template. This ID is unique per AWS Region for each AWS 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 HTTP status of the request.
" } }, "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#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": "Teradata parameters.
" } }, "com.amazonaws.quicksight#TextQualifier": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "DOUBLE_QUOTE", "name": "DOUBLE_QUOTE" }, { "value": "SINGLE_QUOTE", "name": "SINGLE_QUOTE" } ] } }, "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#RestrictiveResourceId", "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.
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.
" } } }, "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": "string", "traits": { "smithy.api#enum": [ { "value": "INTERNAL_FAILURE", "name": "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#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the theme. This ID is unique per AWS Region for each AWS 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": "string", "traits": { "smithy.api#enum": [ { "value": "QUICKSIGHT", "name": "QUICKSIGHT" }, { "value": "CUSTOM", "name": "CUSTOM" }, { "value": "ALL", "name": "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#RestrictiveResourceId", "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 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#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.quicksight#String" }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS 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#Timestamp": { "type": "timestamp" }, "com.amazonaws.quicksight#TimestampList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#Timestamp" } }, "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.
" } } }, "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#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": "Twitter parameters.
" } }, "com.amazonaws.quicksight#TypeCastFormat": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 32 } } }, "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
The AWS 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 AWS account. Before you can use embedding \n\t\t\tfor anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You \n\t\t can do this on the Manage QuickSight page.
\nAfter capacity pricing is added, you can use the \n GetDashboardEmbedUrl API operation with the \n --identity-type ANONYMOUS option.
The AWS 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\tQuickSight 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#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": {} } } } }, "com.amazonaws.quicksight#UntagResourceResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 the current AWS Region. Currently, the only\n customization you can use is a theme.
\nYou can use customizations for your AWS account or, if you specify a namespace, for a\n QuickSight namespace instead. Customizations that apply to a namespace override\n customizations that apply to an AWS account. To find out which customizations apply, use\n the DescribeAccountCustomization API operation.
The ID for the AWS account that you want to update 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 QuickSight customizations for.
", "smithy.api#httpQuery": "namespace" } }, "AccountCustomization": { "target": "com.amazonaws.quicksight#AccountCustomization", "traits": { "smithy.api#documentation": "The QuickSight customizations you're updating in the current AWS Region.
", "smithy.api#required": {} } } } }, "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 AWS account.
" } }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID for the AWS account that you want to update 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 QuickSight customizations you're updating in the current AWS Region.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS 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 AWS account that contains the 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 AWS account. Currently, the default is\n default. AWS Identity and Access Management (IAM) users that register\n for the first time with QuickSight provide an email that becomes associated with the\n default namespace.
The email address that you want QuickSight to send notifications to regarding your AWS\n account or QuickSight subscription.
" } } } }, "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { "type": "structure", "members": { "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 AWS account that contains the analysis whose permissions you're\n updating. You must be using the AWS account that the analysis is in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
" } } } }, "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#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateAnalysisRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the analysis that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 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.
", "smithy.api#required": {} } }, "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 QuickSight console, make sure that you have access to\n it.
" } } } }, "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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account.
", "smithy.api#http": { "method": "PUT", "uri": "/accounts/{AwsAccountId}/dashboards/{DashboardId}", "code": 200 } } }, "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#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 AWS account that contains the dashboard whose permissions you're\n updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
" } } } }, "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#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that contains the dashboard that you're\n updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "com.amazonaws.quicksight#UpdateDashboardPublishedVersionResponse": { "type": "structure", "members": { "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "com.amazonaws.quicksight#UpdateDashboardRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 CreateTemplate API operation. For\n SourceTemplate, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate ARN can contain any AWS Account and any\n QuickSight-supported AWS Region.
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.
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\n AvailabilityStatus for AdHocFilteringOption - This\n status can be either ENABLED or DISABLED. When this is\n set to DISABLED, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED by default.
\n AvailabilityStatus for ExportToCSVOption - This\n status can be either ENABLED or DISABLED. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED. This option is ENABLED by default.
\n VisibilityState for SheetControlsOption - This\n visibility state can be either COLLAPSED or EXPANDED.\n This option is COLLAPSED by default.
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 AWS account where you create the\n dashboard.
" } } } }, "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#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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.
", "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\t\tThe permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
The AWS 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 AWS\n\t\t\tRegion for each AWS 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.
" } } } }, "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 AWS\n\t\t\tRegion for each AWS account.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateDataSetRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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 AWS Region for each\n\t\t\tAWS 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 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.
" } }, "ColumnLevelPermissionRules": { "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", "traits": { "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n .
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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#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 AWS 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 AWS Region for each AWS 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.
" } } } }, "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 AWS Region for each AWS account.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateDataSourceRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The AWS 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 AWS Region for each AWS 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 QuickSight uses to connect to your underlying source.
" } }, "Credentials": { "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { "smithy.api#documentation": "The credentials that 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 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 QuickSight connects to your underlying\n\t\t\tsource.
" } } } }, "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 AWS Region for each AWS 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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
The name of the group.
" } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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 the optional\n\t\t\tparameter or parameters that are specified in the request. \n\t\t This overwrites all of the users included in Identities. \n\t\t
The ID of the AWS account that contains the IAM policy assignment.
", "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. This name must be unique within an AWS 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\t\t\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { "smithy.api#documentation": "The QuickSight users, groups, or both that you want to assign the policy to.
" } } } }, "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 QuickSight users and groups specified in this\n\t\t\tassignment.
" } }, "Identities": { "target": "com.amazonaws.quicksight#IdentityMap", "traits": { "smithy.api#documentation": "The QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, "AssignmentStatus": { "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED - Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED - This assignment isn't used when creating the data source.
\n DRAFT - This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateResourcePermissionList": { "type": "list", "member": { "target": "com.amazonaws.quicksight#ResourcePermission" }, "traits": { "smithy.api#length": { "min": 0, "max": 100 } } }, "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 AWS account that contains the template alias that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
The version number of the template.
", "smithy.api#required": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#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 AWS account that contains the template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
" } } } }, "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { "type": "structure", "members": { "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateTemplateRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the template that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS Account and any QuickSight-supported AWS Region.
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.
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.
The name for the template.
" } } } }, "com.amazonaws.quicksight#UpdateTemplateResponse": { "type": "structure", "members": { "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that contains the theme alias that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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": {} } } } }, "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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#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\".
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\t\t\tUser
\n\t\t\t\t\t\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
Owner
\n\t\t\t\t\t\n \"quicksight:DescribeTheme\"\n
\n \"quicksight:DescribeThemeAlias\"\n
\n \"quicksight:ListThemeAliases\"\n
\n \"quicksight:ListThemeVersions\"\n
\n \"quicksight:DeleteTheme\"\n
\n \"quicksight:UpdateTheme\"\n
\n \"quicksight:CreateThemeAlias\"\n
\n \"quicksight:DeleteThemeAlias\"\n
\n \"quicksight:UpdateThemeAlias\"\n
\n \"quicksight:UpdateThemePermissions\"\n
\n \"quicksight:DescribeThemePermissions\"\n
To specify no permissions, omit the permissions list.
\nThe ID of the AWS account that contains the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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.
" } } } }, "com.amazonaws.quicksight#UpdateThemePermissionsResponse": { "type": "structure", "members": { "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "com.amazonaws.quicksight#UpdateThemeRequest": { "type": "structure", "members": { "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#RestrictiveResourceId", "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 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.
The theme configuration, which contains the theme display properties.
" } } } }, "com.amazonaws.quicksight#UpdateThemeResponse": { "type": "structure", "members": { "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "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#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } } } }, "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 AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount 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.
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\t\t\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses, and\n\t\t\t\t\tdashboards.
\n ADMIN: A user who is an author, who can also manage Amazon QuickSight\n\t\t\t\t\tsettings.
The name of the 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:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nA 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 QuickSight\n console. Then, you use the RegisterUser API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" } }, "UnapplyCustomPermissions": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "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 QuickSight with an associated AWS Identity and Access Management (IAM) role. The type of supported external login provider can be one of the following.
\n\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the \"CustomFederationProviderUrl\" parameter which is only needed when the external provider is custom.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
\n NONE: This clears all the previously saved external login information for a user. Use \n DescribeUser\n API to check the external login information.
The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate\n into QuickSight with an associated AWS Identity and Access Management (IAM) role. This parameter should\n only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
The identity ID for a user in the external login provider.
" } } } }, "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 AWS request ID for this operation.
" } }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } } } }, "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#box": {}, "smithy.api#documentation": "A row number to start reading data from.
" } }, "ContainsHeader": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#box": {}, "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.
" } }, "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\n READER: A user who has read-only access to dashboards.
\n AUTHOR: A user who can create data sources, datasets, analyses,\n and dashboards.
\n ADMIN: A user who is an author, who can also manage Amazon\n QuickSight settings.
\n RESTRICTED_READER: This role isn't currently available for\n use.
\n RESTRICTED_AUTHOR: This role isn't currently available for\n use.
The type of identity authentication used by the user.
" } }, "Active": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#documentation": "The active status of user. When you create an Amazon QuickSight user that’s not an IAM\n 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\n COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.
\n CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
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#UserName2": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.quicksight#UserRole": { "type": "string", "traits": { "smithy.api#enum": [ { "value": "ADMIN", "name": "ADMIN" }, { "value": "AUTHOR", "name": "AUTHOR" }, { "value": "READER", "name": "READER" }, { "value": "RESTRICTED_AUTHOR", "name": "RESTRICTED_AUTHOR" }, { "value": "RESTRICTED_READER", "name": "RESTRICTED_READER" } ] } }, "com.amazonaws.quicksight#VersionDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.quicksight#VersionNumber": { "type": "long", "traits": { "smithy.api#box": {}, "smithy.api#range": { "min": 1 } } }, "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#Warehouse": { "type": "string", "traits": { "smithy.api#length": { "min": 0, "max": 128 } } }, "com.amazonaws.quicksight#WorkGroup": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 } } } } }