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 • 48.5 kB

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, cloud business intelligence service that makes it easy to extend data and insights to every user in your organization. This API interface 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-direct":true}],"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://aws.amazon.com/quicksight/"},"x-hasEquivalentPaths":true,"security":[{"hmac":[]}],"paths":{"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups":{"post":{"operationId":"CreateGroup","description":"Creates an Amazon QuickSight group. The permissions resource is <code>arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> </code>. The response is a group object. CLI Sample: <code>aws quicksight create-group --aws-account-id=111122223333 --namespace=default --group-name=\"Sales-Management\" --description=\"Sales Management - Forecasting\" </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"486":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}],"get":{"operationId":"ListGroups","description":"Lists all user groups in Amazon QuickSight. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/*</code>. The response is a list of group objects. CLI Sample: <code>aws quicksight list-groups -\\-aws-account-id=111122223333 -\\-namespace=default </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupsResponse"}}}},"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":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"485":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupsRequest"}}},"required":true}}},"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}":{"put":{"operationId":"CreateGroupMembership","description":"Adds an Amazon QuickSight user to an Amazon QuickSight group. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> </code>. The condition resource is the user name. The condition key is <code>quicksight:UserName</code>. The response is the group member object. CLI Sample: <code>aws quicksight create-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales --member-name=Pat </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupMembershipResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}},{"name":"MemberName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupMembershipRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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":"DeleteGroupMembership","description":"Removes a user from a group so that the user is no longer a member of the group. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> </code>. The condition resource is the user name. The condition key is <code>quicksight:UserName</code>. CLI Sample: <code>aws quicksight delete-group-membership --aws-account-id=111122223333 --namespace=default --group-name=Sales-Management --member-name=Charlie </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupMembershipResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}},{"name":"MemberName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupMembershipRequest"}}},"required":true}}},"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}":{"delete":{"operationId":"DeleteGroup","description":"Removes a user group from Amazon QuickSight. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> </code>. CLI Sample: <code>aws quicksight delete-group -\\-aws-account-id=111122223333 -\\-namespace=default -\\-group-name=Sales-Management </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}],"get":{"operationId":"DescribeGroup","description":"Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). The permissions resource is <code>arn:aws:quicksight:us-east-1:<relevant-aws-account-id>:group/default/<group-name> </code>. The response is the group object. CLI Sample: <code>aws quicksight describe-group -\\-aws-account-id=11112222333 -\\-namespace=default -\\-group-name=Sales </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeGroupResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeGroupRequest"}}},"required":true}},"put":{"operationId":"UpdateGroup","description":"Changes a group description. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> </code>. The response is a group object. CLI Sample: <code>aws quicksight update-group --aws-account-id=111122223333 --namespace=default --group-name=Sales --description=\"Sales BI Dashboards\" </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGroupRequest"}}},"required":true}}},"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}":{"delete":{"operationId":"DeleteUser","description":"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. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> </code>. CLI Sample: <code>aws quicksight delete-user --aws-account-id=111122223333 --namespace=default --user-name=Pat </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"UserName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}],"get":{"operationId":"DescribeUser","description":"Returns information about a user, given the user name. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> </code>. The response is a user object that contains the user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: <code>aws quicksight describe-user --aws-account-id=111122223333 --namespace=default --user-name=Pat </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeUserResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"UserName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DescribeUserRequest"}}},"required":true}},"put":{"operationId":"UpdateUser","description":"Updates an Amazon QuickSight user. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> </code>. The response is a user object that contains the user's Amazon QuickSight user name, email address, active or inactive status in Amazon QuickSight, Amazon QuickSight role, and Amazon Resource Name (ARN). CLI Sample: <code>aws quicksight update-user --user-name=Pat --role=ADMIN --email=new_address@amazon.com --aws-account-id=111122223333 --namespace=default --region=us-east-1 </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"UserName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}},"required":true}}},"/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url":{"get":{"operationId":"GetDashboardEmbedUrl","description":"Generates a server-side embeddable URL and authorization code. Before this can work properly, first you need to configure the dashboards and user permissions. For more information, see <a href=\"https://docs.aws.amazon.com/en_us/quicksight/latest/user/embedding.html\"> Embedding Amazon QuickSight Dashboards</a>. Currently, you can use <code>GetDashboardEmbedURL</code> only from the server, not from the user’s browser. CLI Sample: Assume the role with permissions enabled for actions: <code>quickSight:RegisterUser</code> and <code>quicksight:GetDashboardEmbedURL</code>. You can use assume-role, assume-role-with-web-identity, or assume-role-with-saml. <code>aws sts assume-role --role-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --role-session-name embeddingsession</code> If the user does not exist in QuickSight, register the user: <code>aws quicksight register-user --aws-account-id 111122223333 --namespace default --identity-type IAM --iam-arn \"arn:aws:iam::111122223333:role/embedding_quicksight_dashboard_role\" --user-role READER --session-name \"embeddingsession\" --email user123@example.com --region us-east-1</code> Get the URL for the embedded dashboard <code>aws quicksight get-dashboard-embed-url --aws-account-id 111122223333 --dashboard-id 1a1ac2b2-3fc3-4b44-5e5d-c6db6778df89 --identity-type IAM</code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDashboardEmbedUrlResponse"}}}},"480":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"481":{"description":"InvalidParameterValueException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterValueException"}}}},"482":{"description":"ResourceExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceExistsException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"485":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"486":{"description":"DomainNotWhitelistedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainNotWhitelistedException"}}}},"487":{"description":"QuickSightUserNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuickSightUserNotFoundException"}}}},"488":{"description":"IdentityTypeNotSupportedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentityTypeNotSupportedException"}}}},"489":{"description":"SessionLifetimeInMinutesInvalidException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SessionLifetimeInMinutesInvalidException"}}}},"490":{"description":"UnsupportedUserEditionException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedUserEditionException"}}}},"491":{"description":"InternalFailureException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalFailureException"}}}},"492":{"description":"ResourceUnavailableException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceUnavailableException"}}}}},"parameters":[{"name":"AwsAccountId","in":"path","required":true,"schema":{"type":"string"}},{"name":"DashboardId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDashboardEmbedUrlRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}]},"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members":{"get":{"operationId":"ListGroupMemberships","description":"Lists member users in a group. The permissions resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:group/default/<group-name> </code>. The response is a list of group member objects. CLI Sample: <code>aws quicksight list-group-memberships -\\-aws-account-id=111122223333 -\\-namespace=default </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupMembershipsResponse"}}}},"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":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"485":{"description":"PreconditionNotMetException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreconditionNotMetException"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"GroupName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGroupMembershipsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}]},"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups":{"get":{"operationId":"ListUserGroups","description":"Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> </code>. The response is a one or more group objects. CLI Sample: <code>aws quicksight list-user-groups -\\-user-name=Pat -\\-aws-account-id=111122223333 -\\-namespace=default -\\-region=us-east-1 </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserGroupsResponse"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}},{"name":"UserName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUserGroupsRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}]},"/accounts/{AwsAccountId}/namespaces/{Namespace}/users":{"get":{"operationId":"ListUsers","description":"Returns a list of all of the Amazon QuickSight users belonging to this account. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/* </code>. The response is a list of user objects, containing each user's Amazon Resource Name (ARN), AWS Identity and Access Management (IAM) role, and email address. CLI Sample: <code>aws quicksight list-users --aws-account-id=111122223333 --namespace=default </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersResponse"}}}},"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":"InvalidNextTokenException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidNextTokenException"}}}},"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsersRequest"}}},"required":true}},"parameters":[{"$ref":"#/components/parameters/Action"},{"$ref":"#/components/parameters/Version"},{"$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"}],"post":{"operationId":"RegisterUser","description":"Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. The permission resource is <code>arn:aws:quicksight:us-east-1:<aws-account-id>:user/default/<user-name> </code>. The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. The condition keys are <code>quicksight:IamArn</code> and <code>quicksight:SessionName</code>. CLI Sample: <code>aws quicksight register-user -\\-aws-account-id=111122223333 -\\-namespace=default -\\-email=pat@example.com -\\-identity-type=IAM -\\-user-role=AUTHOR -\\-iam-arn=arn:aws:iam::111122223333:user/Pat </code> ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUserResponse"}}}},"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":"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,"schema":{"type":"string"}},{"name":"Namespace","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisterUserRequest"}}},"required":true}}}},"servers":[{"url":"https://quicksight.amazonaws.com/"},{"url":"http://quicksight.amazonaws.com/"}],"components":{"parameters":{"Action":{"name":"Action","in":"query","required":true,"schema":{"type":"string"}},"Version":{"name":"Version","in":"query","required":true,"schema":{"type":"string"}},"X-Amz-Content-Sha256":{"name":"X-Amz-Content-Sha256","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Date":{"name":"X-Amz-Date","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Algorithm":{"name":"X-Amz-Algorithm","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Credential":{"name":"X-Amz-Credential","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Security-Token":{"name":"X-Amz-Security-Token","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-Signature":{"name":"X-Amz-Signature","in":"header","required":false,"schema":{"type":"string"}},"X-Amz-SignedHeaders":{"name":"X-Amz-SignedHeaders","in":"header","required":false,"schema":{"type":"string"}}},"securitySchemes":{"hmac":{"type":"apiKey","name":"Authorization","in":"header","description":"Amazon Signature authorization v4","x-amazon-apigateway-authtype":"awsSigv4"}},"schemas":{"CreateGroupResponse":{"type":"object","properties":{"Group":{"$ref":"#/components/schemas/Group"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}},"description":"The response object for this operation."},"CreateGroupRequest":{"type":"object","required":["GroupName"],"properties":{"GroupName":{"$ref":"#/components/schemas/GroupName"},"Description":{"$ref":"#/components/schemas/GroupDescription"}},"description":"The request object for this operation. "},"AccessDeniedException":{},"InvalidParameterValueException":{},"ResourceExistsException":{},"ResourceNotFoundException":{},"ThrottlingException":{},"PreconditionNotMetException":{},"LimitExceededException":{},"InternalFailureException":{},"ResourceUnavailableException":{},"CreateGroupMembershipResponse":{"type":"object","properties":{"GroupMember":{"$ref":"#/components/schemas/GroupMember"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"CreateGroupMembershipRequest":{"type":"object","properties":{}},"DeleteGroupResponse":{"type":"object","properties":{"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"DeleteGroupRequest":{"type":"object","properties":{}},"DeleteGroupMembershipResponse":{"type":"object","properties":{"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"DeleteGroupMembershipRequest":{"type":"object","properties":{}},"DeleteUserResponse":{"type":"object","properties":{"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"DeleteUserRequest":{"type":"object","properties":{}},"DescribeGroupResponse":{"type":"object","properties":{"Group":{"$ref":"#/components/schemas/Group"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"DescribeGroupRequest":{"type":"object","properties":{}},"DescribeUserResponse":{"type":"object","properties":{"User":{"$ref":"#/components/schemas/User"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"DescribeUserRequest":{"type":"object","properties":{}},"GetDashboardEmbedUrlResponse":{"type":"object","properties":{"EmbedUrl":{"$ref":"#/components/schemas/EmbeddingUrl"},"Status":{"$ref":"#/components/schemas/StatusCode"},"RequestId":{"$ref":"#/components/schemas/String"}}},"GetDashboardEmbedUrlRequest":{"type":"object","properties":{}},"DomainNotWhitelistedException":{},"QuickSightUserNotFoundException":{},"IdentityTypeNotSupportedException":{},"SessionLifetimeInMinutesInvalidException":{},"UnsupportedUserEditionException":{},"ListGroupMembershipsResponse":{"type":"object","properties":{"GroupMemberList":{"$ref":"#/components/schemas/GroupMemberList"},"NextToken":{"$ref":"#/components/schemas/String"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"ListGroupMembershipsRequest":{"type":"object","properties":{}},"InvalidNextTokenException":{},"ListGroupsResponse":{"type":"object","properties":{"GroupList":{"$ref":"#/components/schemas/GroupList"},"NextToken":{"$ref":"#/components/schemas/String"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"ListGroupsRequest":{"type":"object","properties":{}},"ListUserGroupsResponse":{"type":"object","properties":{"GroupList":{"$ref":"#/components/schemas/GroupList"},"NextToken":{"$ref":"#/components/schemas/String"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"ListUserGroupsRequest":{"type":"object","properties":{}},"ListUsersResponse":{"type":"object","properties":{"UserList":{"$ref":"#/components/schemas/UserList"},"NextToken":{"$ref":"#/components/schemas/String"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"ListUsersRequest":{"type":"object","properties":{}},"RegisterUserResponse":{"type":"object","properties":{"User":{"$ref":"#/components/schemas/User"},"UserInvitationUrl":{"$ref":"#/components/schemas/String"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"RegisterUserRequest":{"type":"object","required":["IdentityType","Email","UserRole"],"properties":{"IdentityType":{"$ref":"#/components/schemas/IdentityType"},"Email":{"$ref":"#/components/schemas/String"},"UserRole":{"$ref":"#/components/schemas/UserRole"},"IamArn":{"$ref":"#/components/schemas/String"},"SessionName":{"$ref":"#/components/schemas/String"},"UserName":{"$ref":"#/components/schemas/UserName"}}},"UpdateGroupResponse":{"type":"object","properties":{"Group":{"$ref":"#/components/schemas/Group"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"UpdateGroupRequest":{"type":"object","properties":{"Description":{"$ref":"#/components/schemas/GroupDescription"}}},"UpdateUserResponse":{"type":"object","properties":{"User":{"$ref":"#/components/schemas/User"},"RequestId":{"$ref":"#/components/schemas/String"},"Status":{"$ref":"#/components/schemas/StatusCode"}}},"UpdateUserRequest":{"type":"object","required":["Email","Role"],"properties":{"Email":{"$ref":"#/components/schemas/String"},"Role":{"$ref":"#/components/schemas/UserRole"}}},"Arn":{"type":"string"},"AwsAccountId":{"type":"string","pattern":"^[0-9]{12}$","minLength":12,"maxLength":12},"Boolean":{"type":"boolean"},"GroupMemberName":{"type":"string","pattern":"[\\u0020-\\u00FF]+","minLength":1,"maxLength":256},"GroupName":{"type":"string","pattern":"[\\u0020-\\u00FF]+","minLength":1},"Namespace":{"type":"string","pattern":"default"},"GroupMember":{"type":"object","properties":{"Arn":{"$ref":"#/components/schemas/Arn"},"MemberName":{"$ref":"#/components/schemas/GroupMemberName"}},"description":"A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. "},"String":{"type":"string"},"StatusCode":{"type":"integer"},"GroupDescription":{"type":"string","minLength":1,"maxLength":512},"Group":{"type":"object","properties":{"Arn":{"$ref":"#/components/schemas/Arn"},"GroupName":{"$ref":"#/components/schemas/GroupName"},"Description":{"$ref":"#/components/schemas/GroupDescription"}},"description":"A group in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups."},"UserName":{"type":"string","pattern":"[\\u0020-\\u00FF]+","minLength":1},"User":{"type":"object","properties":{"Arn":{"$ref":"#/components/schemas/Arn"},"UserName":{"$ref":"#/components/schemas/UserName"},"Email":{"$ref":"#/components/schemas/String"},"Role":{"$ref":"#/components/schemas/UserRole"},"IdentityType":{"$ref":"#/components/schemas/IdentityType"},"Active":{"$ref":"#/components/schemas/Boolean"}},"description":"A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users."},"EmbeddingUrl":{"type":"string","format":"password"},"IdentityType":{"type":"string","enum":["IAM","QUICKSIGHT"]},"SessionLifetimeInMinutes":{"type":"integer","minimum":15,"maximum":600},"boolean":{"type":"boolean"},"GroupList":{"type":"array","items":{"$ref":"#/components/schemas/Group"}},"GroupMemberList":{"type":"array","items":{"$ref":"#/components/schemas/GroupMember"}},"MaxResults":{"type":"integer","minimum":1,"maximum":100000},"UserList":{"type":"array","items":{"$ref":"#/components/schemas/User"}},"UserRole":{"type":"string","enum":["ADMIN","AUTHOR","READER","RESTRICTED_AUTHOR","RESTRICTED_READER"]}}}}