"documentation":"<p>Creates Amazon QuickSight customizations the current AWS Region. Currently, you can add a custom default theme by using the <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code> API operation. To further customize QuickSight by removing QuickSight sample assets and videos for all new users, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html\">Customizing QuickSight</a> in the <i>Amazon QuickSight User Guide.</i> </p> <p>You can create customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an AWS account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation.</p> <p>Before you use the <code>CreateAccountCustomization</code> API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the <code> <a>DescribeThemePermissions</a> </code> API operation. To share the theme, grant permissions by using the <code> <a>UpdateThemePermissions</a> </code> API operation. </p>"
"documentation":"<p>Creates a dashboard from a template. To first create a template, see the <code> <a>CreateTemplate</a> </code> API operation.</p> <p>A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.</p>"
"documentation":"<p>Creates an Amazon QuickSight group.</p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is a group object.</p>"
"documentation":"<p>Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per AWS account. To avoid overwriting rules in other namespaces, use assignment names that are unique.</p>"
"documentation":"<p>Creates and starts a new SPICE ingestion on a dataset</p> <p>Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/\">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the AWS Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.</p>"
},
"CreateNamespace":{
"name":"CreateNamespace",
"http":{
"method":"POST",
"requestUri":"/accounts/{AwsAccountId}"
},
"input":{"shape":"CreateNamespaceRequest"},
"output":{"shape":"CreateNamespaceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"LimitExceededException"},
{"shape":"ResourceExistsException"},
{"shape":"PreconditionNotMetException"},
{"shape":"ConflictException"},
{"shape":"InternalFailureException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>(Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight.</p> <p>A namespace allows you to isolate the QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your AWS account is subscribed to QuickSight. The namespace must be unique within the AWS account. By default, there is a limit of 100 namespaces per AWS account. To increase your limit, create a ticket with AWS Support. </p>"
"documentation":"<p>Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.</p> <p>A <i>template</i> is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.</p>"
"documentation":"<p>Creates a theme.</p> <p>A <i>theme</i> is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
"documentation":"<p>Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. QuickSight attaches a <code>DeletionTime</code> stamp to the response that specifies the end of the recovery window. At the end of the recovery window, QuickSight deletes the analysis permanently.</p> <p>At any time before recovery window ends, you can use the <code>RestoreAnalysis</code> API operation to remove the <code>DeletionTime</code> stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it.</p> <p>An analysis that's scheduled for deletion isn't accessible in the QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.</p>"
"documentation":"<p>Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset. </p>"
"documentation":"<p>Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.</p>"
"documentation":"<p>Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.</p>"
"documentation":"<p>Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. </p>"
"documentation":"<p>Describes the customizations associated with the provided AWS account and Amazon QuickSight namespace in an AWS Region. The QuickSight console evaluates which customizations to apply by running this API operation with the <code>Resolved</code> flag included. </p> <p>To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. </p> <ul> <li> <p> <code>AWS Account</code> - The AWS account exists at the top of the hierarchy. It has the potential to use all of the AWS Regions and AWS Services. When you subscribe to QuickSight, you choose one AWS Region to use as your home Region. That's where your free SPICE capacity is located. You can use QuickSight in any supported AWS Region. </p> </li> <li> <p> <code>AWS Region</code> - In each AWS Region where you sign in to QuickSight at least once, QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to QuickSight in any AWS Region, unless they are constrained to a namespace. </p> <p>To run the command in a different AWS Region, you change your Region settings. If you're using the AWS CLI, you can use one of the following options:</p> <ul> <li> <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html\">command line options</a>. </p> </li> <li> <p>Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html\">named profiles</a>. </p> </li> <li> <p>Run <code>aws configure</code> to change your default AWS Region. Use Enter to key the same settings for your keys. For more information, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">Configuring the AWS CLI</a>.</p> </li> </ul> </li> <li> <p> <code>Namespace</code> - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same AWS account and AWS Region.</p> </li> <li> <p> <code>Applied customizations</code> - Within an AWS Region, a set of QuickSight customizations can apply to an AWS account or to a namespace. Settings that you apply to a namespace override settings that you apply to an AWS account. All settings are isolated to a single AWS Region. To apply them in other AWS Regions, run the <code>CreateAccountCustomization</code> command in each AWS Region where you want to apply the same customizations. </p> </li> </ul>"
"documentation":"<p>Describes the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>"
"documentation":"<p>Generates a session URL and authorization code that you can use to embed an Amazon QuickSight read-only dashboard in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions. </p> <p>Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:</p> <ul> <li> <p>They must be used together.</p> </li> <li> <p>They can be used one time only.</p> </li> <li> <p>They are valid for 5 minutes after you run this command.</p> </li> <li> <p>The resulting user session is valid for 10 hours.</p> </li> </ul> <p>For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedded-analytics.html\">Embedded Analytics</a> in the <i>Amazon QuickSight User Guide</i>.</p>"
"documentation":"<p>Generates a session URL and authorization code that you can use to embed the Amazon QuickSight console in your web server code. Use <code>GetSessionEmbedUrl</code> where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the <code> <a>UpdateUser</a> </code> API operation. Use <code> <a>RegisterUser</a> </code> API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the <i>Amazon QuickSight User Guide</i>:</p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/embedding-the-quicksight-console.html\">Embedding the Amazon QuickSight Console</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-permissions-to-the-quicksight-console.html\">Customizing Access to the Amazon QuickSight Console</a> </p> </li> </ul>"
},
"ListAnalyses":{
"name":"ListAnalyses",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/analyses"
},
"input":{"shape":"ListAnalysesRequest"},
"output":{"shape":"ListAnalysesResponse"},
"errors":[
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"UnsupportedUserEditionException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists Amazon QuickSight analyses that exist in the specified AWS account.</p>"
"documentation":"<p>Lists dashboards in an AWS account.</p>"
},
"ListDataSets":{
"name":"ListDataSets",
"http":{
"method":"GET",
"requestUri":"/accounts/{AwsAccountId}/data-sets"
},
"input":{"shape":"ListDataSetsRequest"},
"output":{"shape":"ListDataSetsResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ThrottlingException"},
{"shape":"InvalidNextTokenException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Lists all of the datasets belonging to the current AWS account in an AWS Region.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/*</code>.</p>"
"documentation":"<p>Lists all the IAM policy assignments, including the Amazon Resource Names (ARNs) for the IAM policies assigned to the specified user and group or groups that the user belongs to.</p>"
"documentation":"<p>Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. </p>"
"documentation":"<p>Assigns one or more tags (key-value pairs) to the specified QuickSight resource. </p> <p>Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the <code>TagResource</code> operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p> <p>You can associate as many as 50 tags with a resource. QuickSight supports tagging on data set, data source, dashboard, and template. </p> <p>Tagging for QuickSight works in a similar way to tagging for other AWS services, except for the following:</p> <ul> <li> <p>You can't use tags to track AWS costs for QuickSight. This restriction is because QuickSight costs are based on users and SPICE capacity, which aren't taggable resources.</p> </li> <li> <p>QuickSight doesn't currently support the Tag Editor for AWS Resource Groups.</p> </li> </ul>"
},
"UntagResource":{
"name":"UntagResource",
"http":{
"method":"DELETE",
"requestUri":"/resources/{ResourceArn}/tags"
},
"input":{"shape":"UntagResourceRequest"},
"output":{"shape":"UntagResourceResponse"},
"errors":[
{"shape":"AccessDeniedException"},
{"shape":"InvalidParameterValueException"},
{"shape":"ResourceNotFoundException"},
{"shape":"ThrottlingException"},
{"shape":"InternalFailureException"}
],
"documentation":"<p>Removes a tag or tags from a resource.</p>"
"documentation":"<p>Updates Amazon QuickSight customizations the current AWS Region. Currently, the only customization you can use is a theme.</p> <p>You can use customizations for your AWS account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an AWS account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation. </p>"
"documentation":"<p>Updates the permissions on a dataset.</p> <p>The permissions resource is <code>arn:aws:quicksight:region:aws-account-id:dataset/data-set-id</code>.</p>"
"documentation":"<p>Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in <code>Identities</code>. </p>"
"documentation":"<p>Updates an Amazon QuickSight user.</p>"
}
},
"shapes":{
"AccessDeniedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this request.</p>"
}
},
"documentation":"<p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct access keys.</p>",
"documentation":"<p>The default theme for this QuickSight subscription.</p>"
}
},
"documentation":"<p>The Amazon QuickSight customizations associated with your AWS account or a QuickSight namespace in a specific AWS Region.</p>"
},
"AccountSettings":{
"type":"structure",
"members":{
"AccountName":{
"shape":"String",
"documentation":"<p>The \"account name\" you provided for the QuickSight subscription in your AWS account. You create this name when you sign up for QuickSight. It is unique in all of AWS and it appears only in the console when users sign in.</p>"
},
"Edition":{
"shape":"Edition",
"documentation":"<p>The edition of QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.</p>"
},
"DefaultNamespace":{
"shape":"Namespace",
"documentation":"<p>The default QuickSight namespace for your AWS account. </p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The main notification email for your QuickSight subscription.</p>"
}
},
"documentation":"<p>The QuickSight settings associated with your AWS account.</p>"
"documentation":"<p>The comparison operator that you want to use as a filter, for example <code>\"Operator\": \"StringEquals\"</code>.</p>"
},
"Name":{
"shape":"AnalysisFilterAttribute",
"documentation":"<p>The name of the value that you want to use as a filter, for example <code>\"Name\": \"QUICKSIGHT_USER\"</code>.</p>"
},
"Value":{
"shape":"String",
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter, for example <code>\"Value\"</code>. An example is <code>\"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>.</p>"
}
},
"documentation":"<p>A filter that you apply when searching for one or more analyses.</p>"
"documentation":"<p>A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.</p>"
},
"Expression":{
"shape":"Expression",
"documentation":"<p>An expression that defines the calculated column.</p>"
}
},
"documentation":"<p>A calculated column for a dataset.</p>"
},
"CalculatedColumnList":{
"type":"list",
"member":{"shape":"CalculatedColumn"},
"max":128,
"min":1
},
"CancelIngestionRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId",
"IngestionId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"string",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>",
"location":"uri",
"locationName":"IngestionId"
}
}
},
"CancelIngestionResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data ingestion.</p>"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>"
},
"RequestId":{
"shape":"string",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CastColumnTypeOperation":{
"type":"structure",
"required":[
"ColumnName",
"NewColumnType"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>Column name.</p>"
},
"NewColumnType":{
"shape":"ColumnDataType",
"documentation":"<p>New column data type.</p>"
},
"Format":{
"shape":"TypeCastFormat",
"documentation":"<p>When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.</p>"
}
},
"documentation":"<p>A transform operation that casts a column to a different type.</p>"
"documentation":"<p>Geospatial column group that denotes a hierarchy.</p>"
}
},
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"ColumnGroupColumnSchema":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the column group's column schema.</p>"
}
},
"documentation":"<p>A structure describing the name, data type, and geographic role of the columns.</p>"
},
"ColumnGroupColumnSchemaList":{
"type":"list",
"member":{"shape":"ColumnGroupColumnSchema"},
"max":500
},
"ColumnGroupList":{
"type":"list",
"member":{"shape":"ColumnGroup"},
"max":8,
"min":1
},
"ColumnGroupName":{
"type":"string",
"max":64,
"min":1
},
"ColumnGroupSchema":{
"type":"structure",
"members":{
"Name":{
"shape":"String",
"documentation":"<p>The name of the column group schema.</p>"
},
"ColumnGroupColumnSchemaList":{
"shape":"ColumnGroupColumnSchemaList",
"documentation":"<p>A structure containing the list of schemas for column group columns.</p>"
"documentation":"<p>An array of Amazon Resource Names (ARNs) for QuickSight users or groups.</p>"
},
"ColumnNames":{
"shape":"ColumnNameList",
"documentation":"<p>An array of column names.</p>"
}
},
"documentation":"<p>A rule defined to grant access on one or more restricted columns. Each dataset can have multiple rules. To create a restricted column, you add it to one or more rules. Each rule must contain at least one column and at least one user or group. To be able to see a restricted column, a user or group needs to be added to a rule for that column.</p>"
"documentation":"<p>A tag for a column in a <a>TagColumnOperation</a> structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
"documentation":"<p>A resource is already in a state that indicates an operation is happening that must complete before a new update can be applied.</p>",
"documentation":"<p>The ID for the AWS account that you want to customize QuickSight for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The QuickSight namespace that you want to add customizations to.</p>",
"location":"querystring",
"locationName":"namespace"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The QuickSight customizations you're adding in the current AWS Region. You can add these to an AWS account and a QuickSight namespace. </p> <p>For example, you can add a default theme by setting <code>AccountCustomization</code> to the midnight theme: <code>\"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight::aws:theme/MIDNIGHT\" }</code>. Or, you can add a custom theme by specifying <code>\"AccountCustomization\": { \"DefaultTheme\": \"arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639\" }</code>. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A list of the tags that you want to attach to this resource.</p>"
}
}
},
"CreateAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the customization that you created for this AWS account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that you want to customize QuickSight for.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the customization you're creating. </p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The QuickSight customizations you're adding in the current AWS Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId",
"Name",
"SourceEntity"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account where you are creating an analysis.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the analysis that you're creating. This ID displays in the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>A descriptive name for the analysis that you're creating. This name displays for the analysis in the QuickSight console. </p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values. </p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis. You can use the <code>Permissions</code> structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). </p> <p>To specify no permissions, omit <code>Permissions</code>.</p>"
},
"SourceEntity":{
"shape":"AnalysisSourceEntity",
"documentation":"<p>A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.</p>"
}
}
},
"CreateAnalysisResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the analysis.</p>"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the creation of the analysis. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
"documentation":"<p>The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values. </p>"
"documentation":"<p>A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. </p> <p>To specify no permissions, omit the permissions list.</p>"
"documentation":"<p>The entity that you are using as a source when you create the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the <a>CreateTemplate</a> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code>ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.</p>"
"documentation":"<p>The type of the data source. Currently, the supported types for this operation are: <code>ATHENA, AURORA, AURORA_POSTGRESQL, AMAZON_ELASTICSEARCH, MARIADB, MYSQL, POSTGRESQL, PRESTO, REDSHIFT, S3, SNOWFLAKE, SPARK, SQLSERVER, TERADATA</code>. Use <code>ListDataSources</code> to return a list of all data sources.</p> <p> <code>AMAZON_ELASTICSEARCH</code> is for Amazon managed Elasticsearch Service.</p>"
"documentation":"<p>The parameters that QuickSight uses to connect to your underlying source.</p>"
},
"Credentials":{
"shape":"DataSourceCredentials",
"documentation":"<p>The credentials QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the data source.</p>"
},
"VpcConnectionProperties":{
"shape":"VpcConnectionProperties",
"documentation":"<p>Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.</p>"
}
}
},
"CreateDataSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The status of creating the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateGroupMembershipRequest":{
"type":"structure",
"required":[
"MemberName",
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The name of the user that you want to add to the group membership.</p>",
"location":"uri",
"locationName":"MemberName"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to add the user to.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"CreateGroupMembershipResponse":{
"type":"structure",
"members":{
"GroupMember":{
"shape":"GroupMember",
"documentation":"<p>The group member.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>A name for the group that you want to create.</p>"
},
"Description":{
"shape":"GroupDescription",
"documentation":"<p>A description for the group that you want to create.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
},
"documentation":"<p>The request object for this operation. </p>"
},
"CreateGroupResponse":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The name of the group.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
},
"documentation":"<p>The response object for this operation.</p>"
},
"CreateIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"AssignmentStatus",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account where you want to assign an IAM policy to QuickSight users or groups.</p>",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The QuickSight users, groups, or both that you want to assign the policy to.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that contains the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"CreateIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. This name must be unique within the AWS account.</p>"
},
"AssignmentId":{
"shape":"String",
"documentation":"<p>The ID for the assignment.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The QuickSight users, groups, or both that the IAM policy is assigned to.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"CreateIngestionRequest":{
"type":"structure",
"required":[
"DataSetId",
"IngestionId",
"AwsAccountId"
],
"members":{
"DataSetId":{
"shape":"string",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>",
"location":"uri",
"locationName":"IngestionId"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"CreateIngestionResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data ingestion.</p>"
},
"IngestionId":{
"shape":"IngestionId",
"documentation":"<p>An ID for the ingestion.</p>"
},
"IngestionStatus":{
"shape":"IngestionStatus",
"documentation":"<p>The ingestion status.</p>"
},
"RequestId":{
"shape":"string",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID for the AWS account that you want to create the QuickSight namespace in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The name that you want to use to describe the new namespace.</p>"
},
"IdentityStore":{
"shape":"IdentityStore",
"documentation":"<p>Specifies the type of your user identity directory. Currently, this supports users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>The tags that you want to associate with the namespace that you're creating.</p>"
}
}
},
"CreateNamespaceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the QuickSight namespace you created. </p>"
},
"Name":{
"shape":"Namespace",
"documentation":"<p>The name of the new namespace that you created.</p>"
},
"CapacityRegion":{
"shape":"String",
"documentation":"<p>The AWS Region that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in. </p>"
},
"CreationStatus":{
"shape":"NamespaceStatus",
"documentation":"<p>The status of the creation of the namespace. This is an asynchronous process. A status of <code>CREATED</code> means that your namespace is ready to use. If an error occurs, it indicates if the process is <code>retryable</code> or <code>non-retryable</code>. In the case of a non-retryable error, refer to the error message for follow-up tasks.</p>"
},
"IdentityStore":{
"shape":"IdentityStore",
"documentation":"<p>Specifies the type of your user identity directory. Currently, this supports users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID of the AWS account that contains the template that you creating an alias for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name that you want to give to the template alias that you're creating. Don't start the alias name with the <code>$</code> character. Alias names that start with <code>$</code> are reserved by QuickSight. </p>",
"location":"uri",
"locationName":"AliasName"
},
"TemplateVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template.</p>"
}
}
},
"CreateTemplateAliasResponse":{
"type":"structure",
"members":{
"TemplateAlias":{
"shape":"TemplateAlias",
"documentation":"<p>Information about the template alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"CreateTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId",
"SourceEntity"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the template that you want to create. This template is unique per AWS Region in each AWS account.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>A display name for the template.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions to be set on the template. </p>"
"documentation":"<p>The entity that you are using as a source when you create the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
"documentation":"<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the current template version being created. This API operation creates the first version of the template. Every time <code>UpdateTemplate</code> is called, a new version is created. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>"
}
}
},
"CreateTemplateResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN for the template.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the template, including the version information of the first version.</p>"
"documentation":"<p>An ID for the theme alias.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name that you want to give to the theme alias that you are creating. The alias name can't begin with a <code>$</code>. Alias names that start with <code>$</code> are reserved by Amazon QuickSight. </p>",
"location":"uri",
"locationName":"AliasName"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme.</p>"
"documentation":"<p>The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use <code>ListThemes</code> or choose <b>Themes</b> from within a QuickSight analysis. </p>"
"documentation":"<p>A description of the first version of the theme that you're creating. Every time <code>UpdateTheme</code> is called, a new version is created. Each version of the theme has a description of the version in the <code>VersionDescription</code> field.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A valid grouping of resource permissions to apply to the new theme. </p>"
},
"Tags":{
"shape":"TagList",
"documentation":"<p>A map of the key-value pairs for the resource tag or tags that you want to add to the resource.</p>"
}
}
},
"CreateThemeResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the new theme.</p>"
"documentation":"<p>A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the <code>AlternateDataSourceParameters</code> list is null, the <code>DataSourceParameters</code> originally used with these <code>Credentials</code> is automatically allowed.</p>"
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter, for example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
"documentation":"<p>The theme colors that are used for data colors in charts. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. </p>"
"documentation":"<p>The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.</p>"
},
"ColumnGroups":{
"shape":"ColumnGroupList",
"documentation":"<p>Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>"
},
"Name":{
"shape":"ResourceName",
"documentation":"<p>A display name for the data source.</p>"
},
"Type":{
"shape":"DataSourceType",
"documentation":"<p>The type of the data source. This type indicates which database engine the data source connects to.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The HTTP status of the request.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The time that this data source was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last time that this data source was updated.</p>"
},
"DataSourceParameters":{
"shape":"DataSourceParameters",
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
"documentation":"<p>A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the <code>DataSourceParameters</code> structure that's in the request with the structures in the <code>AlternateDataSourceParameters</code> allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the <code>AlternateDataSourceParameters</code> list is null, the <code>Credentials</code> originally used with this <code>DataSourceParameters</code> are automatically allowed.</p>"
"documentation":"<p>The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.</p>"
},
"ErrorInfo":{
"shape":"DataSourceErrorInfo",
"documentation":"<p>Error information from the last update or the creation of the data source.</p>"
}
},
"documentation":"<p>The structure of a data source.</p>"
"documentation":"<p>Credential pair. For more information, see <a>CredentialPair</a>.</p>"
},
"CopySourceArn":{
"shape":"CopySourceArn",
"documentation":"<p>The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When <code>CopySourceArn</code> is not null, the credential pair from the data source in the ARN is used as the credentials for the <code>DataSourceCredentials</code> structure.</p>"
"documentation":"<p>Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>",
"documentation":"<p>The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
"documentation":"<p>A display name for the date-time parameter.</p>"
},
"Values":{
"shape":"TimestampList",
"documentation":"<p>The values for the date-time parameter.</p>"
}
},
"documentation":"<p>A date-time parameter.</p>"
},
"DateTimeParameterList":{
"type":"list",
"member":{"shape":"DateTimeParameter"},
"max":100
},
"DecimalParameter":{
"type":"structure",
"required":[
"Name",
"Values"
],
"members":{
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>A display name for the decimal parameter.</p>"
},
"Values":{
"shape":"DoubleList",
"documentation":"<p>The values for the decimal parameter.</p>"
}
},
"documentation":"<p>A decimal parameter.</p>"
},
"DecimalParameterList":{
"type":"list",
"member":{"shape":"DecimalParameter"},
"max":100
},
"DeleteAccountCustomizationRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that you want to delete QuickSight customizations from in this AWS Region.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The QuickSight namespace that you're deleting the customizations from.</p>",
"location":"querystring",
"locationName":"namespace"
}
}
},
"DeleteAccountCustomizationResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account where you want to delete an analysis.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're deleting.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"RecoveryWindowInDays":{
"shape":"RecoveryWindowInDays",
"documentation":"<p>A value that specifies the number of days that QuickSight waits before it deletes the analysis. You can't use this parameter with the <code>ForceDeleteWithoutRecovery</code> option in the same API call. The default value is 30.</p>",
"documentation":"<p>This option defaults to the value <code>NoForceDeleteWithoutRecovery</code>. To immediately delete the analysis, add the <code>ForceDeleteWithoutRecovery</code> option. You can't restore an analysis after it's deleted. </p>",
"documentation":"<p>The ID of the AWS account that contains the dashboard that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.</p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteDashboardResponse":{
"type":"structure",
"members":{
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Secure Socket Layer (SSL) properties that apply for the resource.</p>"
},
"DashboardId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the dashboard.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DeleteDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DeleteDataSetResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DeleteDataSourceResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source that you deleted.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteGroupMembershipRequest":{
"type":"structure",
"required":[
"MemberName",
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"MemberName":{
"shape":"GroupMemberName",
"documentation":"<p>The name of the user that you want to delete from the group membership.</p>",
"location":"uri",
"locationName":"MemberName"
},
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to delete the user from.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteGroupMembershipResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to delete.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteGroupResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID where you want to delete the IAM policy assignment.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. </p>",
"location":"uri",
"locationName":"AssignmentName"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that contains the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteIAMPolicyAssignmentResponse":{
"type":"structure",
"members":{
"AssignmentName":{
"shape":"IAMPolicyAssignmentName",
"documentation":"<p>The name of the assignment. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. </p>",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DeleteTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the template that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the template you want to delete.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>Specifies the version of the template that you want to delete. If you don't provide a version number, <code>DeleteTemplate</code> deletes all versions of the template. </p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteTemplateResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the template.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID of the AWS account that contains the theme alias to delete.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme that the specified alias is for.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The unique name for the theme alias to delete.</p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DeleteThemeAliasResponse":{
"type":"structure",
"members":{
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name for the theme alias.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme resource using the deleted alias.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the theme associated with the deletion.</p>"
}
}
},
"DeleteThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the theme that you're deleting.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>An ID for the theme that you want to delete.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version of the theme that you want to delete. </p> <p> <b>Note:</b> If you don't provide a version number, you're using this call to <code>DeleteTheme</code> to delete all versions of the theme.</p>",
"location":"querystring",
"locationName":"version-number"
}
}
},
"DeleteThemeResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The principal ID of the user.</p>",
"location":"uri",
"locationName":"PrincipalId"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
},
"documentation":"<p/>"
},
"DeleteUserByPrincipalIdResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DeleteUserRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user that you want to delete.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DeleteUserResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID for the AWS account that you want to describe QuickSight customizations for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The QuickSight namespace that you want to describe QuickSight customizations for.</p>",
"location":"querystring",
"locationName":"namespace"
},
"Resolved":{
"shape":"boolean",
"documentation":"<p>The <code>Resolved</code> flag works with the other parameters to determine which view of QuickSight customizations is returned. You can add this flag to your command to use the same view that QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to <code>no-resolved</code>, to reveal customizations that are configured at different levels. </p>",
"location":"querystring",
"locationName":"resolved"
}
}
},
"DescribeAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that you're describing.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The QuickSight namespace that you're describing. </p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The QuickSight customizations that exist in the current AWS Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeAccountSettingsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that contains the settings that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
}
}
},
"DescribeAccountSettingsResponse":{
"type":"structure",
"members":{
"AccountSettings":{
"shape":"AccountSettings",
"documentation":"<p>The QuickSight settings for this AWS account. This information includes the edition of Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the QuickSight subscription. In the QuickSight console, the QuickSight subscription is sometimes referred to as a QuickSight \"account\" even though it's technically not an account by itself. Instead, it's a subscription to the QuickSight service for your AWS account. The edition that you subscribe to applies to QuickSight in every AWS Region where you use it.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeAnalysisPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the analysis whose permissions you're describing. You must be using the AWS account that the analysis is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"DescribeAnalysisPermissionsResponse":{
"type":"structure",
"members":{
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're describing.</p>"
},
"AnalysisArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DescribeAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the analysis. You must be using the AWS account that the analysis is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you're describing. The ID is part of the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
}
}
},
"DescribeAnalysisResponse":{
"type":"structure",
"members":{
"Analysis":{
"shape":"Analysis",
"documentation":"<p>A metadata structure that contains summary information for the analysis that you're describing.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
"documentation":"<p>The ID of the AWS account that contains the dashboard that you're describing permissions for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the dashboard, also added to the IAM policy.</p>",
"location":"uri",
"locationName":"DashboardId"
}
}
},
"DescribeDashboardPermissionsResponse":{
"type":"structure",
"members":{
"DashboardId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>"
},
"DashboardArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dashboard.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that contains the permissions for the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DescribeDashboardRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DashboardId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the dashboard that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DashboardId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the dashboard.</p>",
"location":"uri",
"locationName":"DashboardId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described. </p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The alias name.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeDashboardResponse":{
"type":"structure",
"members":{
"Dashboard":{
"shape":"Dashboard",
"documentation":"<p>Information about the dashboard.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of this request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DescribeDataSetPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DescribeDataSetPermissionsResponse":{
"type":"structure",
"members":{
"DataSetArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the dataset.</p>"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the dataset.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSetRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSetId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSetId":{
"shape":"ResourceId",
"documentation":"<p>The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSetId"
}
}
},
"DescribeDataSetResponse":{
"type":"structure",
"members":{
"DataSet":{
"shape":"DataSet",
"documentation":"<p>Information on the dataset.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSourcePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DescribeDataSourcePermissionsResponse":{
"type":"structure",
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the data source.</p>"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions on the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeDataSourceRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DataSourceId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DataSourceId":{
"shape":"ResourceId",
"documentation":"<p>The ID of the data source. This ID is unique per AWS Region for each AWS account.</p>",
"location":"uri",
"locationName":"DataSourceId"
}
}
},
"DescribeDataSourceResponse":{
"type":"structure",
"members":{
"DataSource":{
"shape":"DataSource",
"documentation":"<p>The information on the data source.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeGroupRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to describe.</p>",
"location":"uri",
"locationName":"GroupName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeGroupResponse":{
"type":"structure",
"members":{
"Group":{
"shape":"Group",
"documentation":"<p>The name of the group.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeIAMPolicyAssignmentRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AssignmentName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the assignment that you want to describe.</p>",
"documentation":"<p>The ID for the AWS account that contains the QuickSight namespace that you want to describe.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to describe.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeNamespaceResponse":{
"type":"structure",
"members":{
"Namespace":{
"shape":"NamespaceInfoV2",
"documentation":"<p>The information about the namespace that you're describing. The response includes the namespace ARN, name, AWS Region, creation status, and identity store. <code>DescribeNamespace</code> also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID of the AWS account that contains the template alias that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"uri",
"locationName":"AliasName"
}
}
},
"DescribeTemplateAliasResponse":{
"type":"structure",
"members":{
"TemplateAlias":{
"shape":"TemplateAlias",
"documentation":"<p>Information about the template alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DescribeTemplatePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the template that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
}
}
},
"DescribeTemplatePermissionsResponse":{
"type":"structure",
"members":{
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>"
},
"TemplateArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the template.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A list of resource permissions to be set on the template. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"DescribeTemplateRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"TemplateId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the template that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"TemplateId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the template.</p>",
"location":"uri",
"locationName":"TemplateId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>(Optional) The number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the template is described.</p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeTemplateResponse":{
"type":"structure",
"members":{
"Template":{
"shape":"Template",
"documentation":"<p>The template structure for the object you want to describe.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID of the AWS account that contains the theme that you're describing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number for the version to describe. If a <code>VersionNumber</code> parameter value isn't provided, the latest version of the theme is described.</p>",
"location":"querystring",
"locationName":"version-number"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to themes.</p>",
"location":"querystring",
"locationName":"alias-name"
}
}
},
"DescribeThemeResponse":{
"type":"structure",
"members":{
"Theme":{
"shape":"Theme",
"documentation":"<p>The information about the theme that you are describing.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"DescribeUserRequest":{
"type":"structure",
"required":[
"UserName",
"AwsAccountId",
"Namespace"
],
"members":{
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user that you want to describe.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"DescribeUserResponse":{
"type":"structure",
"members":{
"User":{
"shape":"User",
"documentation":"<p>The user name.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"Domain":{
"type":"string",
"max":64,
"min":1
},
"DomainNotWhitelistedException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this request.</p>"
}
},
"documentation":"<p>The domain specified isn't on the allow list. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.</p>",
"documentation":"<p>Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (QuickSight reader) chooses while viewing the dashboard. If this is set to <code>TRUE</code>, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is <code>FALSE</code>.</p>",
"documentation":"<p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following:</p> <ul> <li> <p>Active Directory (AD) users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li> <li> <p>IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation.</p> </li> </ul> <p>Omit this parameter for users in the third group – IAM users and IAM role-based sessions.</p>",
"documentation":"<p>The QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set this to \"<code>default</code>\".</p>",
"location":"querystring",
"locationName":"namespace"
},
"AdditionalDashboardIds":{
"shape":"AdditionalDashboardIdList",
"documentation":"<p>A list of one or more dashboard IDs that you want to add to a session that includes anonymous users. The <code>IdentityType</code> parameter must be set to <code>ANONYMOUS</code> for this to work, because other identity types authenticate as QuickSight or IAM users. For example, if you set \"<code>--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS</code>\", the session can access all three dashboards. </p>",
"documentation":"<p>A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours. </p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
},
"documentation":"<p>Output returned from the <code>GetDashboardEmbedUrl</code> operation.</p>"
},
"GetSessionEmbedUrlRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account associated with your QuickSight subscription.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"EntryPoint":{
"shape":"EntryPoint",
"documentation":"<p>The URL you use to access the embedded session. The entry point URL is constrained to the following paths:</p> <ul> <li> <p> <code>/start</code> </p> </li> <li> <p> <code>/start/analyses</code> </p> </li> <li> <p> <code>/start/dashboards</code> </p> </li> <li> <p> <code>/start/favorites</code> </p> </li> <li> <p> <code>/dashboards/<i>DashboardId</i> </code> - where <code>DashboardId</code> is the actual ID key from the QuickSight console URL of the dashboard</p> </li> <li> <p> <code>/analyses/<i>AnalysisId</i> </code> - where <code>AnalysisId</code> is the actual ID key from the QuickSight console URL of the analysis</p> </li> </ul>",
"location":"querystring",
"locationName":"entry-point"
},
"SessionLifetimeInMinutes":{
"shape":"SessionLifetimeInMinutes",
"documentation":"<p>How many minutes the session is valid. The session lifetime must be 15-600 minutes.</p>",
"location":"querystring",
"locationName":"session-lifetime"
},
"UserArn":{
"shape":"Arn",
"documentation":"<p>The Amazon QuickSight user's Amazon Resource Name (ARN), for use with <code>QUICKSIGHT</code> identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following:</p> <ol> <li> <p>Active Directory (AD) users or group members</p> </li> <li> <p>Invited nonfederated users</p> </li> <li> <p>AWS Identity and Access Management (IAM) users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation</p> </li> </ol> <p>Omit this parameter for users in the third group, IAM users and IAM role-based sessions.</p>",
"location":"querystring",
"locationName":"user-arn"
}
}
},
"GetSessionEmbedUrlResponse":{
"type":"structure",
"members":{
"EmbedUrl":{
"shape":"EmbeddingUrl",
"documentation":"<p>A single-use URL that you can put into your server-side web page to embed your QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an <code>auth_code</code> value that enables one (and only one) sign-on to a user session that is valid for 10 hours. </p>"
"documentation":"<p>A <i>group</i> in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. </p>"
"documentation":"<p>The join instructions provided in the <code>ON</code> clause of a join.</p>"
}
},
"documentation":"<p>The instructions associated with a join. </p>"
},
"JoinKeyProperties":{
"type":"structure",
"members":{
"UniqueKey":{
"shape":"Boolean",
"documentation":"<p>A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by QuickSight to optimize query performance.</p>",
"documentation":"<p>A structure that contains all of the dashboards in your AWS account. This structure provides basic information about the dashboards.</p>"
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"ListDataSetsRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDataSetsResponse":{
"type":"structure",
"members":{
"DataSetSummaries":{
"shape":"DataSetSummaryList",
"documentation":"<p>The list of dataset summaries.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListDataSourcesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListDataSourcesResponse":{
"type":"structure",
"members":{
"DataSources":{
"shape":"DataSourceList",
"documentation":"<p>A list of data sources.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListGroupMembershipsRequest":{
"type":"structure",
"required":[
"GroupName",
"AwsAccountId",
"Namespace"
],
"members":{
"GroupName":{
"shape":"GroupName",
"documentation":"<p>The name of the group that you want to see a membership list of.</p>",
"location":"uri",
"locationName":"GroupName"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListGroupMembershipsResponse":{
"type":"structure",
"members":{
"GroupMemberList":{
"shape":"GroupMemberList",
"documentation":"<p>The list of the members of the group.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListGroupsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListGroupsResponse":{
"type":"structure",
"members":{
"GroupList":{
"shape":"GroupList",
"documentation":"<p>The list of the groups.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIAMPolicyAssignmentsForUserRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"UserName",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the assignments.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The name of the user.</p>",
"location":"uri",
"locationName":"UserName"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace of the assignment.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListIAMPolicyAssignmentsForUserResponse":{
"type":"structure",
"members":{
"ActiveAssignments":{
"shape":"ActiveIAMPolicyAssignmentList",
"documentation":"<p>The active assignments for this user.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIAMPolicyAssignmentsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains these IAM policy assignments.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignments.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace for the assignments.</p>",
"location":"uri",
"locationName":"Namespace"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListIAMPolicyAssignmentsResponse":{
"type":"structure",
"members":{
"IAMPolicyAssignments":{
"shape":"IAMPolicyAssignmentSummaryList",
"documentation":"<p>Information describing the IAM policy assignments.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListIngestionsRequest":{
"type":"structure",
"required":[
"DataSetId",
"AwsAccountId"
],
"members":{
"DataSetId":{
"shape":"string",
"documentation":"<p>The ID of the dataset used in the ingestion.</p>",
"location":"uri",
"locationName":"DataSetId"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"MaxResults":{
"shape":"IngestionMaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListIngestionsResponse":{
"type":"structure",
"members":{
"Ingestions":{
"shape":"Ingestions",
"documentation":"<p>A list of the ingestions.</p>"
},
"NextToken":{
"shape":"string",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"RequestId":{
"shape":"string",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID for the AWS account that contains the QuickSight namespaces that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListNamespacesResponse":{
"type":"structure",
"members":{
"Namespaces":{
"shape":"Namespaces",
"documentation":"<p>The information about the namespaces in this AWS account. The response includes the namespace ARN, name, AWS Region, notification email address, creation status, and identity store.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"documentation":"<p>The ID of the AWS account that contains the theme aliases that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-result"
}
}
},
"ListThemeAliasesResponse":{
"type":"structure",
"members":{
"ThemeAliasList":{
"shape":"ThemeAliasList",
"documentation":"<p>A structure containing the list of the theme's aliases.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
}
}
},
"ListThemeVersionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the themes that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListThemeVersionsResponse":{
"type":"structure",
"members":{
"ThemeVersionSummaryList":{
"shape":"ThemeVersionSummaryList",
"documentation":"<p>A structure containing a list of all the versions of the specified theme.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"ListThemesRequest":{
"type":"structure",
"required":["AwsAccountId"],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the themes that you're listing.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to be returned per request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Type":{
"shape":"ThemeType",
"documentation":"<p>The type of themes that you want to list. Valid options include the following:</p> <ul> <li> <p> <code>ALL (default)</code>- Display all existing themes.</p> </li> <li> <p> <code>CUSTOM</code> - Display only the themes created by people using Amazon QuickSight.</p> </li> <li> <p> <code>QUICKSIGHT</code> - Display only the starting themes defined by QuickSight.</p> </li> </ul>",
"location":"querystring",
"locationName":"type"
}
}
},
"ListThemesResponse":{
"type":"structure",
"members":{
"ThemeSummaryList":{
"shape":"ThemeSummaryList",
"documentation":"<p>Information about the themes in the list.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
"documentation":"<p>The Amazon QuickSight user name that you want to list group memberships for.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The AWS account ID that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
}
}
},
"ListUserGroupsResponse":{
"type":"structure",
"members":{
"GroupList":{
"shape":"GroupList",
"documentation":"<p>The list of groups the user is a member of.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"ListUsersRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"Namespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
"location":"querystring",
"locationName":"next-token"
},
"MaxResults":{
"shape":"MaxResults",
"documentation":"<p>The maximum number of results to return from this request.</p>",
"box":true,
"location":"querystring",
"locationName":"max-results"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
}
}
},
"ListUsersResponse":{
"type":"structure",
"members":{
"UserList":{
"shape":"UserList",
"documentation":"<p>The list of users.</p>"
},
"NextToken":{
"shape":"String",
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"LogicalTable":{
"type":"structure",
"required":[
"Alias",
"Source"
],
"members":{
"Alias":{
"shape":"LogicalTableAlias",
"documentation":"<p>A display name for the logical table.</p>"
},
"DataTransforms":{
"shape":"TransformOperationList",
"documentation":"<p>Transform operations that act on this logical table.</p>"
},
"Source":{
"shape":"LogicalTableSource",
"documentation":"<p>Source of this logical table.</p>"
}
},
"documentation":"<p>A <i>logical table</i> is a unit that joins and that data transformations operate on. A logical table has a source, which can be either a physical table or result of a join. When a logical table points to a physical table, the logical table acts as a mutable copy of that physical table through transform operations.</p>"
"documentation":"<p>Specifies the result of a join of two logical tables.</p>"
},
"PhysicalTableId":{
"shape":"PhysicalTableId",
"documentation":"<p>Physical table ID.</p>"
}
},
"documentation":"<p>Information about the source of a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
},
"Long":{"type":"long"},
"LongList":{
"type":"list",
"member":{"shape":"Long"}
},
"ManifestFileLocation":{
"type":"structure",
"required":[
"Bucket",
"Key"
],
"members":{
"Bucket":{
"shape":"S3Bucket",
"documentation":"<p>Amazon S3 bucket.</p>"
},
"Key":{
"shape":"S3Key",
"documentation":"<p>Amazon S3 key that identifies an object.</p>"
"documentation":"<p>A physical table type for relational data sources.</p>"
},
"CustomSql":{
"shape":"CustomSql",
"documentation":"<p>A physical table type built from the results of the custom SQL query.</p>"
},
"S3Source":{
"shape":"S3Source",
"documentation":"<p>A physical table type for as S3 data source.</p>"
}
},
"documentation":"<p>A view of a data source that contains information about the shape of the data in the underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
"documentation":"<p>A transform operation that projects columns. Operations that come after a projection can only refer to projected columns.</p>"
},
"ProjectedColumnList":{
"type":"list",
"member":{"shape":"String"},
"max":2000,
"min":1
},
"Query":{
"type":"string",
"max":256,
"min":1
},
"QueueInfo":{
"type":"structure",
"required":[
"WaitingOnIngestion",
"QueuedIngestion"
],
"members":{
"WaitingOnIngestion":{
"shape":"string",
"documentation":"<p>The ID of the queued ingestion.</p>"
},
"QueuedIngestion":{
"shape":"string",
"documentation":"<p>The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.</p>"
}
},
"documentation":"<p>Information about a queued dataset SPICE ingestion.</p>"
},
"QuickSightUserNotFoundException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this request.</p>"
}
},
"documentation":"<p>The user with the provided name isn't found. This error can happen in any operation that requires finding a user based on a provided user name, such as <code>DeleteUser</code>, <code>DescribeUser</code>, and so on.</p>",
"documentation":"<p>Host. This field can be blank if <code>ClusterId</code> is provided.</p>"
},
"Port":{
"shape":"OptionalPort",
"documentation":"<p>Port. This field can be blank if the <code>ClusterId</code> is provided.</p>"
},
"Database":{
"shape":"Database",
"documentation":"<p>Database.</p>"
},
"ClusterId":{
"shape":"ClusterId",
"documentation":"<p>Cluster ID. This field can be blank if the <code>Host</code> and <code>Port</code> are provided.</p>"
}
},
"documentation":"<p>Amazon Redshift parameters. The <code>ClusterId</code> field can be blank if <code>Host</code> and <code>Port</code> are both set. The <code>Host</code> and <code>Port</code> fields can be blank if the <code>ClusterId</code> field is set.</p>"
},
"RegisterUserRequest":{
"type":"structure",
"required":[
"IdentityType",
"Email",
"UserRole",
"AwsAccountId",
"Namespace"
],
"members":{
"IdentityType":{
"shape":"IdentityType",
"documentation":"<p>Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:</p> <ul> <li> <p> <code>IAM</code>: A user whose identity maps to an existing IAM user or role. </p> </li> <li> <p> <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by Amazon QuickSight. </p> </li> </ul>"
},
"Email":{
"shape":"String",
"documentation":"<p>The email address of the user that you want to register.</p>"
},
"UserRole":{
"shape":"UserRole",
"documentation":"<p>The Amazon QuickSight role for the user. The user role can be one of the following:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> <li> <p> <code>RESTRICTED_READER</code>: This role isn't currently available for use.</p> </li> <li> <p> <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p> </li> </ul>"
},
"IamArn":{
"shape":"String",
"documentation":"<p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>"
"documentation":"<p>You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see <a href=\"https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html\"> <code>assume-role</code> </a> in the <i>AWS CLI Reference.</i> </p>"
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"UserName":{
"shape":"UserName",
"documentation":"<p>The Amazon QuickSight user name that you want to create for the user you are registering.</p>"
"documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>To add custom permissions to an existing user, use <code> <a>UpdateUser</a> </code> instead.</p> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a QuickSight user. </p> <p>QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).</p> <p>This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).</p>"
"documentation":"<p>The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of <code>QUICKSIGHT</code>.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"RelationalTable":{
"type":"structure",
"required":[
"DataSourceArn",
"Name",
"InputColumns"
],
"members":{
"DataSourceArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the data source.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the principal. This can be one of the following:</p> <ul> <li> <p>The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.)</p> </li> <li> <p>The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.)</p> </li> <li> <p>The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.) </p> </li> </ul>"
"documentation":"<p>The type of permissions to use when interpretting the permissions for RLS. <code>DENY_ACCESS</code> is included for backward compatibility only.</p>"
"documentation":"<p>Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html\">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported for new RLS datasets.</p>"
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name, for example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
"documentation":"<p>The unique identifier associated with a sheet.</p>"
},
"Name":{
"shape":"NonEmptyString",
"documentation":"<p>The name of a sheet. This name is displayed on the sheet's tab in the QuickSight console.</p>"
}
},
"documentation":"<p>A <i>sheet</i>, which is an object that contains a set of visuals that are viewed together on one page in the Amazon QuickSight console. Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.</p>"
"documentation":"<p>The key or keys of the key-value pairs for the resource tag or tags assigned to the resource.</p>"
},
"TagColumnOperation":{
"type":"structure",
"required":[
"ColumnName",
"Tags"
],
"members":{
"ColumnName":{
"shape":"ColumnName",
"documentation":"<p>The column that this operation acts on.</p>"
},
"Tags":{
"shape":"ColumnTagList",
"documentation":"<p>The dataset column tag, currently only used for geospatial type tagging. .</p> <note> <p>This is not tags for the AWS tagging feature. .</p> </note>"
}
},
"documentation":"<p>A transform operation that tags a column with additional information.</p>"
"documentation":"<p>A template object. A <i>template</i> is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create a dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with an analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.</p> <p>You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a dashboard from an existing template.</p>"
"documentation":"<p>Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.</p>"
"documentation":"<p>The Amazon Resource Name (ARN) of the theme alias.</p>"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The display name of the theme alias.</p>"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme alias.</p>"
}
},
"documentation":"<p>An alias for a theme.</p>"
},
"ThemeAliasList":{
"type":"list",
"member":{"shape":"ThemeAlias"},
"max":100
},
"ThemeConfiguration":{
"type":"structure",
"members":{
"DataColorPalette":{
"shape":"DataColorPalette",
"documentation":"<p>Color properties that apply to chart data colors.</p>"
},
"UIColorPalette":{
"shape":"UIColorPalette",
"documentation":"<p>Color properties that apply to the UI and to charts, excluding the colors that apply to data. </p>"
},
"Sheet":{
"shape":"SheetStyle",
"documentation":"<p>Display options related to sheets.</p>"
}
},
"documentation":"<p>The theme configuration. This configuration contains all of the display properties for a theme.</p>"
},
"ThemeError":{
"type":"structure",
"members":{
"Type":{
"shape":"ThemeErrorType",
"documentation":"<p>The type of error.</p>"
},
"Message":{
"shape":"NonEmptyString",
"documentation":"<p>The error message.</p>"
}
},
"documentation":"<p>Theme error.</p>"
},
"ThemeErrorList":{
"type":"list",
"member":{"shape":"ThemeError"},
"min":1
},
"ThemeErrorType":{
"type":"string",
"enum":["INTERNAL_FAILURE"]
},
"ThemeName":{
"type":"string",
"max":2048,
"min":1
},
"ThemeSummary":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>the display name for the theme.</p>"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the theme. This ID is unique per AWS Region for each AWS account.</p>"
},
"LatestVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The latest version number for the theme. </p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme was created.</p>"
},
"LastUpdatedTime":{
"shape":"Timestamp",
"documentation":"<p>The last date and time that this theme was updated.</p>"
}
},
"documentation":"<p>The theme summary.</p>"
},
"ThemeSummaryList":{
"type":"list",
"member":{"shape":"ThemeSummary"},
"max":100
},
"ThemeType":{
"type":"string",
"enum":[
"QUICKSIGHT",
"CUSTOM",
"ALL"
]
},
"ThemeVersion":{
"type":"structure",
"members":{
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the theme.</p>"
},
"BaseThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme version was created.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains all the theme display properties.</p>"
},
"Errors":{
"shape":"ThemeErrorList",
"documentation":"<p>Errors associated with the theme.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the theme version.</p>"
}
},
"documentation":"<p>A version of a theme.</p>"
},
"ThemeVersionSummary":{
"type":"structure",
"members":{
"VersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme version.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme version.</p>"
},
"Description":{
"shape":"VersionDescription",
"documentation":"<p>The description of the theme version.</p>"
},
"CreatedTime":{
"shape":"Timestamp",
"documentation":"<p>The date and time that this theme version was created.</p>"
},
"Status":{
"shape":"ResourceStatus",
"documentation":"<p>The status of the theme version.</p>"
"documentation":"<p>A data transformation on a logical table. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.</p>"
"documentation":"<p>The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.</p>"
},
"PrimaryBackground":{
"shape":"HexColor",
"documentation":"<p>The background color that applies to visuals and other high emphasis UI.</p>"
},
"SecondaryForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.</p>"
},
"SecondaryBackground":{
"shape":"HexColor",
"documentation":"<p>The background color that applies to the sheet background and sheet controls.</p>"
},
"Accent":{
"shape":"HexColor",
"documentation":"<p>This color is that applies to selected states and buttons.</p>"
},
"AccentForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the accent color.</p>"
},
"Danger":{
"shape":"HexColor",
"documentation":"<p>The color that applies to error messages.</p>"
},
"DangerForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the error color.</p>"
},
"Warning":{
"shape":"HexColor",
"documentation":"<p>This color that applies to warning and informational messages.</p>"
},
"WarningForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the warning color.</p>"
},
"Success":{
"shape":"HexColor",
"documentation":"<p>The color that applies to success messages, for example the check mark for a successful download.</p>"
},
"SuccessForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the success color.</p>"
},
"Dimension":{
"shape":"HexColor",
"documentation":"<p>The color that applies to the names of fields that are identified as dimensions.</p>"
},
"DimensionForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the dimension color.</p>"
},
"Measure":{
"shape":"HexColor",
"documentation":"<p>The color that applies to the names of fields that are identified as measures.</p>"
},
"MeasureForeground":{
"shape":"HexColor",
"documentation":"<p>The foreground color that applies to any text or other elements that appear over the measure color.</p>"
"documentation":"<p>The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexadecimal color code that consists of six alphanumerical characters, prefixed with <code>#</code>, for example #37BFF5. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/themes-in-quicksight.html\">Using Themes in Amazon QuickSight</a> in the <i>Amazon QuickSight User Guide.</i> </p>"
},
"UnsupportedPricingPlanException":{
"type":"structure",
"members":{
"Message":{"shape":"String"},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this request.</p>"
}
},
"documentation":"<p>This error indicates that you are calling an embedding operation in Amazon QuickSight without the required pricing plan on your AWS account. Before you can use embedding for anonymous users, a QuickSight administrator needs to add capacity pricing to QuickSight. You can do this on the <b>Manage QuickSight</b> page. </p> <p>After capacity pricing is added, you can use the <a>GetDashboardEmbedUrl</a> API operation with the <code>--identity-type ANONYMOUS</code> option.</p>",
"documentation":"<p>This error indicates that you are calling an operation on an Amazon QuickSight subscription where the edition doesn't include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>",
"documentation":"<p>The ID for the AWS account that you want to update QuickSight customizations for.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace that you want to update QuickSight customizations for.</p>",
"location":"querystring",
"locationName":"namespace"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The QuickSight customizations you're updating in the current AWS Region. </p>"
}
}
},
"UpdateAccountCustomizationResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the updated customization for this AWS account.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that you want to update QuickSight customizations for.</p>"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace associated with the customization that you're updating.</p>"
},
"AccountCustomization":{
"shape":"AccountCustomization",
"documentation":"<p>The QuickSight customizations you're updating in the current AWS Region. </p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAccountSettingsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"DefaultNamespace"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that contains the QuickSight settings that you want to list.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"DefaultNamespace":{
"shape":"Namespace",
"documentation":"<p>The default namespace for this AWS account. Currently, the default is <code>default</code>. AWS Identity and Access Management (IAM) users that register for the first time with QuickSight provide an email that becomes associated with the default namespace.</p>"
},
"NotificationEmail":{
"shape":"String",
"documentation":"<p>The email address that you want QuickSight to send notifications to regarding your AWS account or QuickSight subscription.</p>"
}
}
},
"UpdateAccountSettingsResponse":{
"type":"structure",
"members":{
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAnalysisPermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the analysis whose permissions you're updating. You must be using the AWS account that the analysis is in.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A structure that describes the permissions to add and the principal to add them to.</p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A structure that describes the permissions to remove and the principal to remove them from.</p>"
}
}
},
"UpdateAnalysisPermissionsResponse":{
"type":"structure",
"members":{
"AnalysisArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the analysis that you updated.</p>"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis that you updated permissions for.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>A structure that describes the principals and the resource-level permissions on an analysis.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateAnalysisRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"AnalysisId",
"Name",
"SourceEntity"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the analysis that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the analysis that you're updating. This ID displays in the URL of the analysis.</p>",
"location":"uri",
"locationName":"AnalysisId"
},
"Name":{
"shape":"AnalysisName",
"documentation":"<p>A descriptive name for the analysis that you're updating. This name displays for the analysis in the QuickSight console.</p>"
},
"Parameters":{
"shape":"Parameters",
"documentation":"<p>The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values. </p>"
},
"SourceEntity":{
"shape":"AnalysisSourceEntity",
"documentation":"<p>A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the QuickSight console, make sure that you have access to it.</p>"
}
}
},
"UpdateAnalysisResponse":{
"type":"structure",
"members":{
"Arn":{
"shape":"Arn",
"documentation":"<p>The ARN of the analysis that you're updating.</p>"
},
"AnalysisId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID of the analysis.</p>"
},
"UpdateStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The update status of the last update that was made to the analysis.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
"documentation":"<p>The entity that you are using as a source when you update the dashboard. In <code>SourceEntity</code>, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a <code>SourceTemplate</code> entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the <a>CreateTemplate</a> API operation. For <code>SourceTemplate</code>, specify the Amazon Resource Name (ARN) of the source template. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
"documentation":"<p>A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.</p>"
"documentation":"<p>Options for publishing the dashboard when you create it:</p> <ul> <li> <p> <code>AvailabilityStatus</code> for <code>AdHocFilteringOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. When this is set to <code>DISABLED</code>, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>AvailabilityStatus</code> for <code>ExportToCSVOption</code> - This status can be either <code>ENABLED</code> or <code>DISABLED</code>. The visual option to export data to .CSV format isn't enabled when this is set to <code>DISABLED</code>. This option is <code>ENABLED</code> by default. </p> </li> <li> <p> <code>VisibilityState</code> for <code>SheetControlsOption</code> - This visibility state can be either <code>COLLAPSED</code> or <code>EXPANDED</code>. This option is <code>COLLAPSED</code> by default. </p> </li> </ul>"
"documentation":"<p>The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.</p>"
"documentation":"<p>The parameters that QuickSight uses to connect to your underlying source.</p>"
},
"Credentials":{
"shape":"DataSourceCredentials",
"documentation":"<p>The credentials that QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.</p>"
},
"VpcConnectionProperties":{
"shape":"VpcConnectionProperties",
"documentation":"<p>Use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.</p>"
},
"SslProperties":{
"shape":"SslProperties",
"documentation":"<p>Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.</p>"
"documentation":"<p>The name of the group that you want to update.</p>",
"location":"uri",
"locationName":"GroupName"
},
"Description":{
"shape":"GroupDescription",
"documentation":"<p>The description for the group that you want to update.</p>"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy to apply to the QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The QuickSight users, groups, or both that you want to assign the policy to.</p>"
"documentation":"<p>The ID of the assignment.</p>"
},
"PolicyArn":{
"shape":"Arn",
"documentation":"<p>The ARN for the IAM policy applied to the QuickSight users and groups specified in this assignment.</p>"
},
"Identities":{
"shape":"IdentityMap",
"documentation":"<p>The QuickSight users, groups, or both that the IAM policy is assigned to.</p>"
},
"AssignmentStatus":{
"shape":"AssignmentStatus",
"documentation":"<p>The status of the assignment. Possible values are as follows:</p> <ul> <li> <p> <code>ENABLED</code> - Anything specified in this assignment is used when creating the data source.</p> </li> <li> <p> <code>DISABLED</code> - This assignment isn't used when creating the data source.</p> </li> <li> <p> <code>DRAFT</code> - This assignment is an unfinished draft and isn't used when creating the data source.</p> </li> </ul>"
"documentation":"<p>The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword <code>$LATEST</code> in the <code>AliasName</code> parameter. The keyword <code>$PUBLISHED</code> doesn't apply to templates.</p>",
"location":"uri",
"locationName":"AliasName"
},
"TemplateVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the template.</p>"
"documentation":"<p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any AWS Account and any QuickSight-supported AWS Region. </p> <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>"
"documentation":"<p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>"
},
"Name":{
"shape":"TemplateName",
"documentation":"<p>The name for the template.</p>"
"documentation":"<p>The ID of the AWS account that contains the theme alias that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"AliasName":{
"shape":"AliasName",
"documentation":"<p>The name of the theme alias that you want to update.</p>",
"location":"uri",
"locationName":"AliasName"
},
"ThemeVersionNumber":{
"shape":"VersionNumber",
"documentation":"<p>The version number of the theme that the alias should reference.</p>"
}
}
},
"UpdateThemeAliasResponse":{
"type":"structure",
"members":{
"ThemeAlias":{
"shape":"ThemeAlias",
"documentation":"<p>Information about the theme alias.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
}
}
},
"UpdateThemePermissionsRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the theme.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"GrantPermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be granted for the theme.</p>"
},
"RevokePermissions":{
"shape":"UpdateResourcePermissionList",
"documentation":"<p>A list of resource permissions to be revoked from the theme.</p>"
}
}
},
"UpdateThemePermissionsResponse":{
"type":"structure",
"members":{
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>"
},
"ThemeArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) of the theme.</p>"
},
"Permissions":{
"shape":"ResourcePermissionList",
"documentation":"<p>The resulting list of resource permissions for the theme.</p>"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
}
}
},
"UpdateThemeRequest":{
"type":"structure",
"required":[
"AwsAccountId",
"ThemeId",
"BaseThemeId"
],
"members":{
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID of the AWS account that contains the theme that you're updating.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>",
"location":"uri",
"locationName":"ThemeId"
},
"Name":{
"shape":"ThemeName",
"documentation":"<p>The name for the theme.</p>"
},
"BaseThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.</p>"
},
"VersionDescription":{
"shape":"VersionDescription",
"documentation":"<p>A description of the theme version that you're updating Every time that you call <code>UpdateTheme</code>, you create a new version of the theme. Each version of the theme maintains a description of the version in <code>VersionDescription</code>.</p>"
},
"Configuration":{
"shape":"ThemeConfiguration",
"documentation":"<p>The theme configuration, which contains the theme display properties.</p>"
}
}
},
"UpdateThemeResponse":{
"type":"structure",
"members":{
"ThemeId":{
"shape":"RestrictiveResourceId",
"documentation":"<p>The ID for the theme.</p>"
},
"Arn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the theme.</p>"
},
"VersionArn":{
"shape":"Arn",
"documentation":"<p>The Amazon Resource Name (ARN) for the new version of the theme.</p>"
},
"CreationStatus":{
"shape":"ResourceStatus",
"documentation":"<p>The creation status of the theme.</p>"
},
"Status":{
"shape":"StatusCode",
"documentation":"<p>The HTTP status of the request.</p>",
"location":"statusCode"
},
"RequestId":{
"shape":"String",
"documentation":"<p>The AWS request ID for this operation.</p>"
"documentation":"<p>The Amazon QuickSight user name that you want to update.</p>",
"location":"uri",
"locationName":"UserName"
},
"AwsAccountId":{
"shape":"AwsAccountId",
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
"location":"uri",
"locationName":"AwsAccountId"
},
"Namespace":{
"shape":"Namespace",
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
"location":"uri",
"locationName":"Namespace"
},
"Email":{
"shape":"String",
"documentation":"<p>The email address of the user that you want to update.</p>"
"documentation":"<p>The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> </ul> <p>The name of the QuickSight role is invisible to the user except for the console screens dealing with permissions.</p>"
},
"CustomPermissionsName":{
"shape":"RoleName",
"documentation":"<p>(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:</p> <ul> <li> <p>Create and update data sources</p> </li> <li> <p>Create and update datasets</p> </li> <li> <p>Create and update email reports</p> </li> <li> <p>Subscribe to email reports</p> </li> </ul> <p>A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the QuickSight console. Then, you use the <code>RegisterUser</code> API operation to assign the named set of permissions to a QuickSight user. </p> <p>QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning QuickSight users to one of the default security cohorts in QuickSight (admin, author, reader).</p> <p>This feature is available only to QuickSight Enterprise edition subscriptions that use SAML 2.0-Based Federation for Single Sign-On (SSO).</p>"
},
"UnapplyCustomPermissions":{
"shape":"Boolean",
"documentation":"<p>A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.</p>"
"documentation":"<p>The Amazon QuickSight role for the user. The user role can be one of the following:.</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, datasets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> <li> <p> <code>RESTRICTED_READER</code>: This role isn't currently available for use.</p> </li> <li> <p> <code>RESTRICTED_AUTHOR</code>: This role isn't currently available for use.</p> </li> </ul>"
"documentation":"<p>The active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.</p>"
"documentation":"<fullname>Amazon QuickSight API Reference</fullname> <p>Amazon QuickSight is a fully managed, serverless business intelligence service for the AWS Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight. </p>"