1479 lines
53 KiB
JSON
1479 lines
53 KiB
JSON
{
|
||
"version":"2.0",
|
||
"metadata":{
|
||
"apiVersion":"2018-04-01",
|
||
"endpointPrefix":"quicksight",
|
||
"jsonVersion":"1.0",
|
||
"protocol":"rest-json",
|
||
"serviceFullName":"Amazon QuickSight",
|
||
"serviceId":"QuickSight",
|
||
"signatureVersion":"v4",
|
||
"uid":"quicksight-2018-04-01"
|
||
},
|
||
"operations":{
|
||
"CreateGroup":{
|
||
"name":"CreateGroup",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups"
|
||
},
|
||
"input":{"shape":"CreateGroupRequest"},
|
||
"output":{"shape":"CreateGroupResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceExistsException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"LimitExceededException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Creates an Amazon QuickSight group.</p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is a group object.</p>"
|
||
},
|
||
"CreateGroupMembership":{
|
||
"name":"CreateGroupMembership",
|
||
"http":{
|
||
"method":"PUT",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
|
||
},
|
||
"input":{"shape":"CreateGroupMembershipRequest"},
|
||
"output":{"shape":"CreateGroupMembershipResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Adds an Amazon QuickSight user to an Amazon QuickSight group. </p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The condition resource is the user name.</p> <p>The condition key is <code>quicksight:UserName</code>.</p> <p>The response is the group member object.</p>"
|
||
},
|
||
"DeleteGroup":{
|
||
"name":"DeleteGroup",
|
||
"http":{
|
||
"method":"DELETE",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
|
||
},
|
||
"input":{"shape":"DeleteGroupRequest"},
|
||
"output":{"shape":"DeleteGroupResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Removes a user group from Amazon QuickSight. </p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i> </code>.</p>"
|
||
},
|
||
"DeleteGroupMembership":{
|
||
"name":"DeleteGroupMembership",
|
||
"http":{
|
||
"method":"DELETE",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members/{MemberName}"
|
||
},
|
||
"input":{"shape":"DeleteGroupMembershipRequest"},
|
||
"output":{"shape":"DeleteGroupMembershipResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Removes a user from a group so that the user is no longer a member of the group.</p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The condition resource is the user name.</p> <p>The condition key is <code>quicksight:UserName</code>.</p>"
|
||
},
|
||
"DeleteUser":{
|
||
"name":"DeleteUser",
|
||
"http":{
|
||
"method":"DELETE",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
|
||
},
|
||
"input":{"shape":"DeleteUserRequest"},
|
||
"output":{"shape":"DeleteUserResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Deletes the Amazon QuickSight user that is associated with the identity of the AWS Identity and Access Management (IAM) user or role that's making the call. The IAM user isn't deleted as a result of this call. </p> <p>The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name> </i> </code>.</p>"
|
||
},
|
||
"DescribeGroup":{
|
||
"name":"DescribeGroup",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
|
||
},
|
||
"input":{"shape":"DescribeGroupRequest"},
|
||
"output":{"shape":"DescribeGroupResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN). </p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><relevant-aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is the group object. </p>"
|
||
},
|
||
"DescribeUser":{
|
||
"name":"DescribeUser",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
|
||
},
|
||
"input":{"shape":"DescribeUserRequest"},
|
||
"output":{"shape":"DescribeUserResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Returns information about a user, given the user name. </p> <p>The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i> </code>. </p> <p>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. </p>"
|
||
},
|
||
"GetDashboardEmbedUrl":{
|
||
"name":"GetDashboardEmbedUrl",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/dashboards/{DashboardId}/embed-url"
|
||
},
|
||
"input":{"shape":"GetDashboardEmbedUrlRequest"},
|
||
"output":{"shape":"GetDashboardEmbedUrlResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceExistsException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"DomainNotWhitelistedException"},
|
||
{"shape":"QuickSightUserNotFoundException"},
|
||
{"shape":"IdentityTypeNotSupportedException"},
|
||
{"shape":"SessionLifetimeInMinutesInvalidException"},
|
||
{"shape":"UnsupportedUserEditionException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Generates an embedded URL and authorization code. Before this can work properly, you need to configure the dashboards and user permissions first. </p>"
|
||
},
|
||
"ListGroupMemberships":{
|
||
"name":"ListGroupMemberships",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}/members"
|
||
},
|
||
"input":{"shape":"ListGroupMembershipsRequest"},
|
||
"output":{"shape":"ListGroupMembershipsResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InvalidNextTokenException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Lists member users in a group.</p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is a list of group member objects.</p>"
|
||
},
|
||
"ListGroups":{
|
||
"name":"ListGroups",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups"
|
||
},
|
||
"input":{"shape":"ListGroupsRequest"},
|
||
"output":{"shape":"ListGroupsResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InvalidNextTokenException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Lists all user groups in Amazon QuickSight. </p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/*</code>.</p> <p>The response is a list of group objects. </p>"
|
||
},
|
||
"ListUserGroups":{
|
||
"name":"ListUserGroups",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}/groups"
|
||
},
|
||
"input":{"shape":"ListUserGroupsRequest"},
|
||
"output":{"shape":"ListUserGroupsResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Lists the Amazon QuickSight groups that a user is part of.</p>"
|
||
},
|
||
"ListUsers":{
|
||
"name":"ListUsers",
|
||
"http":{
|
||
"method":"GET",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users"
|
||
},
|
||
"input":{"shape":"ListUsersRequest"},
|
||
"output":{"shape":"ListUsersResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InvalidNextTokenException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Returns a list of all of the Amazon QuickSight users belonging to this account. </p> <p>The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i>*</i> </code>.</p> <p>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. </p>"
|
||
},
|
||
"RegisterUser":{
|
||
"name":"RegisterUser",
|
||
"http":{
|
||
"method":"POST",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users"
|
||
},
|
||
"input":{"shape":"RegisterUserRequest"},
|
||
"output":{"shape":"RegisterUserResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"LimitExceededException"},
|
||
{"shape":"ResourceExistsException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Creates an Amazon QuickSight user, whose identity is associated with the AWS Identity and Access Management (IAM) identity or role specified in the request. </p> <p>The permission resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:user/default/<i><user-name></i> </code>.</p> <p>The condition resource is the Amazon Resource Name (ARN) for the IAM user or role, and the session name. </p> <p>The condition keys are <code>quicksight:IamArn</code> and <code>quicksight:SessionName</code>. </p>"
|
||
},
|
||
"UpdateGroup":{
|
||
"name":"UpdateGroup",
|
||
"http":{
|
||
"method":"PUT",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/groups/{GroupName}"
|
||
},
|
||
"input":{"shape":"UpdateGroupRequest"},
|
||
"output":{"shape":"UpdateGroupResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"PreconditionNotMetException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Changes a group description. </p> <p>The permissions resource is <code>arn:aws:quicksight:us-east-1:<i><aws-account-id></i>:group/default/<i><group-name></i> </code>.</p> <p>The response is a group object.</p>"
|
||
},
|
||
"UpdateUser":{
|
||
"name":"UpdateUser",
|
||
"http":{
|
||
"method":"PUT",
|
||
"requestUri":"/accounts/{AwsAccountId}/namespaces/{Namespace}/users/{UserName}"
|
||
},
|
||
"input":{"shape":"UpdateUserRequest"},
|
||
"output":{"shape":"UpdateUserResponse"},
|
||
"errors":[
|
||
{"shape":"AccessDeniedException"},
|
||
{"shape":"InvalidParameterValueException"},
|
||
{"shape":"ResourceNotFoundException"},
|
||
{"shape":"ThrottlingException"},
|
||
{"shape":"InternalFailureException"},
|
||
{"shape":"ResourceUnavailableException"}
|
||
],
|
||
"documentation":"<p>Updates an Amazon QuickSight user.</p>"
|
||
}
|
||
},
|
||
"shapes":{
|
||
"AccessDeniedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request id for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>You don't have access to this.</p>",
|
||
"error":{"httpStatusCode":401},
|
||
"exception":true
|
||
},
|
||
"Arn":{"type":"string"},
|
||
"AwsAccountId":{
|
||
"type":"string",
|
||
"max":12,
|
||
"min":12,
|
||
"pattern":"^[0-9]{12}$"
|
||
},
|
||
"Boolean":{"type":"boolean"},
|
||
"CreateGroupMembershipRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"MemberName",
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"MemberName":{
|
||
"shape":"GroupMemberName",
|
||
"documentation":"<p>The name of the user that you want to add to the group membership.</p>",
|
||
"location":"uri",
|
||
"locationName":"MemberName"
|
||
},
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to add the user to.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"CreateGroupMembershipResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"GroupMember":{
|
||
"shape":"GroupMember",
|
||
"documentation":"<p>The group member.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"CreateGroupRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>A name for the group that you want to create.</p>"
|
||
},
|
||
"Description":{
|
||
"shape":"GroupDescription",
|
||
"documentation":"<p>A description for the group that you want to create.</p>"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
},
|
||
"documentation":"<p>The request object for this operation. </p>"
|
||
},
|
||
"CreateGroupResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Group":{
|
||
"shape":"Group",
|
||
"documentation":"<p>The name of the group.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
},
|
||
"documentation":"<p>The response object for this operation.</p>"
|
||
},
|
||
"DeleteGroupMembershipRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"MemberName",
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"MemberName":{
|
||
"shape":"GroupMemberName",
|
||
"documentation":"<p>The name of the user that you want to delete from the group membership.</p>",
|
||
"location":"uri",
|
||
"locationName":"MemberName"
|
||
},
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to delete the user from.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"DeleteGroupMembershipResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"DeleteGroupRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to delete.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"DeleteGroupResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"DeleteUserRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"UserName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The name of the user that you want to delete.</p>",
|
||
"location":"uri",
|
||
"locationName":"UserName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"DeleteUserResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"DescribeGroupRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to describe.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"DescribeGroupResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Group":{
|
||
"shape":"Group",
|
||
"documentation":"<p>The name of the group.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"DescribeUserRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"UserName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The name of the user that you want to describe.</p>",
|
||
"location":"uri",
|
||
"locationName":"UserName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"DescribeUserResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"User":{
|
||
"shape":"User",
|
||
"documentation":"<p>The user name.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"DomainNotWhitelistedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The domain specified is not on the allowlist. All domains for embedded dashboards must be added to the approved list by an Amazon QuickSight admin.</p>",
|
||
"error":{"httpStatusCode":407},
|
||
"exception":true
|
||
},
|
||
"EmbeddingUrl":{
|
||
"type":"string",
|
||
"sensitive":true
|
||
},
|
||
"ExceptionResourceType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"USER",
|
||
"GROUP",
|
||
"NAMESPACE",
|
||
"DATA_SOURCE",
|
||
"DATA_SET",
|
||
"VPC_CONNECTION",
|
||
"INGESTION"
|
||
]
|
||
},
|
||
"GetDashboardEmbedUrlRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"AwsAccountId",
|
||
"DashboardId",
|
||
"IdentityType"
|
||
],
|
||
"members":{
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>AWS account ID that contains the dashboard you are embedding.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"DashboardId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The ID for the dashboard, also added to IAM policy</p>",
|
||
"location":"uri",
|
||
"locationName":"DashboardId"
|
||
},
|
||
"IdentityType":{
|
||
"shape":"IdentityType",
|
||
"documentation":"<p>The authentication method the user uses to sign in (IAM or QUICKSIGHT).</p>",
|
||
"location":"querystring",
|
||
"locationName":"creds-type"
|
||
},
|
||
"SessionLifetimeInMinutes":{
|
||
"shape":"SessionLifetimeInMinutes",
|
||
"documentation":"<p>How many minutes the session is valid. The session lifetime must be between 15 and 600 minutes.</p>",
|
||
"location":"querystring",
|
||
"locationName":"session-lifetime"
|
||
},
|
||
"UndoRedoDisabled":{
|
||
"shape":"boolean",
|
||
"documentation":"<p>Remove the undo/redo button on embedded dashboard. The default is FALSE, which enables the undo/redo button.</p>",
|
||
"location":"querystring",
|
||
"locationName":"undo-redo-disabled"
|
||
},
|
||
"ResetDisabled":{
|
||
"shape":"boolean",
|
||
"documentation":"<p>Remove the reset button on embedded dashboard. The default is FALSE, which allows the reset button.</p>",
|
||
"location":"querystring",
|
||
"locationName":"reset-disabled"
|
||
}
|
||
}
|
||
},
|
||
"GetDashboardEmbedUrlResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"EmbedUrl":{
|
||
"shape":"EmbeddingUrl",
|
||
"documentation":"<p>Call the GetDashboardEmbedUrl API to get the URL that you can embed in your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code that enables a single-signon session. </p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
}
|
||
}
|
||
},
|
||
"Group":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Arn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for the group.</p>"
|
||
},
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group.</p>"
|
||
},
|
||
"Description":{
|
||
"shape":"GroupDescription",
|
||
"documentation":"<p>The group description.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>A <i>group</i> in Amazon QuickSight consists of a set of users. You can use groups to make it easier to manage access and security. Currently, an Amazon QuickSight subscription can't contain more than 500 Amazon QuickSight groups.</p>"
|
||
},
|
||
"GroupDescription":{
|
||
"type":"string",
|
||
"max":512,
|
||
"min":1
|
||
},
|
||
"GroupList":{
|
||
"type":"list",
|
||
"member":{"shape":"Group"}
|
||
},
|
||
"GroupMember":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Arn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for the group member (user).</p>"
|
||
},
|
||
"MemberName":{
|
||
"shape":"GroupMemberName",
|
||
"documentation":"<p>The name of the group member (user).</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>A member of an Amazon QuickSight group. Currently, group members must be users. Groups can't be members of another group. </p>"
|
||
},
|
||
"GroupMemberList":{
|
||
"type":"list",
|
||
"member":{"shape":"GroupMember"}
|
||
},
|
||
"GroupMemberName":{
|
||
"type":"string",
|
||
"max":256,
|
||
"min":1,
|
||
"pattern":"[\\u0020-\\u00FF]+"
|
||
},
|
||
"GroupName":{
|
||
"type":"string",
|
||
"min":1,
|
||
"pattern":"[\\u0020-\\u00FF]+"
|
||
},
|
||
"IdentityType":{
|
||
"type":"string",
|
||
"enum":[
|
||
"IAM",
|
||
"QUICKSIGHT"
|
||
]
|
||
},
|
||
"IdentityTypeNotSupportedException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The identity type specified is not supported. Supported identity types include: IAM and QUICKSIGHT.</p>",
|
||
"error":{"httpStatusCode":416},
|
||
"exception":true
|
||
},
|
||
"InternalFailureException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>An internal failure occurred.</p>",
|
||
"error":{"httpStatusCode":500},
|
||
"exception":true,
|
||
"fault":true
|
||
},
|
||
"InvalidNextTokenException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The <code>NextToken</code> value isn't valid.</p>",
|
||
"error":{"httpStatusCode":400},
|
||
"exception":true
|
||
},
|
||
"InvalidParameterValueException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>One or more parameters don't have a valid value.</p>",
|
||
"error":{"httpStatusCode":400},
|
||
"exception":true
|
||
},
|
||
"LimitExceededException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"ResourceType":{
|
||
"shape":"ExceptionResourceType",
|
||
"documentation":"<p>Limit exceeded.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>A limit is exceeded.</p>",
|
||
"error":{"httpStatusCode":409},
|
||
"exception":true
|
||
},
|
||
"ListGroupMembershipsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to see a membership list of.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
|
||
"location":"querystring",
|
||
"locationName":"next-token"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to return from this request.</p>",
|
||
"box":true,
|
||
"location":"querystring",
|
||
"locationName":"max-results"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"ListGroupMembershipsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"GroupMemberList":{
|
||
"shape":"GroupMemberList",
|
||
"documentation":"<p>The list of the members of the group.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"ListGroupsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
|
||
"location":"querystring",
|
||
"locationName":"next-token"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to return.</p>",
|
||
"box":true,
|
||
"location":"querystring",
|
||
"locationName":"max-results"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"ListGroupsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"GroupList":{
|
||
"shape":"GroupList",
|
||
"documentation":"<p>The list of the groups.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"ListUserGroupsRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"UserName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The name of the user that you want to list groups for.</p>",
|
||
"location":"uri",
|
||
"locationName":"UserName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The AWS Account ID that the user is in. Currently, use the AWS Account ID which contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
|
||
"location":"querystring",
|
||
"locationName":"next-token"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to return from this request.</p>",
|
||
"box":true,
|
||
"location":"querystring",
|
||
"locationName":"max-results"
|
||
}
|
||
}
|
||
},
|
||
"ListUserGroupsResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"GroupList":{
|
||
"shape":"GroupList",
|
||
"documentation":"<p>The list of groups the user is a member of.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"ListUsersRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>",
|
||
"location":"querystring",
|
||
"locationName":"next-token"
|
||
},
|
||
"MaxResults":{
|
||
"shape":"MaxResults",
|
||
"documentation":"<p>The maximum number of results to return from this request.</p>",
|
||
"box":true,
|
||
"location":"querystring",
|
||
"locationName":"max-results"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"ListUsersResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"UserList":{
|
||
"shape":"UserList",
|
||
"documentation":"<p>The list of users.</p>"
|
||
},
|
||
"NextToken":{
|
||
"shape":"String",
|
||
"documentation":"<p>A pagination token that can be used in a subsequent request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"MaxResults":{
|
||
"type":"integer",
|
||
"max":100000,
|
||
"min":1
|
||
},
|
||
"Namespace":{
|
||
"type":"string",
|
||
"pattern":"default"
|
||
},
|
||
"PreconditionNotMetException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>One or more preconditions aren't met.</p>",
|
||
"error":{"httpStatusCode":400},
|
||
"exception":true
|
||
},
|
||
"QuickSightUserNotFoundException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The user is not found. This could happen in any operation that requires finding a user based on the provided user name, such as DeleteUser, DescribeUser, and so on.</p>",
|
||
"error":{"httpStatusCode":412},
|
||
"exception":true
|
||
},
|
||
"RegisterUserRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"IdentityType",
|
||
"Email",
|
||
"UserRole",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"IdentityType":{
|
||
"shape":"IdentityType",
|
||
"documentation":"<p>Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:</p> <ul> <li> <p> <code>IAM</code>: A user whose identity maps to an existing IAM user or role. </p> </li> <li> <p> <code>QUICKSIGHT</code>: A user whose identity is owned and managed internally by Amazon QuickSight. </p> </li> </ul>"
|
||
},
|
||
"Email":{
|
||
"shape":"String",
|
||
"documentation":"<p>The email address of the user that you want to register.</p>"
|
||
},
|
||
"UserRole":{
|
||
"shape":"UserRole",
|
||
"documentation":"<p>The Amazon QuickSight role of the user. The user role can be one of the following:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, data sets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> </ul>"
|
||
},
|
||
"IamArn":{
|
||
"shape":"String",
|
||
"documentation":"<p>The ARN of the IAM user or role that you are registering with Amazon QuickSight. </p>"
|
||
},
|
||
"SessionName":{
|
||
"shape":"String",
|
||
"documentation":"<p>The name of the session with the assumed IAM role. By using this parameter, you can register multiple users with the same IAM role, provided that each has a different session name. For more information on assuming IAM roles, see <a href=\"https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html\"> <code>assume-role</code> </a> in the <i>AWS CLI Reference.</i> </p>"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
},
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The Amazon QuickSight user name that you want to create for the user you are registering.</p>"
|
||
}
|
||
}
|
||
},
|
||
"RegisterUserResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"User":{
|
||
"shape":"User",
|
||
"documentation":"<p>The user name.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"ResourceExistsException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"ResourceType":{
|
||
"shape":"ExceptionResourceType",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The resource specified doesn't exist. </p>",
|
||
"error":{"httpStatusCode":409},
|
||
"exception":true
|
||
},
|
||
"ResourceNotFoundException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"ResourceType":{
|
||
"shape":"ExceptionResourceType",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>One or more resources couldn't be found.</p>",
|
||
"error":{"httpStatusCode":404},
|
||
"exception":true
|
||
},
|
||
"ResourceUnavailableException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"ResourceType":{
|
||
"shape":"ExceptionResourceType",
|
||
"documentation":"<p>The resource type for this request.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>This resource is currently unavailable.</p>",
|
||
"error":{"httpStatusCode":503},
|
||
"exception":true
|
||
},
|
||
"SessionLifetimeInMinutes":{
|
||
"type":"long",
|
||
"max":600,
|
||
"min":15
|
||
},
|
||
"SessionLifetimeInMinutesInvalidException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>The number of minutes specified for the lifetime of a session is invalid. The session lifetime must be between 15 and 600 minutes.</p>",
|
||
"error":{"httpStatusCode":418},
|
||
"exception":true
|
||
},
|
||
"StatusCode":{"type":"integer"},
|
||
"String":{"type":"string"},
|
||
"ThrottlingException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Access is throttled.</p>",
|
||
"error":{"httpStatusCode":429},
|
||
"exception":true
|
||
},
|
||
"UnsupportedUserEditionException":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Message":{"shape":"String"},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this request.</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>Indicates that you are calling an operation on an Amazon QuickSight subscription where the edition does not include support for that operation. Amazon QuickSight currently has Standard Edition and Enterprise Edition. Not every operation and capability is available in every edition.</p>",
|
||
"error":{"httpStatusCode":419},
|
||
"exception":true
|
||
},
|
||
"UpdateGroupRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"GroupName",
|
||
"AwsAccountId",
|
||
"Namespace"
|
||
],
|
||
"members":{
|
||
"GroupName":{
|
||
"shape":"GroupName",
|
||
"documentation":"<p>The name of the group that you want to update.</p>",
|
||
"location":"uri",
|
||
"locationName":"GroupName"
|
||
},
|
||
"Description":{
|
||
"shape":"GroupDescription",
|
||
"documentation":"<p>The description for the group that you want to update.</p>"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the group is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
}
|
||
}
|
||
},
|
||
"UpdateGroupResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Group":{
|
||
"shape":"Group",
|
||
"documentation":"<p>The name of the group.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"UpdateUserRequest":{
|
||
"type":"structure",
|
||
"required":[
|
||
"UserName",
|
||
"AwsAccountId",
|
||
"Namespace",
|
||
"Email",
|
||
"Role"
|
||
],
|
||
"members":{
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The Amazon QuickSight user name that you want to update.</p>",
|
||
"location":"uri",
|
||
"locationName":"UserName"
|
||
},
|
||
"AwsAccountId":{
|
||
"shape":"AwsAccountId",
|
||
"documentation":"<p>The ID for the AWS account that the user is in. Currently, you use the ID for the AWS account that contains your Amazon QuickSight account.</p>",
|
||
"location":"uri",
|
||
"locationName":"AwsAccountId"
|
||
},
|
||
"Namespace":{
|
||
"shape":"Namespace",
|
||
"documentation":"<p>The namespace. Currently, you should set this to <code>default</code>.</p>",
|
||
"location":"uri",
|
||
"locationName":"Namespace"
|
||
},
|
||
"Email":{
|
||
"shape":"String",
|
||
"documentation":"<p>The email address of the user that you want to update.</p>"
|
||
},
|
||
"Role":{
|
||
"shape":"UserRole",
|
||
"documentation":"<p>The Amazon QuickSight role of the user. The user role can be one of the following:</p> <ul> <li> <p> <code>READER</code>: A user who has read-only access to dashboards.</p> </li> <li> <p> <code>AUTHOR</code>: A user who can create data sources, data sets, analyses, and dashboards.</p> </li> <li> <p> <code>ADMIN</code>: A user who is an author, who can also manage Amazon QuickSight settings.</p> </li> </ul>"
|
||
}
|
||
}
|
||
},
|
||
"UpdateUserResponse":{
|
||
"type":"structure",
|
||
"members":{
|
||
"User":{
|
||
"shape":"User",
|
||
"documentation":"<p>The Amazon QuickSight user.</p>"
|
||
},
|
||
"RequestId":{
|
||
"shape":"String",
|
||
"documentation":"<p>The AWS request ID for this operation.</p>"
|
||
},
|
||
"Status":{
|
||
"shape":"StatusCode",
|
||
"documentation":"<p>The http status of the request.</p>",
|
||
"location":"statusCode"
|
||
}
|
||
}
|
||
},
|
||
"User":{
|
||
"type":"structure",
|
||
"members":{
|
||
"Arn":{
|
||
"shape":"Arn",
|
||
"documentation":"<p>The Amazon Resource Name (ARN) for the user.</p>"
|
||
},
|
||
"UserName":{
|
||
"shape":"UserName",
|
||
"documentation":"<p>The user's user name.</p>"
|
||
},
|
||
"Email":{
|
||
"shape":"String",
|
||
"documentation":"<p>The user's email address.</p>"
|
||
},
|
||
"Role":{
|
||
"shape":"UserRole",
|
||
"documentation":"<p>The Amazon QuickSight role for the user.</p>"
|
||
},
|
||
"IdentityType":{
|
||
"shape":"IdentityType",
|
||
"documentation":"<p>The type of identity authentication used by the user.</p>"
|
||
},
|
||
"Active":{
|
||
"shape":"Boolean",
|
||
"documentation":"<p>Active status of user. When you create an Amazon QuickSight user that’s not an IAM user or an AD user, that user is inactive until they sign in and provide a password</p>"
|
||
}
|
||
},
|
||
"documentation":"<p>A registered user of Amazon QuickSight. Currently, an Amazon QuickSight subscription can't contain more than 20 million users.</p>"
|
||
},
|
||
"UserList":{
|
||
"type":"list",
|
||
"member":{"shape":"User"}
|
||
},
|
||
"UserName":{
|
||
"type":"string",
|
||
"min":1,
|
||
"pattern":"[\\u0020-\\u00FF]+"
|
||
},
|
||
"UserRole":{
|
||
"type":"string",
|
||
"enum":[
|
||
"ADMIN",
|
||
"AUTHOR",
|
||
"READER",
|
||
"RESTRICTED_AUTHOR",
|
||
"RESTRICTED_READER"
|
||
]
|
||
},
|
||
"boolean":{"type":"boolean"}
|
||
},
|
||
"documentation":"<fullname>Amazon QuickSight API Reference</fullname> <p>Amazon QuickSight is a fast, cloud-powered BI service that makes it easy to build visualizations, perform ad hoc analysis, and quickly get business insights from your data. This API interface reference contains documentation for a programming interface that you can use to manage Amazon QuickSight. </p>"
|
||
}
|