Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

AttachTypedLink

Attaches a typed link to a specified source and target object. For more information, see Typed Links.

Request Syntax


PUT /amazonclouddirectory/2017-01-11/typedlink/attach HTTP/1.1
x-amz-data-partition: DirectoryArn
Content-type: application/json

{
   "Attributes": [ 
      { 
         "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) of the directory where you want to attach the typed link.

Required: Yes

Request Body

The request accepts the following data in JSON format.

Attributes

A set of attributes that are associated with the typed link.

Type: Array of AttributeNameAndValue objects

Required: Yes

SourceObjectReference

Identifies the source object that the typed link will attach to.

Type: ObjectReference object

Required: Yes

TargetObjectReference

Identifies the target object that the typed link will attach to.

Type: ObjectReference object

Required: Yes

TypedLinkFacet

Identifies the typed link facet that is associated with the typed link.

Type: TypedLinkSchemaAndFacetName object

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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"
      }
   }
}

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.

TypedLinkSpecifier

Returns a typed link specifier as output.

Type: TypedLinkSpecifier object

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

InvalidAttachmentException

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

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

ValidationException

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

HTTP Status Code: 400

Examples

The following examples are formatted for legibility.

Example Request

This example illustrates one usage of AttachTypedLink.


PUT /amazonclouddirectory/2017-01-11/typedlink/attach HTTP/1.1
Host: clouddirectory.us-west-2.amazonaws.com
Accept-Encoding: identity
Content-Length: 422
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI7E3BYXS3example/20170928/us-west-2/clouddirectory/aws4_request, SignedHeaders=host;x-amz-data-partition;x-amz-date, Signature=d1b63e72fd13cafb5af77d621891a58849c146c2654d046366d420527a659b48
x-amz-data-partition: arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY
X-Amz-Date: 20170928T003543Z
User-Agent: aws-cli/1.11.150 Python/2.7.9 Windows/8 botocore/1.7.8

{
	"SourceObjectReference": {
		"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
	},
	"Attributes": [{
		"AttributeName": "22",
		"Value": {
			"BinaryValue": "c3Ry"
		}
	}],
	"TargetObjectReference": {
		"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
	},
	"TypedLinkFacet": {
		"TypedLinkName": "exampletypedlink8",
		"SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1"
	}
}

Example Response

This example illustrates one usage of AttachTypedLink.


HTTP/1.1 200 OK
x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06
Date: Thu, 28 Sep 2017 00:35:44 GMT
x-amzn-RequestId: f6f0b320-a3e4-11e7-b86b-239c40918c06
Content-Type: application/json
Content-Length: 521

{
	"TypedLinkSpecifier": {
		"IdentityAttributeValues": [{
			"AttributeName": "22",
			"Value": {
				"BinaryValue": "c3Ry",
				"BooleanValue": null,
				"DatetimeValue": null,
				"NumberValue": null,
				"StringValue": null
			}
		}],
		"SourceObjectReference": {
			"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWSvfuEnDqTdmeCuTs6YBNUA"
		},
		"TargetObjectReference": {
			"Selector": "$AQGG_ADlfNZBzYHY_JgDt3TWcU7IARvOTeaR09zme1sVsw"
		},
		"TypedLinkFacet": {
			"SchemaArn": "arn:aws:clouddirectory:us-west-2:45132example:directory/AYb8AOV81kHNgdj8mAO3dNY/schema/org/1",
			"TypedLinkName": "exampletypedlink8"
		}
	}
}