List Facet Attributes

clouddirectory_list_facet_attributes

R Documentation

Description¶

Retrieves attributes attached to the facet.

Usage¶

clouddirectory_list_facet_attributes(SchemaArn, Name, NextToken,
  MaxResults)

Arguments¶

SchemaArn

[required] The ARN of the schema where the facet resides.

Name

[required] The name of the facet whose attributes will be retrieved.

NextToken

The pagination token.

MaxResults

The maximum number of results to retrieve.

Value¶

A list with the following syntax:

list(
  Attributes = list(
    list(
      Name = "string",
      AttributeDefinition = list(
        Type = "STRING"|"BINARY"|"BOOLEAN"|"NUMBER"|"DATETIME"|"VARIANT",
        DefaultValue = list(
          StringValue = "string",
          BinaryValue = raw,
          BooleanValue = TRUE|FALSE,
          NumberValue = "string",
          DatetimeValue = as.POSIXct(
            "2015-01-01"
          )
        ),
        IsImmutable = TRUE|FALSE,
        Rules = list(
          list(
            Type = "BINARY_LENGTH"|"NUMBER_COMPARISON"|"STRING_FROM_SET"|"STRING_LENGTH",
            Parameters = list(
              "string"
            )
          )
        )
      ),
      AttributeReference = list(
        TargetFacetName = "string",
        TargetAttributeName = "string"
      ),
      RequiredBehavior = "REQUIRED_ALWAYS"|"NOT_REQUIRED"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_facet_attributes(
  SchemaArn = "string",
  Name = "string",
  NextToken = "string",
  MaxResults = 123
)