Menu
Amazon Cloud Directory
API Reference

GetTypedLinkFacetInformation

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

Request Syntax

Copy
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 requires the following URI parameters.

SchemaArn

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

Request Body

The request accepts the following data in JSON format.

Name

The unique name of the typed link facet.

Type: String

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

Required: Yes

Response Syntax

Copy
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.

IdentityAttributeOrder

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 link.

Type: Array of strings

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

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

Errors

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

AccessDeniedException

Access denied. Check your permissions.

HTTP Status Code: 403

FacetNotFoundException

The specified Facet could not be found.

HTTP Status Code: 400

InternalServiceException

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

InvalidArnException

Indicates that the provided ARN value is not valid.

HTTP Status Code: 400

InvalidNextTokenException

Indicates that the NextToken value is not valid.

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource could not be found.

HTTP Status Code: 404

RetryableConflictException

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

ValidationException

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

HTTP Status Code: 400

See Also

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