AWS CLI Command Reference

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 ]

create-facet

Description

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

See also: AWS API Documentation

Synopsis

  create-facet
--schema-arn <value>
--name <value>
[--attributes <value>]
[--object-type <value>]
[--facet-style <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--schema-arn (string)

The schema ARN in which the new Facet will be created. For more information, see arns .

--name (string)

The name of the Facet , which is unique for a given schema.

--attributes (list)

The attributes that are associated with the Facet .

(structure)

An attribute that is associated with the Facet .

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 .

Shorthand Syntax:

Name=string,AttributeDefinition={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}}}},AttributeReference={TargetFacetName=string,TargetAttributeName=string},RequiredBehavior=string ...

JSON Syntax:

[
  {
    "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"
  }
  ...
]

--object-type (string)

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.
  • Leaf node: Cannot have children but can have multiple parents.
  • Policy: Allows you to store a policy document and policy type. For more information, see Policies .
  • Index: Can be created with the Index API.

Possible values:

  • NODE
  • LEAF_NODE
  • POLICY
  • INDEX

--facet-style (string)

There are two different styles that you can define on any given facet, Static and Dynamic . For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

Possible values:

  • STATIC
  • DYNAMIC

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

None