Skip to content

Commit 9b3d7eb

Browse files
author
AWS
committed
Amazon Managed Grafana Update: This release adds tagging support to the Managed Grafana service. New APIs: TagResource, UntagResource and ListTagsForResource. Updates: add optional field tags to support tagging while calling CreateWorkspace.
1 parent b830d94 commit 9b3d7eb

File tree

2 files changed

+172
-5
lines changed

2 files changed

+172
-5
lines changed

‎.changes/next-release/feature-AmazonManagedGrafana-b2c0e85.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Managed Grafana",
4+
"contributor": "",
5+
"description": "This release adds tagging support to the Managed Grafana service. New APIs: TagResource, UntagResource and ListTagsForResource. Updates: add optional field tags to support tagging while calling CreateWorkspace."
6+
}

‎services/grafana/src/main/resources/codegen-resources/service-2.json

+166-5
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,24 @@
142142
],
143143
"documentation":"<p>Lists the users and groups who have the Grafana <code>Admin</code> and <code>Editor</code> roles in this workspace. If you use this operation without specifying <code>userId</code> or <code>groupId</code>, the operation returns the roles of all users and groups. If you specify a <code>userId</code> or a <code>groupId</code>, only the roles for that user or group are returned. If you do this, you can specify only one <code>userId</code> or one <code>groupId</code>.</p>"
144144
},
145+
"ListTagsForResource":{
146+
"name":"ListTagsForResource",
147+
"http":{
148+
"method":"GET",
149+
"requestUri":"/tags/{resourceArn}",
150+
"responseCode":200
151+
},
152+
"input":{"shape":"ListTagsForResourceRequest"},
153+
"output":{"shape":"ListTagsForResourceResponse"},
154+
"errors":[
155+
{"shape":"ResourceNotFoundException"},
156+
{"shape":"ThrottlingException"},
157+
{"shape":"ValidationException"},
158+
{"shape":"AccessDeniedException"},
159+
{"shape":"InternalServerException"}
160+
],
161+
"documentation":"<p>The <code>ListTagsForResource</code> operation returns the tags that are associated with the Amazon Managed Service for Grafana resource specified by the <code>resourceArn</code>. Currently, the only resource that can be tagged is a workspace. </p>"
162+
},
145163
"ListWorkspaces":{
146164
"name":"ListWorkspaces",
147165
"http":{
@@ -158,6 +176,43 @@
158176
],
159177
"documentation":"<p>Returns a list of Amazon Managed Grafana workspaces in the account, with some information about each workspace. For more complete information about one workspace, use <a href=\"https://docs.aws.amazon.com/AAMG/latest/APIReference/API_DescribeWorkspace.html\">DescribeWorkspace</a>.</p>"
160178
},
179+
"TagResource":{
180+
"name":"TagResource",
181+
"http":{
182+
"method":"POST",
183+
"requestUri":"/tags/{resourceArn}",
184+
"responseCode":200
185+
},
186+
"input":{"shape":"TagResourceRequest"},
187+
"output":{"shape":"TagResourceResponse"},
188+
"errors":[
189+
{"shape":"ResourceNotFoundException"},
190+
{"shape":"ThrottlingException"},
191+
{"shape":"ValidationException"},
192+
{"shape":"AccessDeniedException"},
193+
{"shape":"InternalServerException"}
194+
],
195+
"documentation":"<p>The <code>TagResource</code> operation associates tags with an Amazon Managed Grafana resource. Currently, the only resource that can be tagged is workspaces. </p> <p>If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag.</p>"
196+
},
197+
"UntagResource":{
198+
"name":"UntagResource",
199+
"http":{
200+
"method":"DELETE",
201+
"requestUri":"/tags/{resourceArn}",
202+
"responseCode":200
203+
},
204+
"input":{"shape":"UntagResourceRequest"},
205+
"output":{"shape":"UntagResourceResponse"},
206+
"errors":[
207+
{"shape":"ResourceNotFoundException"},
208+
{"shape":"ThrottlingException"},
209+
{"shape":"ValidationException"},
210+
{"shape":"AccessDeniedException"},
211+
{"shape":"InternalServerException"}
212+
],
213+
"documentation":"<p>The <code>UntagResource</code> operation removes the association of the tag with the Amazon Managed Grafana resource. </p>",
214+
"idempotent":true
215+
},
161216
"UpdatePermissions":{
162217
"name":"UpdatePermissions",
163218
"http":{
@@ -429,19 +484,23 @@
429484
},
430485
"permissionType":{
431486
"shape":"PermissionType",
432-
"documentation":"<p>If you specify <code>Service Managed</code>, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels.</p> <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html\">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a> </p>"
487+
"documentation":"<p>If you specify <code>SERVICE_MANAGED</code> on AWS Grafana console, Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use Amazon Web Services data sources and notification channels. In CLI mode, the permissionType <code>SERVICE_MANAGED</code> will not create the IAM role for you.</p> <p>If you specify <code>CUSTOMER_MANAGED</code>, you will manage those roles and permissions yourself. If you are creating this workspace in a member account of an organization that is not a delegated administrator account, and you want the workspace to access data sources in other Amazon Web Services accounts in the organization, you must choose <code>CUSTOMER_MANAGED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/grafana/latest/userguide/AMG-manage-permissions.html\">Amazon Managed Grafana permissions and policies for Amazon Web Services data sources and notification channels</a>.</p>"
433488
},
434489
"stackSetName":{
435490
"shape":"StackSetName",
436491
"documentation":"<p>The name of the CloudFormation stack set to use to generate IAM roles to be used for this workspace.</p>"
437492
},
493+
"tags":{
494+
"shape":"TagMap",
495+
"documentation":"<p>The list of tags associated with the workspace.</p>"
496+
},
438497
"workspaceDataSources":{
439498
"shape":"DataSourceTypesList",
440499
"documentation":"<p>Specify the Amazon Web Services data sources that you want to be queried in this workspace. Specifying these data sources here enables Amazon Managed Grafana to create IAM roles and permissions that allow Amazon Managed Grafana to read data from these sources. You must still add them as data sources in the Grafana console in the workspace.</p> <p>If you don't specify a data source here, you can still add it as a data source in the workspace console later. However, you will then have to manually configure permissions for it.</p>"
441500
},
442501
"workspaceDescription":{
443502
"shape":"Description",
444-
"documentation":"<p>A description for the workspace. This is used only to help you identify this workspace.</p>"
503+
"documentation":"<p>A description for the workspace. This is used only to help you identify this workspace.</p> <p>Pattern: <code>^[\\\\p{L}\\\\p{Z}\\\\p{N}\\\\p{P}]{0,2048}$</code> </p>"
445504
},
446505
"workspaceName":{
447506
"shape":"WorkspaceName",
@@ -457,7 +516,7 @@
457516
},
458517
"workspaceRoleArn":{
459518
"shape":"IamRoleArn",
460-
"documentation":"<p>The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. If you omit this field and you specify some Amazon Web Services resources in <code>workspaceDataSources</code> or <code>workspaceNotificationDestinations</code>, a new IAM role with the necessary permissions is automatically created.</p>"
519+
"documentation":"<p>The workspace needs an IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. If you already have a role that you want to use, specify it here. The permission type should be set to <code>CUSTOMER_MANAGED</code>.</p>"
461520
}
462521
}
463522
},
@@ -479,7 +538,9 @@
479538
"PROMETHEUS",
480539
"XRAY",
481540
"TIMESTREAM",
482-
"SITEWISE"
541+
"SITEWISE",
542+
"ATHENA",
543+
"REDSHIFT"
483544
]
484545
},
485546
"DataSourceTypesList":{
@@ -719,6 +780,27 @@
719780
}
720781
}
721782
},
783+
"ListTagsForResourceRequest":{
784+
"type":"structure",
785+
"required":["resourceArn"],
786+
"members":{
787+
"resourceArn":{
788+
"shape":"String",
789+
"documentation":"<p>The ARN of the resource the list of tags are associated with.</p>",
790+
"location":"uri",
791+
"locationName":"resourceArn"
792+
}
793+
}
794+
},
795+
"ListTagsForResourceResponse":{
796+
"type":"structure",
797+
"members":{
798+
"tags":{
799+
"shape":"TagMap",
800+
"documentation":"<p>The list of tags that are associated with the resource.</p>"
801+
}
802+
}
803+
},
722804
"ListWorkspacesRequest":{
723805
"type":"structure",
724806
"members":{
@@ -960,6 +1042,51 @@
9601042
},
9611043
"StackSetName":{"type":"string"},
9621044
"String":{"type":"string"},
1045+
"TagKey":{
1046+
"type":"string",
1047+
"max":128,
1048+
"min":1
1049+
},
1050+
"TagKeys":{
1051+
"type":"list",
1052+
"member":{"shape":"TagKey"}
1053+
},
1054+
"TagMap":{
1055+
"type":"map",
1056+
"key":{"shape":"TagKey"},
1057+
"value":{"shape":"TagValue"},
1058+
"max":50,
1059+
"min":0
1060+
},
1061+
"TagResourceRequest":{
1062+
"type":"structure",
1063+
"required":[
1064+
"resourceArn",
1065+
"tags"
1066+
],
1067+
"members":{
1068+
"resourceArn":{
1069+
"shape":"String",
1070+
"documentation":"<p>The ARN of the resource the tag is associated with.</p>",
1071+
"location":"uri",
1072+
"locationName":"resourceArn"
1073+
},
1074+
"tags":{
1075+
"shape":"TagMap",
1076+
"documentation":"<p>The list of tag keys and values to associate with the resource. You can associate tag keys only, tags (key and values) only or a combination of tag keys and tags.</p>"
1077+
}
1078+
}
1079+
},
1080+
"TagResourceResponse":{
1081+
"type":"structure",
1082+
"members":{
1083+
}
1084+
},
1085+
"TagValue":{
1086+
"type":"string",
1087+
"max":256,
1088+
"min":0
1089+
},
9631090
"ThrottlingException":{
9641091
"type":"structure",
9651092
"required":["message"],
@@ -992,6 +1119,32 @@
9921119
"retryable":{"throttling":false}
9931120
},
9941121
"Timestamp":{"type":"timestamp"},
1122+
"UntagResourceRequest":{
1123+
"type":"structure",
1124+
"required":[
1125+
"resourceArn",
1126+
"tagKeys"
1127+
],
1128+
"members":{
1129+
"resourceArn":{
1130+
"shape":"String",
1131+
"documentation":"<p>The ARN of the resource the tag association is removed from. </p>",
1132+
"location":"uri",
1133+
"locationName":"resourceArn"
1134+
},
1135+
"tagKeys":{
1136+
"shape":"TagKeys",
1137+
"documentation":"<p>The key values of the tag to be removed from the resource.</p>",
1138+
"location":"querystring",
1139+
"locationName":"tagKeys"
1140+
}
1141+
}
1142+
},
1143+
"UntagResourceResponse":{
1144+
"type":"structure",
1145+
"members":{
1146+
}
1147+
},
9951148
"UpdateAction":{
9961149
"type":"string",
9971150
"enum":[
@@ -1194,7 +1347,7 @@
11941347
"members":{
11951348
"id":{
11961349
"shape":"SsoId",
1197-
"documentation":"<p>The ID of the user or group.</p>"
1350+
"documentation":"<p>The ID of the user or group.</p> <p>Pattern: <code>^([0-9a-fA-F]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$</code> </p>"
11981351
},
11991352
"type":{
12001353
"shape":"UserType",
@@ -1365,6 +1518,10 @@
13651518
"shape":"WorkspaceStatus",
13661519
"documentation":"<p>The current status of the workspace.</p>"
13671520
},
1521+
"tags":{
1522+
"shape":"TagMap",
1523+
"documentation":"<p>The list of tags associated with the workspace.</p>"
1524+
},
13681525
"workspaceRoleArn":{
13691526
"shape":"IamRoleArn",
13701527
"documentation":"<p>The IAM role that grants permissions to the Amazon Web Services resources that the workspace will view data from. This role must already exist.</p>"
@@ -1452,6 +1609,10 @@
14521609
"status":{
14531610
"shape":"WorkspaceStatus",
14541611
"documentation":"<p>The current status of the workspace.</p>"
1612+
},
1613+
"tags":{
1614+
"shape":"TagMap",
1615+
"documentation":"<p>The list of tags associated with the workspace.</p>"
14551616
}
14561617
},
14571618
"documentation":"<p>A structure that contains some information about one workspace in the account.</p>"

0 commit comments

Comments
 (0)