Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . clouddirectory ]

update-facet

Description

Does the following:

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-facet
--schema-arn <value>
--name <value>
[--attribute-updates <value>]
[--object-type <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--schema-arn (string)

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

--name (string)

The name of the facet.

--attribute-updates (list)

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.

(structure)

A structure that contains information used to update an attribute.

Attribute -> (structure)

The attribute to update.

Name -> (string)

The name of the facet attribute.

AttributeDefinition -> (structure)

A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.

Type -> (string)

The type of the attribute.

DefaultValue -> (structure)

The default value of the attribute (if configured).

StringValue -> (string)

A string data value.

BinaryValue -> (blob)

A binary data value.

BooleanValue -> (boolean)

A Boolean data value.

NumberValue -> (string)

A number data value.

DatetimeValue -> (timestamp)

A date and time value.

IsImmutable -> (boolean)

Whether the attribute is mutable or not.

Rules -> (map)

Validation rules attached to the attribute definition.

key -> (string)

value -> (structure)

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

Type -> (string)

The type of attribute validation rule.

Parameters -> (map)

The minimum and maximum parameters that are associated with the rule.

key -> (string)

value -> (string)

AttributeReference -> (structure)

An attribute reference that is associated with the attribute. See Attribute References for more information.

TargetFacetName -> (string)

The target facet name that is associated with the facet reference. See Attribute References for more information.

TargetAttributeName -> (string)

The target attribute name that is associated with the facet reference. See Attribute References for more information.

RequiredBehavior -> (string)

The required behavior of the FacetAttribute .

Action -> (string)

The action to perform when updating the attribute.

JSON Syntax:

[
  {
    "Attribute": {
      "Name": "string",
      "AttributeDefinition": {
        "Type": "STRING"|"BINARY"|"BOOLEAN"|"NUMBER"|"DATETIME"|"VARIANT",
        "DefaultValue": {
          "StringValue": "string",
          "BinaryValue": blob,
          "BooleanValue": true|false,
          "NumberValue": "string",
          "DatetimeValue": timestamp
        },
        "IsImmutable": true|false,
        "Rules": {"string": {
              "Type": "BINARY_LENGTH"|"NUMBER_COMPARISON"|"STRING_FROM_SET"|"STRING_LENGTH",
              "Parameters": {"string": "string"
                ...}
            }
          ...}
      },
      "AttributeReference": {
        "TargetFacetName": "string",
        "TargetAttributeName": "string"
      },
      "RequiredBehavior": "REQUIRED_ALWAYS"|"NOT_REQUIRED"
    },
    "Action": "CREATE_OR_UPDATE"|"DELETE"
  }
  ...
]

--object-type (string)

The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

Possible values:

  • NODE
  • LEAF_NODE
  • POLICY
  • INDEX

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

None