[ aws . clouddirectory ]
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet . For more information, see Typed Links .
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
list-typed-link-facet-attributes
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: Attributes
list-typed-link-facet-attributes
--schema-arn <value>
--name <value>
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--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.
--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
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--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.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Attributes -> (list)
An ordered set of attributes associate with the typed link.
(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
.
NextToken -> (string)
The pagination token.