[ aws . clouddirectory ]

update-typed-link-facet

Description

Updates a TypedLinkFacet . For more information, see Typed Links .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-typed-link-facet
--schema-arn <value>
--name <value>
--attribute-updates <value>
--identity-attribute-order <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--schema-arn (string)

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

--name (string)

The unique name of the typed link facet.

--attribute-updates (list)

Attributes update structure.

(structure)

A typed link facet attribute update.

Attribute -> (structure)

The attribute to update.

Name -> (string)

The unique name of the typed link attribute.

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 that are 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)

RequiredBehavior -> (string)

The required behavior of the TypedLinkAttributeDefinition .

Action -> (string)

The action to perform when updating the attribute.

Shorthand Syntax:

Attribute={Name=string,Type=string,DefaultValue={StringValue=string,BinaryValue=blob,BooleanValue=boolean,NumberValue=string,DatetimeValue=timestamp},IsImmutable=boolean,Rules={KeyName1={Type=string,Parameters={KeyName1=string,KeyName2=string}},KeyName2={Type=string,Parameters={KeyName1=string,KeyName2=string}}},RequiredBehavior=string},Action=string ...

JSON Syntax:

[
  {
    "Attribute": {
      "Name": "string",
      "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"
              ...}
          }
        ...},
      "RequiredBehavior": "REQUIRED_ALWAYS"|"NOT_REQUIRED"
    },
    "Action": "CREATE_OR_UPDATE"|"DELETE"
  }
  ...
]

--identity-attribute-order (list)

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 a 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 Links .

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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