list_facet_names

CloudDirectory.Client.list_facet_names(**kwargs)

Retrieves the names of facets that exist in a schema.

See also: AWS API Documentation

Request Syntax

response = client.list_facet_names(
    SchemaArn='string',
    NextToken='string',
    MaxResults=123
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) to retrieve facet names from.

  • NextToken (string) -- The pagination token.
  • MaxResults (integer) -- The maximum number of results to retrieve.
Return type

dict

Returns

Response Syntax

{
    'FacetNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • FacetNames (list) --

      The names of facets that exist within the schema.

      • (string) --
    • NextToken (string) --

      The pagination token.

Exceptions

  • CloudDirectory.Client.exceptions.InternalServiceException
  • CloudDirectory.Client.exceptions.InvalidArnException
  • CloudDirectory.Client.exceptions.RetryableConflictException
  • CloudDirectory.Client.exceptions.ValidationException
  • CloudDirectory.Client.exceptions.LimitExceededException
  • CloudDirectory.Client.exceptions.AccessDeniedException
  • CloudDirectory.Client.exceptions.ResourceNotFoundException
  • CloudDirectory.Client.exceptions.InvalidNextTokenException