CloudDirectory / Client / apply_schema

apply_schema

CloudDirectory.Client.apply_schema(**kwargs)

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

See also: AWS API Documentation

Request Syntax

response = client.apply_schema(
    PublishedSchemaArn='string',
    DirectoryArn='string'
)

Parameters:

• PublishedSchemaArn (string) –

  [REQUIRED]

  Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see arns.

• DirectoryArn (string) –

  [REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'AppliedSchemaArn': 'string',
    'DirectoryArn': 'string'
}

Response Structure

• (dict) –

  • AppliedSchemaArn (string) –

    The applied schema ARN that is associated with the copied schema in the Directory. You can use this ARN to describe the schema information applied on this directory. For more information, see arns.

  • DirectoryArn (string) –

    The ARN that is associated with the Directory. For more information, see arns.

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

• CloudDirectory.Client.exceptions.ResourceNotFoundException

• CloudDirectory.Client.exceptions.InvalidAttachmentException