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

UpdateFacet

Does the following:

Adds new Attributes, Rules, or ObjectTypes.
Updates existing Attributes, Rules, or ObjectTypes.
Deletes existing Attributes, Rules, or ObjectTypes.

Request Syntax


PUT /amazonclouddirectory/2017-01-11/facet HTTP/1.1
x-amz-data-partition: SchemaArn
Content-type: application/json

{
   "AttributeUpdates": [ 
      { 
         "Action": "string",
         "Attribute": { 
            "AttributeDefinition": { 
               "DefaultValue": { 
                  "BinaryValue": blob,
                  "BooleanValue": boolean,
                  "DatetimeValue": number,
                  "NumberValue": "string",
                  "StringValue": "string"
               },
               "IsImmutable": boolean,
               "Rules": { 
                  "string" : { 
                     "Parameters": { 
                        "string" : "string" 
                     },
                     "Type": "string"
                  }
               },
               "Type": "string"
            },
            "AttributeReference": { 
               "TargetAttributeName": "string",
               "TargetFacetName": "string"
            },
            "Name": "string",
            "RequiredBehavior": "string"
         }
      }
   ],
   "Name": "string",
   "ObjectType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

SchemaArn

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

AttributeUpdates

List of attributes that need to be updated in a given schema Facet. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform.

Type: Array of FacetAttributeUpdate objects

Required: No

Name

The name of the facet.

Type: String

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

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

Required: Yes

ObjectType

The object type that is associated with the facet. See CreateFacet:ObjectType for more details.

Type: String

Valid Values: NODE | LEAF_NODE | POLICY | INDEX

Required: No

Response Syntax


HTTP/1.1 200

Response Elements

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

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

FacetNotFoundException

The specified Facet could not be found.

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

InvalidFacetUpdateException

An attempt to modify a Facet resulted in an invalid schema exception.

HTTP Status Code: 400

InvalidRuleException

Occurs when any of the rule parameter keys or values are invalid.

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