openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 363 kB

JSON

{"openapi":"3.0.0","info":{"version":"2017-01-11","x-release":"v4","title":"Amazon CloudDirectory","description":"<fullname>Amazon Cloud Directory</fullname> Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html\">Amazon Cloud Directory Developer Guide</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"clouddirectory","x-aws-signingName":"clouddirectory","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/clouddirectory-2017-01-11.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/clouddirectory/"},"servers":[{"url":"http://clouddirectory.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CloudDirectory multi-region endpoint"},{"url":"https://clouddirectory.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Amazon CloudDirectory multi-region endpoint"},{"url":"http://clouddirectory.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CloudDirectory endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://clouddirectory.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Amazon CloudDirectory endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/amazonclouddirectory/2017-01-11/object/facets#x-amz-data-partition":{"put":{"operationId":"AddFacetToObject","description":"Adds a new <a>Facet</a> to an object. An object can have more than one facet applied on it.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFacetToObjectResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"FacetValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetValidationException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SchemaFacet","ObjectReference"],"properties":{"SchemaFacet":{"description":"A facet.","type":"object","properties":{"SchemaArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"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."}]},"FacetName":{"allOf":[{"$ref":"#/components/schemas/FacetName"},{"description":"The name of the facet. If this value is set, SchemaArn must also be set."}]}}},"ObjectAttributeList":{"description":"Attributes on the facet that you are adding to the object.","type":"array","items":{"$ref":"#/components/schemas/AttributeKeyAndValue"}},"ObjectReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/schema/apply#x-amz-data-partition":{"put":{"operationId":"ApplySchema","description":"Copies the input published schema, at the specified version, into the <a>Directory</a> with the same name and version as that of the published schema.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplySchemaResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"SchemaAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchemaAlreadyExistsException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"InvalidAttachmentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAttachmentException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PublishedSchemaArn"],"properties":{"PublishedSchemaArn":{"description":"Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see <a>arns</a>.","type":"string"}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/object/attach#x-amz-data-partition":{"put":{"operationId":"AttachObject","description":"Attaches an existing object to another object. An object can be accessed in two ways: <ol> <li> Using the path </li> <li> Using <code>ObjectIdentifier</code> </li> </ol>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachObjectResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"LinkNameAlreadyInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkNameAlreadyInUseException"}}}},"489":{"description":"InvalidAttachmentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAttachmentException"}}}},"490":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"491":{"description":"FacetValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetValidationException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ParentReference","ChildReference","LinkName"],"properties":{"ParentReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"ChildReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"LinkName":{"description":"The link name with which the child object is attached to the parent.","type":"string","pattern":"[^\\/\\[\\]\$\$:\\{\\}#@!?\\s\\\\;]+","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/policy/attach#x-amz-data-partition":{"put":{"operationId":"AttachPolicy","description":"Attaches a policy object to a regular object. An object can have a limited number of attached policies.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachPolicyResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"NotPolicyException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotPolicyException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["PolicyReference","ObjectReference"],"properties":{"PolicyReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"ObjectReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/index/attach#x-amz-data-partition":{"put":{"operationId":"AttachToIndex","description":"Attaches the specified object to the specified index.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachToIndexResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"InvalidAttachmentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAttachmentException"}}}},"488":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"489":{"description":"LinkNameAlreadyInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkNameAlreadyInUseException"}}}},"490":{"description":"IndexedAttributeMissingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IndexedAttributeMissingException"}}}},"491":{"description":"NotIndexException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotIndexException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) of the directory where the object and index exist.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["IndexReference","TargetReference"],"properties":{"IndexReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"TargetReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/typedlink/attach#x-amz-data-partition":{"put":{"operationId":"AttachTypedLink","description":"Attaches a typed link to a specified source and target object. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink\">Typed Links</a>.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachTypedLinkResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"InvalidAttachmentException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidAttachmentException"}}}},"489":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"490":{"description":"FacetValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetValidationException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SourceObjectReference","TargetObjectReference","TypedLinkFacet","Attributes"],"properties":{"SourceObjectReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"TargetObjectReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"TypedLinkFacet":{"description":"Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.","type":"object","properties":{"SchemaArn":{"allOf":[{"$ref":"#/components/schemas/Arn"},{"description":"The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>."}]},"TypedLinkName":{"allOf":[{"$ref":"#/components/schemas/TypedLinkName"},{"description":"The unique name of the typed link facet."}]}}},"Attributes":{"description":"A set of attributes that are associated with the typed link.","type":"array","items":{"$ref":"#/components/schemas/AttributeNameAndValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/batchread#x-amz-data-partition":{"post":{"operationId":"BatchRead","description":"Performs all the read operations in a batch. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.","schema":{"type":"string"}},{"name":"x-amz-consistency-level","in":"header","required":false,"description":"Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.","schema":{"type":"string","enum":["SERIALIZABLE","EVENTUAL"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Operations"],"properties":{"Operations":{"description":"A list of operations that are part of the batch.","type":"array","items":{"$ref":"#/components/schemas/BatchReadOperation"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/batchwrite#x-amz-data-partition":{"put":{"operationId":"BatchWrite","description":"Performs all the write operations in a batch. Either all the operations succeed or none.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchWriteResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"BatchWriteException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchWriteException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Operations"],"properties":{"Operations":{"description":"A list of operations that are part of the batch.","type":"array","items":{"$ref":"#/components/schemas/BatchWriteOperation"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/directory/create#x-amz-data-partition":{"put":{"operationId":"CreateDirectory","description":"Creates a <a>Directory</a> by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a directory using a managed schema, called the <code>QuickStartSchema</code>. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html\">Managed Schema</a> in the Amazon Cloud Directory Developer Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDirectoryResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryAlreadyExistsException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"description":"The name of the <a>Directory</a>. Should be unique per account, per region.","type":"string","pattern":"^[a-zA-Z0-9._-]*$","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/facet/create#x-amz-data-partition":{"put":{"operationId":"CreateFacet","description":"Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFacetResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"487":{"description":"FacetAlreadyExistsException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetAlreadyExistsException"}}}},"488":{"description":"InvalidRuleException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidRuleException"}}}},"489":{"description":"FacetValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetValidationException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["Name"],"properties":{"Name":{"description":"The name of the <a>Facet</a>, which is unique for a given schema.","type":"string","pattern":"^[a-zA-Z0-9._-]*$","minLength":1,"maxLength":64},"Attributes":{"description":"The attributes that are associated with the <a>Facet</a>.","type":"array","items":{"$ref":"#/components/schemas/FacetAttribute"}},"ObjectType":{"description":"Specifies whether a given object created from this facet is of type node, leaf node, policy or index. <ul> <li> Node: Can have multiple children but one parent. </li> </ul> <ul> <li> Leaf node: Cannot have children but can have multiple parents. </li> </ul> <ul> <li> Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies\">Policies</a>. </li> </ul> <ul> <li> Index: Can be created with the Index API. </li> </ul>","type":"string","enum":["NODE","LEAF_NODE","POLICY","INDEX"]},"FacetStyle":{"description":"There are two different styles that you can define on any given facet, <code>Static</code> and <code>Dynamic</code>. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.","type":"string","enum":["STATIC","DYNAMIC"]}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/index#x-amz-data-partition":{"put":{"operationId":"CreateIndex","description":"Creates an index object. See <a href=\"https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html\">Indexing and search</a> for more information.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIndexResponse"}}}},"480":{"description":"InternalServiceException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServiceException"}}}},"481":{"description":"InvalidArnException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidArnException"}}}},"482":{"description":"RetryableConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryableConflictException"}}}},"483":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"484":{"description":"LimitExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LimitExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"DirectoryNotEnabledException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DirectoryNotEnabledException"}}}},"487":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"488":{"description":"FacetValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FacetValidationException"}}}},"489":{"description":"LinkNameAlreadyInUseException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkNameAlreadyInUseException"}}}},"490":{"description":"UnsupportedIndexTypeException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsupportedIndexTypeException"}}}}},"parameters":[{"name":"x-amz-data-partition","in":"header","required":true,"description":"The ARN of the directory where the index should be created.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["OrderedIndexedAttributeList","IsUnique"],"properties":{"OrderedIndexedAttributeList":{"description":"Specifies the attributes that should be indexed on. Currently only a single attribute is supported.","type":"array","items":{"$ref":"#/components/schemas/AttributeKey"}},"IsUnique":{"description":"Indicates whether the attribute that is being indexed has unique values or not.","type":"boolean"},"ParentReference":{"description":"The reference that identifies an object.","type":"object","properties":{"Selector":{"allOf":[{"$ref":"#/components/schemas/SelectorObjectReference"},{"description":"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: <ul> <li> $ObjectIdentifier - 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. </li> <li> /some/path - Identifies the object based on path </li> <li> #SomeBatchReference - Identifies the object in a batch call </li> </ul>"}]}}},"LinkName":{"description":"The name of the link between the parent object and the index object.","type":"string","pattern":"[^\\/\\[\\]\$\$:\\{\\}#@!?\\s\\\\;]+","minLength":1,"maxLength":64}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/amazonclouddirectory/2017-01-11/object#x-amz-data-partition":{"put":{"operationId":"CreateObject","description":"Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. ","responses":{"200":{"description":"Success","content":{"application/json"