AgentsforBedrock / Client / create_retrieval_instruction_version

create_retrieval_instruction_version

AgentsforBedrock.Client.create_retrieval_instruction_version(**kwargs)

Creates an immutable numbered version from the retrieval instruction’s current reviewed content. The service creates the version synchronously.

The service numbers versions from 1 and assigns them in order, never reusing a number.

See also: AWS API Documentation

Request Syntax

response = client.create_retrieval_instruction_version(
    retrievalInstructionId='string',
    description='string',
    clientToken='string'
)
Parameters:

  • retrievalInstructionId (string) –

    [REQUIRED]

    The identifier of the retrieval instruction to version.

  • description (string) – A description of this version. Independent of the retrieval instruction’s own description.

  • clientToken (string) –

    A caller-supplied token that makes a retried call return the version created by the first call rather than a second version. The window is 8 hours.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'retrievalInstructionId': 'string',
    'retrievalInstructionArn': 'string',
    'version': 'string',
    'createdAt': datetime(2015, 1, 1),
    'description': 'string'
}

Response Structure

  • (dict) –

    • retrievalInstructionId (string) –

      The identifier of the retrieval instruction.

    • retrievalInstructionArn (string) –

      The ARN of the retrieval instruction. Versions do not have their own ARN.

    • version (string) –

      The number of the version created. Versions are numbered from 1 and allocated monotonically; a number is never reused, even after the version is deleted.

    • createdAt (datetime) –

      When this version was created.

    • description (string) –

      The description of this version, when one was supplied.

Exceptions