Skip to content

Commit f72bb43

Browse files
author
AWS
committed
Amazon CloudDirectory Update: Documentation updates for clouddirectory
1 parent a375083 commit f72bb43

File tree

2 files changed

+38
-12
lines changed

2 files changed

+38
-12
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": "Amazon CloudDirectory",
4+
"contributor": "",
5+
"description": "Documentation updates for clouddirectory"
6+
}

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

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1462,7 +1462,7 @@
14621462
"members":{
14631463
"Message":{"shape":"ExceptionMessage"}
14641464
},
1465-
"documentation":"<p>Access denied. Check your permissions.</p>",
1465+
"documentation":"<p>Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling <a>ListDirectories</a> and check your permissions.</p>",
14661466
"error":{"httpStatusCode":403},
14671467
"exception":true
14681468
},
@@ -2415,16 +2415,30 @@
24152415
"required":["ObjectReference"],
24162416
"members":{
24172417
"ObjectReference":{"shape":"ObjectReference"},
2418-
"NextToken":{"shape":"NextToken"},
2419-
"MaxResults":{"shape":"NumberResults"}
2420-
}
2418+
"NextToken":{
2419+
"shape":"NextToken",
2420+
"documentation":"<p>The pagination token.</p>"
2421+
},
2422+
"MaxResults":{
2423+
"shape":"NumberResults",
2424+
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
2425+
}
2426+
},
2427+
"documentation":"<p>Lists parent objects that are associated with a given object in pagination fashion.</p>"
24212428
},
24222429
"BatchListObjectParentsResponse":{
24232430
"type":"structure",
24242431
"members":{
2425-
"ParentLinks":{"shape":"ObjectIdentifierAndLinkNameList"},
2426-
"NextToken":{"shape":"NextToken"}
2427-
}
2432+
"ParentLinks":{
2433+
"shape":"ObjectIdentifierAndLinkNameList",
2434+
"documentation":"<p>Returns a list of parent reference and LinkName Tuples.</p>"
2435+
},
2436+
"NextToken":{
2437+
"shape":"NextToken",
2438+
"documentation":"<p>The pagination token.</p>"
2439+
}
2440+
},
2441+
"documentation":"<p>Represents the output of a <a>ListObjectParents</a> response operation.</p>"
24282442
},
24292443
"BatchListObjectPolicies":{
24302444
"type":"structure",
@@ -2626,7 +2640,10 @@
26262640
"shape":"BatchGetObjectAttributes",
26272641
"documentation":"<p>Retrieves attributes within a facet that are associated with an object.</p>"
26282642
},
2629-
"ListObjectParents":{"shape":"BatchListObjectParents"},
2643+
"ListObjectParents":{
2644+
"shape":"BatchListObjectParents",
2645+
"documentation":"<p>Lists parent objects that are associated with a given object in pagination fashion.</p>"
2646+
},
26302647
"ListObjectPolicies":{
26312648
"shape":"BatchListObjectPolicies",
26322649
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
@@ -2769,7 +2786,10 @@
27692786
"shape":"BatchGetLinkAttributesResponse",
27702787
"documentation":"<p>The list of attributes to retrieve from the typed link.</p>"
27712788
},
2772-
"ListObjectParents":{"shape":"BatchListObjectParentsResponse"}
2789+
"ListObjectParents":{
2790+
"shape":"BatchListObjectParentsResponse",
2791+
"documentation":"<p>The list of parent objects to retrieve.</p>"
2792+
}
27732793
},
27742794
"documentation":"<p>Represents the output of a <code>BatchRead</code> success response operation.</p>"
27752795
},
@@ -5192,7 +5212,7 @@
51925212
"members":{
51935213
"Selector":{
51945214
"shape":"SelectorObjectReference",
5195-
"documentation":"<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html\">Access Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
5215+
"documentation":"<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html\">Access Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes. </p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
51965216
}
51975217
},
51985218
"documentation":"<p>The reference that identifies an object.</p>"
@@ -5458,11 +5478,11 @@
54585478
"members":{
54595479
"SchemaArn":{
54605480
"shape":"Arn",
5461-
"documentation":"<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions.</p>"
5481+
"documentation":"<p>The ARN of the schema that contains the facet with no minor component. See <a>arns</a> and <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html\">In-Place Schema Upgrade</a> for a description of when to provide minor versions. If this value is set, FacetName must also be set.</p>"
54625482
},
54635483
"FacetName":{
54645484
"shape":"FacetName",
5465-
"documentation":"<p>The name of the facet.</p>"
5485+
"documentation":"<p>The name of the facet. If this value is set, SchemaArn must also be set.</p>"
54665486
}
54675487
},
54685488
"documentation":"<p>A facet.</p>"

0 commit comments

Comments
 (0)