[ aws . clouddirectory ]
Creates a TypedLinkFacet . For more information, see Typed Links .
See also: AWS API Documentation
create-typed-link-facet
--schema-arn <value>
--facet <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--schema-arn
(string)
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns .
--facet
(structure)
Facet structure that is associated with the typed link facet.
Name -> (string)
The unique name of the typed link facet.
Attributes -> (list)
A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.
(structure)
A typed link attribute definition.
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
.IdentityAttributeOrder -> (list)
The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.
(string)
JSON Syntax:
{
"Name": "string",
"Attributes": [
{
"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"
}
...
],
"IdentityAttributeOrder": ["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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--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
yaml
yaml-stream
--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.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
None