CloudDirectory / Client / update_typed_link_facet

update_typed_link_facet

CloudDirectory.Client.update_typed_link_facet(**kwargs)

Updates a TypedLinkFacet. For more information, see Typed Links.

See also: AWS API Documentation

Request Syntax

response = client.update_typed_link_facet(
    SchemaArn='string',
    Name='string',
    AttributeUpdates=[
        {
            'Attribute': {
                'Name': 'string',
                'Type': 'STRING'|'BINARY'|'BOOLEAN'|'NUMBER'|'DATETIME'|'VARIANT',
                'DefaultValue': {
                    'StringValue': 'string',
                    'BinaryValue': b'bytes',
                    'BooleanValue': True|False,
                    'NumberValue': 'string',
                    'DatetimeValue': datetime(2015, 1, 1)
                },
                'IsImmutable': True|False,
                'Rules': {
                    'string': {
                        'Type': 'BINARY_LENGTH'|'NUMBER_COMPARISON'|'STRING_FROM_SET'|'STRING_LENGTH',
                        'Parameters': {
                            'string': 'string'
                        }
                    }
                },
                'RequiredBehavior': 'REQUIRED_ALWAYS'|'NOT_REQUIRED'
            },
            'Action': 'CREATE_OR_UPDATE'|'DELETE'
        },
    ],
    IdentityAttributeOrder=[
        'string',
    ]
)

Parameters:

• SchemaArn (string) –

  [REQUIRED]

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

• Name (string) –

  [REQUIRED]

  The unique name of the typed link facet.

• AttributeUpdates (list) –

  [REQUIRED]

  Attributes update structure.

  • (dict) –

    A typed link facet attribute update.

    • Attribute (dict) – [REQUIRED]

      The attribute to update.

      • Name (string) – [REQUIRED]

        The unique name of the typed link attribute.

      • Type (string) – [REQUIRED]

        The type of the attribute.

      • DefaultValue (dict) –

        The default value of the attribute (if configured).

        • StringValue (string) –

          A string data value.

        • BinaryValue (bytes) –

          A binary data value.

        • BooleanValue (boolean) –

          A Boolean data value.

        • NumberValue (string) –

          A number data value.

        • DatetimeValue (datetime) –

          A date and time value.

      • IsImmutable (boolean) –

        Whether the attribute is mutable or not.

      • Rules (dict) –

        Validation rules that are attached to the attribute definition.

        • (string) –

          • (dict) –

            Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

            • Type (string) –

              The type of attribute validation rule.

            • Parameters (dict) –

              The minimum and maximum parameters that are associated with the rule.

              • (string) –

                • (string) –

      • RequiredBehavior (string) – [REQUIRED]

        The required behavior of the TypedLinkAttributeDefinition.

    • Action (string) – [REQUIRED]

      The action to perform when updating the attribute.

• IdentityAttributeOrder (list) –

  [REQUIRED]

  The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

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

• CloudDirectory.Client.exceptions.InvalidFacetUpdateException

• CloudDirectory.Client.exceptions.ResourceNotFoundException

• CloudDirectory.Client.exceptions.FacetNotFoundException

• CloudDirectory.Client.exceptions.InvalidRuleException