GetLinkAttributes
Retrieves attributes that are associated with a typed link.
Request Syntax
POST /amazonclouddirectory/2017-01-11/typedlink/attributes/get HTTP/1.1
x-amz-data-partition: DirectoryArn
Content-type: application/json
{
"AttributeNames": [ "string
" ],
"ConsistencyLevel": "string
",
"TypedLinkSpecifier": {
"IdentityAttributeValues": [
{
"AttributeName": "string
",
"Value": {
"BinaryValue": blob
,
"BooleanValue": boolean
,
"DatetimeValue": number
,
"NumberValue": "string
",
"StringValue": "string
"
}
}
],
"SourceObjectReference": {
"Selector": "string
"
},
"TargetObjectReference": {
"Selector": "string
"
},
"TypedLinkFacet": {
"SchemaArn": "string
",
"TypedLinkName": "string
"
}
}
}
URI Request Parameters
The request uses the following URI parameters.
- DirectoryArn
-
The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see Arn Examples or Typed Links.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- AttributeNames
-
A list of attribute names whose values will be retrieved.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 230.
Pattern:
^[a-zA-Z0-9._:-]*$
Required: Yes
- ConsistencyLevel
-
The consistency level at which to retrieve the attributes on a typed link.
Type: String
Valid Values:
SERIALIZABLE | EVENTUAL
Required: No
- TypedLinkSpecifier
-
Allows a typed link specifier to be accepted as input.
Type: TypedLinkSpecifier object
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"Attributes": [
{
"Key": {
"FacetName": "string",
"Name": "string",
"SchemaArn": "string"
},
"Value": {
"BinaryValue": blob,
"BooleanValue": boolean,
"DatetimeValue": number,
"NumberValue": "string",
"StringValue": "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.
- Attributes
-
The attributes that are associated with the typed link.
Type: Array of AttributeKeyAndValue objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
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
- DirectoryNotEnabledException
-
Operations are only permitted on enabled directories.
HTTP Status Code: 400
- FacetValidationException
-
The Facet that you provided was not well formed or could not be validated with the schema.
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
- 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: