update_schema

CloudDirectory.Client.update_schema(**kwargs)

Updates the schema name with a new name. Only development schema names can be updated.

See also: AWS API Documentation

Request Syntax

response = client.update_schema(
    SchemaArn='string',
    Name='string'
)
Parameters
  • SchemaArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) of the development schema. For more information, see arns.

  • Name (string) --

    [REQUIRED]

    The name of the schema.

Return type

dict

Returns

Response Syntax

{
    'SchemaArn': 'string'
}

Response Structure

  • (dict) --

    • SchemaArn (string) --

      The ARN that is associated with the updated schema. 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.ResourceNotFoundException