openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 1.29 MB

JSON

{"openapi":"3.0.0","info":{"version":"2018-04-01","x-release":"v4","title":"Amazon QuickSight","description":"<fullname>Amazon QuickSight API Reference</fullname> Amazon QuickSight is a fully managed, serverless business intelligence service for the Amazon Web Services Cloud that makes it easy to extend data and insights to every user in your organization. This API reference contains documentation for a programming interface that you can use to manage Amazon QuickSight. ","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"quicksight","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/quicksight-2018-04-01.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/quicksight/"},"servers":[{"url":"http://quicksight.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon QuickSight multi-region endpoint"},{"url":"https://quicksight.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon QuickSight multi-region endpoint"},{"url":"http://quicksight.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon QuickSight endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://quicksight.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon QuickSight endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/accounts/{AwsAccountId}/data-sets/{DataSetId}/ingestions/{IngestionId}":{"delete":{"operationId":"CancelIngestion","description":"Cancels an ongoing ingestion of data into SPICE.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelIngestionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"DataSetId","in":"path","required":true,"description":"The ID of the dataset used in the ingestion.","schema":{"type":"string"}},{"name":"IngestionId","in":"path","required":true,"description":"An ID for the ingestion.","schema":{"type":"string","pattern":"^[a-zA-Z0-9-_]+$","minLength":1,"maxLength":128}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"put":{"operationId":"CreateIngestion","description":"Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see <a href=\"http://aws.amazon.com/premiumsupport/knowledge-center/iam-ec2-resource-tags/\">How do I create an IAM policy to control access to Amazon EC2 resources using tags?</a> in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIngestionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"486":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"DataSetId","in":"path","required":true,"description":"The ID of the dataset used in the ingestion.","schema":{"type":"string"}},{"name":"IngestionId","in":"path","required":true,"description":"An ID for the ingestion.","schema":{"type":"string","pattern":"^[a-zA-Z0-9-_]+$","minLength":1,"maxLength":128}},{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"IngestionType":{"description":"This defines the type of ingestion user wants to trigger. This is part of create ingestion request.","type":"string","enum":["INCREMENTAL_REFRESH","FULL_REFRESH"]}}}}}}},"get":{"operationId":"DescribeIngestion","description":"Describes a SPICE ingestion.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeIngestionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"DataSetId","in":"path","required":true,"description":"The ID of the dataset used in the ingestion.","schema":{"type":"string"}},{"name":"IngestionId","in":"path","required":true,"description":"An ID for the ingestion.","schema":{"type":"string","pattern":"^[a-zA-Z0-9-_]+$","minLength":1,"maxLength":128}}]}},"/accounts/{AwsAccountId}/customizations":{"post":{"operationId":"CreateAccountCustomization","description":"Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the <code>CreateAccountCustomization</code> or <code>UpdateAccountCustomization</code> API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/customizing-quicksight.html\">Customizing Amazon QuickSight</a> in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation. Before you use the <code>CreateAccountCustomization</code> API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeThemePermissions.html\">DescribeThemePermissions</a> </code> API operation. To share the theme, grant permissions by using the <code> <a href=\"https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateThemePermissions.html\">UpdateThemePermissions</a> </code> API operation. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountCustomizationResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"484":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"486":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"487":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"namespace","in":"query","required":false,"description":"The Amazon QuickSight namespace that you want to add customizations to.","schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]*$","maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccountCustomization"],"properties":{"AccountCustomization":{"description":"The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.","type":"object","properties":{"DefaultTheme":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The default theme for this Amazon QuickSight subscription."}]},"DefaultEmailCustomizationTemplate":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The default email customization template."}]}}},"Tags":{"description":"A list of the tags that you want to attach to this resource.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":200}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteAccountCustomization","description":"Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAccountCustomizationResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"486":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"487":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"488":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"namespace","in":"query","required":false,"description":"The Amazon QuickSight namespace that you're deleting the customizations from.","schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]*$","maxLength":64}}]},"get":{"operationId":"DescribeAccountCustomization","description":"Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the <code>Resolved</code> flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. <ul> <li> <code>Amazon Web Services account</code> - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. </li> <li> <code>Amazon Web Services Region</code> - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: <ul> <li> Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-options.html\">command line options</a>. </li> <li> Use <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html\">named profiles</a>. </li> <li> Run <code>aws configure</code> to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see <a href=\"https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html\">Configuring the CLI</a>. </li> </ul> </li> <li> <code>Namespace</code> - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. </li> <li> <code>Applied customizations</code> - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the <code>CreateAccountCustomization</code> command in each Amazon Web Services Region where you want to apply the same customizations. </li> </ul>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAccountCustomizationResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"485":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"namespace","in":"query","required":false,"description":"The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.","schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]*$","maxLength":64}},{"name":"resolved","in":"query","required":false,"description":"The <code>Resolved</code> flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to <code>no-resolved</code>, to reveal customizations that are configured at different levels. ","schema":{"type":"boolean"}}]},"put":{"operationId":"UpdateAccountCustomization","description":"Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the <code>DescribeAccountCustomization</code> API operation. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAccountCustomizationResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"486":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"namespace","in":"query","required":false,"description":"The namespace that you want to update Amazon QuickSight customizations for.","schema":{"type":"string","pattern":"^[a-zA-Z0-9._-]*$","maxLength":64}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["AccountCustomization"],"properties":{"AccountCustomization":{"description":"The Amazon QuickSight customizations associated with your Amazon Web Services account or a QuickSight namespace in a specific Amazon Web Services Region.","type":"object","properties":{"DefaultTheme":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The default theme for this Amazon QuickSight subscription."}]},"DefaultEmailCustomizationTemplate":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The default email customization template."}]}}}}}}}}}},"/account/{AwsAccountId}":{"post":{"operationId":"CreateAccountSubscription","description":"Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. This operation isn't supported in the US East (Ohio) Region, South America (Sao Paulo) Region, or Asia Pacific (Singapore) Region. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/setting-up-aws-sign-up.html\">Sign up for Amazon Web Services</a> in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/iam-policy-examples.html\">IAM Policy Examples for Amazon QuickSight</a> in the Amazon QuickSight User Guide. If your IAM policy includes both the <code>Subscribe</code> and <code>CreateAccountSubscription</code> actions, make sure that both actions are set to <code>Allow</code>. If either action is set to <code>Deny</code>, the <code>Deny</code> action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/security_iam_service-with-iam.html#security-create-iam-role\">Passing IAM roles to Amazon QuickSight</a> in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/scoping-policies-defaults.html\">Setting default resource access to Amazon Web Services services</a> in the Amazon QuickSight User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAccountSubscriptionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"485":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"486":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"487":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"488":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Edition","AuthenticationMethod","AccountName","NotificationEmail"],"properties":{"Edition":{"description":"The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from <code>ENTERPRISE</code> or <code>ENTERPRISE_AND_Q</code>. If you choose <code>ENTERPRISE_AND_Q</code>, the following parameters are required: <ul> <li> <code>FirstName</code> </li> <li> <code>LastName</code> </li> <li> <code>EmailAddress</code> </li> <li> <code>ContactNumber</code> </li> </ul>","type":"string","enum":["STANDARD","ENTERPRISE","ENTERPRISE_AND_Q"]},"AuthenticationMethod":{"description":"The method that you want to use to authenticate your Amazon QuickSight account. Currently, the valid values for this parameter are <code>IAM_AND_QUICKSIGHT</code>, <code>IAM_ONLY</code>, and <code>ACTIVE_DIRECTORY</code>. If you choose <code>ACTIVE_DIRECTORY</code>, provide an <code>ActiveDirectoryName</code> and an <code>AdminGroup</code> associated with your Active Directory.","type":"string","enum":["IAM_AND_QUICKSIGHT","IAM_ONLY","ACTIVE_DIRECTORY"]},"AccountName":{"description":"The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change <code>AccountName</code> value after the Amazon QuickSight account is created.","type":"string"},"NotificationEmail":{"description":"The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.","type":"string"},"ActiveDirectoryName":{"description":"The name of your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.","type":"string"},"Realm":{"description":"The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account.","type":"string"},"DirectoryId":{"description":"The ID of the Active Directory that is associated with your Amazon QuickSight account.","type":"string"},"AdminGroup":{"description":"The admin group associated with your Active Directory. This field is required if <code>ACTIVE_DIRECTORY</code> is the selected authentication method of the new Amazon QuickSight account. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.","type":"array","items":{"$ref":"#/components/schemas/String"}},"AuthorGroup":{"description":"The author group associated with your Active Directory. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.","type":"array","items":{"$ref":"#/components/schemas/String"}},"ReaderGroup":{"description":"The reader group associated with your Active Direcrtory. For more information about using Active Directory in Amazon QuickSight, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/aws-directory-service.html\">Using Active Directory with Amazon QuickSight Enterprise Edition</a> in the Amazon QuickSight User Guide.","type":"array","items":{"$ref":"#/components/schemas/String"}},"FirstName":{"description":"The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.","type":"string"},"LastName":{"description":"The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.","type":"string"},"EmailAddress":{"description":"The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.","type":"string"},"ContactNumber":{"description":"A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if <code>ENTERPPRISE_AND_Q</code> is the selected edition of the new Amazon QuickSight account.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteAccountSubscription","description":"Use the <code>DeleteAccountSubscription</code> operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to <code>True</code>. To change this setting and delete your account, call the <code>UpdateAccountSettings</code> API and set the value of the <code>TerminationProtectionEnabled</code> parameter to <code>False</code>, then make another call to the <code>DeleteAccountSubscription</code> API.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAccountSubscriptionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"486":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID of the account that you want to delete.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}]},"get":{"operationId":"DescribeAccountSubscription","description":"Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an <code>AccountInfo</code> object that includes an account's name, subscription status, authentication type, edition, and notification email address.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAccountSubscriptionResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"485":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The Amazon Web Services account ID associated with your Amazon QuickSight account.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}}]}},"/accounts/{AwsAccountId}/analyses/{AnalysisId}":{"post":{"operationId":"CreateAnalysis","description":"Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an <code>AnalysisDefinition</code>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnalysisResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"484":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"485":{"description":"UnsupportedUserEditionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedUserEditionException"}}}},"486":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"487":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID of the Amazon Web Services account where you are creating an analysis.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"AnalysisId","in":"path","required":true,"description":"The ID for the analysis that you're creating. This ID displays in the URL of the analysis.","schema":{"type":"string","pattern":"[\\w\\-]+","minLength":1,"maxLength":512}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"description":"A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console. ","type":"string","minLength":1,"maxLength":2048},"Parameters":{"description":"A list of Amazon QuickSight parameters and the list's override values.","type":"object","properties":{"StringParameters":{"allOf":[{"$ref":"#/components/schemas/StringParameterList"},{"description":"The parameters that have a data type of string."}]},"IntegerParameters":{"allOf":[{"$ref":"#/components/schemas/IntegerParameterList"},{"description":"The parameters that have a data type of integer."}]},"DecimalParameters":{"allOf":[{"$ref":"#/components/schemas/DecimalParameterList"},{"description":"The parameters that have a data type of decimal."}]},"DateTimeParameters":{"allOf":[{"$ref":"#/components/schemas/DateTimeParameterList"},{"description":"The parameters that have a data type of date-time."}]}}},"Permissions":{"description":"A structure that describes the principals and the resource-level permissions on an analysis. You can use the <code>Permissions</code> structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). To specify no permissions, omit <code>Permissions</code>.","type":"array","items":{"$ref":"#/components/schemas/ResourcePermission"},"minItems":1,"maxItems":64},"SourceEntity":{"description":"The source entity of an analysis.","type":"object","properties":{"SourceTemplate":{"allOf":[{"$ref":"#/components/schemas/AnalysisSourceTemplate"},{"description":"The source template for the source entity of the analysis."}]}}},"ThemeArn":{"description":"The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.","type":"string"},"Tags":{"description":"Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.","type":"array","items":{"$ref":"#/components/schemas/Tag"},"minItems":1,"maxItems":200},"Definition":{"description":"The definition of an analysis.","type":"object","properties":{"DataSetIdentifierDeclarations":{"allOf":[{"$ref":"#/components/schemas/DataSetIdentifierDeclarationList"},{"description":"An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures."}]},"Sheets":{"allOf":[{"$ref":"#/components/schemas/SheetDefinitionList"},{"description":"An array of sheet definitions for an analysis. Each <code>SheetDefinition</code> provides detailed information about a sheet within this analysis."}]},"CalculatedFields":{"allOf":[{"$ref":"#/components/schemas/CalculatedFields"},{"description":"An array of calculated field definitions for the analysis."}]},"ParameterDeclarations":{"allOf":[{"$ref":"#/components/schemas/ParameterDeclarationList"},{"description":"An array of parameter declarations for an analysis. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/parameters-in-quicksight.html\">Parameters in Amazon QuickSight</a> in the Amazon QuickSight User Guide."}]},"FilterGroups":{"allOf":[{"$ref":"#/components/schemas/FilterGroupList"},{"description":"Filter definitions for an analysis. For more information, see <a href=\"https://docs.aws.amazon.com/quicksight/latest/user/adding-a-filter.html\">Filtering Data in Amazon QuickSight</a> in the Amazon QuickSight User Guide."}]},"ColumnConfigurations":{"allOf":[{"$ref":"#/components/schemas/ColumnConfigurationList"},{"description":" An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis. "}]},"AnalysisDefaults":{"$ref":"#/components/schemas/AnalysisDefaults"}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"delete":{"operationId":"DeleteAnalysis","description":"Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a <code>DeletionTime</code> stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. 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. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnalysisResponse"}}}},"480":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"UnsupportedUserEditionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedUserEditionException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID of the Amazon Web Services account where you want to delete an analysis.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"AnalysisId","in":"path","required":true,"description":"The ID of the analysis that you're deleting.","schema":{"type":"string","pattern":"[\\w\\-]+","minLength":1,"maxLength":512}},{"name":"recovery-window-in-days","in":"query","required":false,"description":"A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the <code>ForceDeleteWithoutRecovery</code> option in the same API call. The default value is 30.","schema":{"type":"integer","minimum":7,"maximum":30}},{"name":"force-delete-without-recovery","in":"query","required":false,"description":"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. ","schema":{"type":"boolean"}}]},"get":{"operationId":"DescribeAnalysis","description":"Provides a summary of the metadata for an analysis.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeAnalysisResponse"}}}},"480":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"483":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"484":{"description":"UnsupportedUserEditionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedUserEditionException"}}}},"485":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"description":"The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.","schema":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12}},{"name":"AnalysisId","in":"path","required":true,"description":"The ID of the analysis that you're describing. The ID is part of the URL of the analysis.","schema":{"type":"string","pattern":"[\\w\\-]+","minLength":1,"maxLength":512}}]},"put":{"operationId":"UpdateAnalysis","description":"Updates an analysis in Amazon QuickSight","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnalysisResponse"}}}},"480":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"484":{"description":