Skip to content

Commit d8690ed

Browse files
author
AWS
committed
Amazon QuickSight Update: Added SearchDashboards API that allows listing of dashboards that a specific user has access to.
1 parent 3d31503 commit d8690ed

File tree

3 files changed

+109
-0
lines changed

3 files changed

+109
-0
lines changed
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon QuickSight",
4+
"description": "Added SearchDashboards API that allows listing of dashboards that a specific user has access to."
5+
}

services/quicksight/src/main/resources/codegen-resources/paginators-1.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,11 @@
3939
"input_token": "NextToken",
4040
"output_token": "NextToken",
4141
"limit_key": "MaxResults"
42+
},
43+
"SearchDashboards": {
44+
"input_token": "NextToken",
45+
"output_token": "NextToken",
46+
"limit_key": "MaxResults"
4247
}
4348
}
4449
}

services/quicksight/src/main/resources/codegen-resources/service-2.json

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -930,6 +930,24 @@
930930
],
931931
"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>"
932932
},
933+
"SearchDashboards":{
934+
"name":"SearchDashboards",
935+
"http":{
936+
"method":"POST",
937+
"requestUri":"/accounts/{AwsAccountId}/search/dashboards"
938+
},
939+
"input":{"shape":"SearchDashboardsRequest"},
940+
"output":{"shape":"SearchDashboardsResponse"},
941+
"errors":[
942+
{"shape":"ThrottlingException"},
943+
{"shape":"ResourceNotFoundException"},
944+
{"shape":"InvalidParameterValueException"},
945+
{"shape":"UnsupportedUserEditionException"},
946+
{"shape":"InvalidNextTokenException"},
947+
{"shape":"InternalFailureException"}
948+
],
949+
"documentation":"<p>Searchs for dashboards that belong to a user. </p>"
950+
},
933951
"TagResource":{
934952
"name":"TagResource",
935953
"http":{
@@ -2337,6 +2355,10 @@
23372355
"COLUMN_REPLACEMENT_MISSING"
23382356
]
23392357
},
2358+
"DashboardFilterAttribute":{
2359+
"type":"string",
2360+
"enum":["QUICKSIGHT_USER"]
2361+
},
23402362
"DashboardName":{
23412363
"type":"string",
23422364
"max":2048,
@@ -2361,6 +2383,30 @@
23612383
},
23622384
"documentation":"<p>Dashboard publish options.</p>"
23632385
},
2386+
"DashboardSearchFilter":{
2387+
"type":"structure",
2388+
"required":["Operator"],
2389+
"members":{
2390+
"Operator":{
2391+
"shape":"FilterOperator",
2392+
"documentation":"<p>The comparison operator that you want to use as a filter. For example, <code>\"Operator\": \"StringEquals\"</code>.</p>"
2393+
},
2394+
"Name":{
2395+
"shape":"DashboardFilterAttribute",
2396+
"documentation":"<p>The name of the value that you want to use as a filter. For example, <code>\"Name\": \"QUICKSIGHT_USER\"</code>. </p>"
2397+
},
2398+
"Value":{
2399+
"shape":"String",
2400+
"documentation":"<p>The value of the named item, in this case <code>QUICKSIGHT_USER</code>, that you want to use as a filter. For example, <code>\"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"</code>. </p>"
2401+
}
2402+
},
2403+
"documentation":"<p>A filter that you apply when searching for dashboards. </p>"
2404+
},
2405+
"DashboardSearchFilterList":{
2406+
"type":"list",
2407+
"member":{"shape":"DashboardSearchFilter"},
2408+
"max":1
2409+
},
23642410
"DashboardSourceEntity":{
23652411
"type":"structure",
23662412
"members":{
@@ -4064,6 +4110,10 @@
40644110
},
40654111
"documentation":"<p>A transform operation that filters rows based on a condition.</p>"
40664112
},
4113+
"FilterOperator":{
4114+
"type":"string",
4115+
"enum":["StringEquals"]
4116+
},
40674117
"GeoSpatialColumnGroup":{
40684118
"type":"structure",
40694119
"required":[
@@ -6137,6 +6187,55 @@
61376187
},
61386188
"documentation":"<p>A physical table type for as S3 data source.</p>"
61396189
},
6190+
"SearchDashboardsRequest":{
6191+
"type":"structure",
6192+
"required":[
6193+
"AwsAccountId",
6194+
"Filters"
6195+
],
6196+
"members":{
6197+
"AwsAccountId":{
6198+
"shape":"AwsAccountId",
6199+
"documentation":"<p>The ID of the AWS account that contains the user whose dashboards you're searching for. </p>",
6200+
"location":"uri",
6201+
"locationName":"AwsAccountId"
6202+
},
6203+
"Filters":{
6204+
"shape":"DashboardSearchFilterList",
6205+
"documentation":"<p>The filters to apply to the search. Currently, you can search only by user name. For example, <code>\"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]</code> </p>"
6206+
},
6207+
"NextToken":{
6208+
"shape":"String",
6209+
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
6210+
},
6211+
"MaxResults":{
6212+
"shape":"MaxResults",
6213+
"documentation":"<p>The maximum number of results to be returned per request.</p>"
6214+
}
6215+
}
6216+
},
6217+
"SearchDashboardsResponse":{
6218+
"type":"structure",
6219+
"members":{
6220+
"DashboardSummaryList":{
6221+
"shape":"DashboardSummaryList",
6222+
"documentation":"<p>The list of dashboards owned by the user specified in <code>Filters</code> in your request.</p>"
6223+
},
6224+
"NextToken":{
6225+
"shape":"String",
6226+
"documentation":"<p>The token for the next set of results, or null if there are no more results.</p>"
6227+
},
6228+
"Status":{
6229+
"shape":"StatusCode",
6230+
"documentation":"<p>The HTTP status of the request.</p>",
6231+
"location":"statusCode"
6232+
},
6233+
"RequestId":{
6234+
"shape":"String",
6235+
"documentation":"<p>The AWS request ID for this operation.</p>"
6236+
}
6237+
}
6238+
},
61406239
"ServiceNowParameters":{
61416240
"type":"structure",
61426241
"required":["SiteBaseUrl"],

0 commit comments

Comments
 (0)