Bedrock / Client / create_guardrail_version

create_guardrail_version#

Bedrock.Client.create_guardrail_version(**kwargs)#

Creates a version of the guardrail. Use this API to create a snapshot of the guardrail when you are satisfied with a configuration, or to compare the configuration with another version.

See also: AWS API Documentation

Request Syntax

response = client.create_guardrail_version(
    guardrailIdentifier='string',
    description='string',
    clientRequestToken='string'
)
Parameters:

  • guardrailIdentifier (string) –

    [REQUIRED]

    The unique identifier of the guardrail. This can be an ID or the ARN.

  • description (string) – A description of the guardrail version.

  • clientRequestToken (string) –

    A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'guardrailId': 'string',
    'version': 'string'
}

Response Structure

  • (dict) –

    • guardrailId (string) –

      The unique identifier of the guardrail.

    • version (string) –

      The number of the version of the guardrail.

Exceptions

  • Bedrock.Client.exceptions.ResourceNotFoundException

  • Bedrock.Client.exceptions.AccessDeniedException

  • Bedrock.Client.exceptions.ValidationException

  • Bedrock.Client.exceptions.ConflictException

  • Bedrock.Client.exceptions.InternalServerException

  • Bedrock.Client.exceptions.ServiceQuotaExceededException

  • Bedrock.Client.exceptions.ThrottlingException