GetTypedLinkFacetInformation - Amazon Cloud Directory


Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.

Request Syntax

POST /amazonclouddirectory/2017-01-11/typedlink/facet/get HTTP/1.1 x-amz-data-partition: SchemaArn Content-type: application/json { "Name": "string" }

URI Request Parameters

The request uses the following URI parameters.


The Amazon Resource Name (ARN) that is associated with the schema. For more information, see Arn Examples.

Required: Yes

Request Body

The request accepts the following data in JSON format.


The unique name of the typed link facet.

Type: String

Pattern: ^[a-zA-Z0-9._-]*$

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "IdentityAttributeOrder": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 230.

Pattern: ^[a-zA-Z0-9._:-]*$


For information about the errors that are common to all actions, see Common Errors.


Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

HTTP Status Code: 403


The specified Facet could not be found.

HTTP Status Code: 400


Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.

HTTP Status Code: 500


Indicates that the provided ARN value is not valid.

HTTP Status Code: 400


Indicates that the NextToken value is not valid.

HTTP Status Code: 400


Indicates that limits are exceeded. See Limits for more information.

HTTP Status Code: 400


The specified resource could not be found.

HTTP Status Code: 404


Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

HTTP Status Code: 409


Indicates that your request is malformed in some manner. See the exception message.

HTTP Status Code: 400


The following examples are formatted for legibility.

Example Request

This example illustrates one usage of GetTypedLinkFacetInformation.

POST /amazonclouddirectory/2017-01-11/typedlink/facet/get HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 29 Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20171006/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=6561b457b066c8458961d43944ad116fc7d3a8b2fdb1a07a08cb4a5273a10b14 x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1 X-Amz-Date: 20171006T005026Z User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8 { "Name": "exampletypedlink8" }

Example Response

This example illustrates one usage of GetTypedLinkFacetInformation.

HTTP/1.1 200 OK x-amzn-RequestId: 57471e31-aa30-11e7-8502-0566a31305cf Date: Fri, 06 Oct 2017 00:50:25 GMT x-amzn-RequestId: 57471e31-aa30-11e7-8502-0566a31305cf Content-Type: application/json Content-Length: 33 { "IdentityAttributeOrder": ["22"] }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: