Skip to content

Commit deef579

Browse files
author
AWS
committed
AWS Service Catalog App Registry Update: Introduction of GetAssociatedResource API and GetApplication response extension for Resource Groups support.
1 parent 97a2604 commit deef579

File tree

2 files changed

+151
-15
lines changed

2 files changed

+151
-15
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS Service Catalog App Registry",
4+
"contributor": "",
5+
"description": "Introduction of GetAssociatedResource API and GetApplication response extension for Resource Groups support."
6+
}

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

Lines changed: 145 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,22 @@
152152
],
153153
"documentation":"<p>Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a <code>ResourceNotFoundException</code> is thrown, avoiding the ABA addressing problem.</p>"
154154
},
155+
"GetAssociatedResource":{
156+
"name":"GetAssociatedResource",
157+
"http":{
158+
"method":"GET",
159+
"requestUri":"/applications/{application}/resources/{resourceType}/{resource}"
160+
},
161+
"input":{"shape":"GetAssociatedResourceRequest"},
162+
"output":{"shape":"GetAssociatedResourceResponse"},
163+
"errors":[
164+
{"shape":"ResourceNotFoundException"},
165+
{"shape":"ValidationException"},
166+
{"shape":"InternalServerException"}
167+
],
168+
"documentation":"<p>Gets the resource associated with the application.</p>",
169+
"idempotent":true
170+
},
155171
"GetAttributeGroup":{
156172
"name":"GetAttributeGroup",
157173
"http":{
@@ -257,7 +273,7 @@
257273
{"shape":"InternalServerException"},
258274
{"shape":"ConflictException"}
259275
],
260-
"documentation":"<p>Syncs the resource with what is currently recorded in App registry. Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.</p>"
276+
"documentation":"<p>Syncs the resource with current AppRegistry records.</p> <p>Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.</p>"
261277
},
262278
"TagResource":{
263279
"name":"TagResource",
@@ -354,21 +370,23 @@
354370
"documentation":"<p>Key-value pairs you can use to associate with the application.</p>"
355371
}
356372
},
357-
"documentation":"<p>Represents a Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.</p>"
373+
"documentation":"<p>Represents a Amazon Web Services Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.</p>"
358374
},
359375
"ApplicationArn":{
360376
"type":"string",
361377
"pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+"
362378
},
363379
"ApplicationId":{
364380
"type":"string",
365-
"pattern":"[a-z0-9]{12}"
381+
"max":26,
382+
"min":26,
383+
"pattern":"[a-z0-9]+"
366384
},
367385
"ApplicationSpecifier":{
368386
"type":"string",
369387
"max":256,
370388
"min":1,
371-
"pattern":"\\w+"
389+
"pattern":"[-.\\w]+"
372390
},
373391
"ApplicationSummaries":{
374392
"type":"list",
@@ -402,7 +420,7 @@
402420
"documentation":"<p> The ISO-8601 formatted timestamp of the moment when the application was last updated.</p>"
403421
}
404422
},
405-
"documentation":"<p>Summary of a Service Catalog AppRegistry application.</p>"
423+
"documentation":"<p>Summary of a Amazon Web Services Service Catalog AppRegistry application.</p>"
406424
},
407425
"Arn":{
408426
"type":"string",
@@ -521,17 +539,17 @@
521539
"documentation":"<p>Key-value pairs you can use to associate with the attribute group.</p>"
522540
}
523541
},
524-
"documentation":"<p>Represents a Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.</p>"
542+
"documentation":"<p>Represents a Amazon Web Services Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.</p>"
525543
},
526544
"AttributeGroupArn":{
527545
"type":"string",
528546
"pattern":"arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/attribute-groups/[a-z0-9]+"
529547
},
530548
"AttributeGroupId":{
531549
"type":"string",
532-
"max":100,
533-
"min":1,
534-
"pattern":"[a-z0-9]{12}"
550+
"max":26,
551+
"min":26,
552+
"pattern":"[a-z0-9]+"
535553
},
536554
"AttributeGroupIds":{
537555
"type":"list",
@@ -541,7 +559,7 @@
541559
"type":"string",
542560
"max":256,
543561
"min":1,
544-
"pattern":"\\w+"
562+
"pattern":"[-.\\w]+"
545563
},
546564
"AttributeGroupSummaries":{
547565
"type":"list",
@@ -575,7 +593,7 @@
575593
"documentation":"<p>The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.</p>"
576594
}
577595
},
578-
"documentation":"<p>Summary of a Service Catalog AppRegistry attribute group.</p>"
596+
"documentation":"<p>Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.</p>"
579597
},
580598
"Attributes":{
581599
"type":"string",
@@ -840,6 +858,47 @@
840858
"tags":{
841859
"shape":"Tags",
842860
"documentation":"<p>Key-value pairs associated with the application.</p>"
861+
},
862+
"integrations":{
863+
"shape":"Integrations",
864+
"documentation":"<p>The information about the integration of the application with other services, such as Resource Groups.</p>"
865+
}
866+
}
867+
},
868+
"GetAssociatedResourceRequest":{
869+
"type":"structure",
870+
"required":[
871+
"application",
872+
"resourceType",
873+
"resource"
874+
],
875+
"members":{
876+
"application":{
877+
"shape":"ApplicationSpecifier",
878+
"documentation":"<p>The name or ID of the application.</p>",
879+
"location":"uri",
880+
"locationName":"application"
881+
},
882+
"resourceType":{
883+
"shape":"ResourceType",
884+
"documentation":"<p>The type of resource associated with the application.</p>",
885+
"location":"uri",
886+
"locationName":"resourceType"
887+
},
888+
"resource":{
889+
"shape":"ResourceSpecifier",
890+
"documentation":"<p>The name or ID of the resource associated with the application.</p>",
891+
"location":"uri",
892+
"locationName":"resource"
893+
}
894+
}
895+
},
896+
"GetAssociatedResourceResponse":{
897+
"type":"structure",
898+
"members":{
899+
"resource":{
900+
"shape":"Resource",
901+
"documentation":"<p>The resource associated with the application.</p>"
843902
}
844903
}
845904
},
@@ -892,6 +951,16 @@
892951
}
893952
}
894953
},
954+
"Integrations":{
955+
"type":"structure",
956+
"members":{
957+
"resourceGroup":{
958+
"shape":"ResourceGroup",
959+
"documentation":"<p> The information about the resource group integration.</p>"
960+
}
961+
},
962+
"documentation":"<p> The information about the service integration.</p>"
963+
},
895964
"InternalServerException":{
896965
"type":"structure",
897966
"members":{
@@ -1070,14 +1139,65 @@
10701139
"type":"string",
10711140
"max":256,
10721141
"min":1,
1073-
"pattern":"\\w+"
1142+
"pattern":"[-.\\w]+"
10741143
},
10751144
"NextToken":{
10761145
"type":"string",
10771146
"max":2024,
10781147
"min":1,
10791148
"pattern":"[A-Za-z0-9+/=]+"
10801149
},
1150+
"Resource":{
1151+
"type":"structure",
1152+
"members":{
1153+
"name":{
1154+
"shape":"ResourceSpecifier",
1155+
"documentation":"<p>The name of the resource.</p>"
1156+
},
1157+
"arn":{
1158+
"shape":"StackArn",
1159+
"documentation":"<p>The Amazon resource name (ARN) of the resource.</p>"
1160+
},
1161+
"associationTime":{
1162+
"shape":"Timestamp",
1163+
"documentation":"<p>The time the resource was associated with the application.</p>"
1164+
},
1165+
"integrations":{
1166+
"shape":"ResourceIntegrations",
1167+
"documentation":"<p>The service integration information about the resource. </p>"
1168+
}
1169+
},
1170+
"documentation":"<p> The information about the resource.</p>"
1171+
},
1172+
"ResourceGroup":{
1173+
"type":"structure",
1174+
"members":{
1175+
"state":{
1176+
"shape":"ResourceGroupState",
1177+
"documentation":"<p>The state of the propagation process for the resource group. The states includes:</p> <p> <code>CREATING </code>if the resource group is in the process of being created.</p> <p> <code>CREATE_COMPLETE</code> if the resource group was created successfully.</p> <p> <code>CREATE_FAILED</code> if the resource group failed to be created.</p> <p> <code>UPDATING</code> if the resource group is in the process of being updated.</p> <p> <code>UPDATE_COMPLETE</code> if the resource group updated successfully.</p> <p> <code>UPDATE_FAILED</code> if the resource group could not update successfully.</p>"
1178+
},
1179+
"arn":{
1180+
"shape":"Arn",
1181+
"documentation":"<p>The Amazon resource name (ARN) of the resource group.</p>"
1182+
},
1183+
"errorMessage":{
1184+
"shape":"String",
1185+
"documentation":"<p>The error message that generates when the propagation process for the resource group fails.</p>"
1186+
}
1187+
},
1188+
"documentation":"<p>The information about the resource group integration.</p>"
1189+
},
1190+
"ResourceGroupState":{
1191+
"type":"string",
1192+
"enum":[
1193+
"CREATING",
1194+
"CREATE_COMPLETE",
1195+
"CREATE_FAILED",
1196+
"UPDATING",
1197+
"UPDATE_COMPLETE",
1198+
"UPDATE_FAILED"
1199+
]
1200+
},
10811201
"ResourceInfo":{
10821202
"type":"structure",
10831203
"members":{
@@ -1090,7 +1210,17 @@
10901210
"documentation":"<p>The Amazon resource name (ARN) that specifies the resource across services.</p>"
10911211
}
10921212
},
1093-
"documentation":"<p>Information about the resource.</p>"
1213+
"documentation":"<p>The information about the resource.</p>"
1214+
},
1215+
"ResourceIntegrations":{
1216+
"type":"structure",
1217+
"members":{
1218+
"resourceGroup":{
1219+
"shape":"ResourceGroup",
1220+
"documentation":"<p>The information about the integration of Resource Groups.</p>"
1221+
}
1222+
},
1223+
"documentation":"<p>The service integration information about the resource.</p>"
10941224
},
10951225
"ResourceNotFoundException":{
10961226
"type":"structure",
@@ -1151,7 +1281,7 @@
11511281
},
11521282
"resource":{
11531283
"shape":"ResourceSpecifier",
1154-
"documentation":"<p>An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket.</p>",
1284+
"documentation":"<p>An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.</p>",
11551285
"location":"uri",
11561286
"locationName":"resource"
11571287
}
@@ -1324,5 +1454,5 @@
13241454
"exception":true
13251455
}
13261456
},
1327-
"documentation":"<p> AWS Service Catalog AppRegistry enables organizations to understand the application context of their AWS resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.</p>"
1457+
"documentation":"<p> Amazon Web Services Service Catalog AppRegistry enables organizations to understand the application context of their Amazon Web Services resources. AppRegistry provides a repository of your applications, their resources, and the application metadata that you use within your enterprise.</p>"
13281458
}

0 commit comments

Comments
 (0)