CloudDirectory / Client / get_facet

get_facet

CloudDirectory.Client.get_facet(**kwargs)

Gets details of the Facet, such as facet name, attributes, Rule s, or ObjectType . You can call this on all kinds of schema facets – published, development, or applied.

See also: AWS API Documentation

Request Syntax

response = client.get_facet(
    SchemaArn='string',
    Name='string'
)

Parameters:

• SchemaArn (string) –

  [REQUIRED]

  The Amazon Resource Name (ARN) that is associated with the Facet. For more information, see arns.

• Name (string) –

  [REQUIRED]

  The name of the facet to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Facet': {
        'Name': 'string',
        'ObjectType': 'NODE'|'LEAF_NODE'|'POLICY'|'INDEX',
        'FacetStyle': 'STATIC'|'DYNAMIC'
    }
}

Response Structure

• (dict) –

  • Facet (dict) –

    The Facet structure that is associated with the facet.

    • Name (string) –

      The name of the Facet.

    • ObjectType (string) –

      The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.

    • FacetStyle (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.

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