Skip to content

create_retrieval_instruction_version

Operation

create_retrieval_instruction_version

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.

Parameters:

Name Type Description Default
request CreateRetrievalInstructionVersionInput | CreateRetrievalInstructionVersionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateRetrievalInstructionVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateRetrievalInstructionVersionOutput

An instance of CreateRetrievalInstructionVersionOutput.

create_retrieval_instruction_version async

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.

Parameters:

Name Type Description Default
request CreateRetrievalInstructionVersionInput | CreateRetrievalInstructionVersionInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[CreateRetrievalInstructionVersionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateRetrievalInstructionVersionOutput

An instance of CreateRetrievalInstructionVersionOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CreateRetrievalInstructionVersionInputDict

Bases: TypedDict

Dictionary form of CreateRetrievalInstructionVersionInput.

Attributes

client_token instance-attribute
client_token: str | None

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.

description instance-attribute
description: str | None

A description of this version. Independent of the retrieval instruction's own description.

retrieval_instruction_id instance-attribute
retrieval_instruction_id: Required[str]

The identifier of the retrieval instruction to version.

CreateRetrievalInstructionVersionInput dataclass

Bases: _SerdeShape

Dataclass for CreateRetrievalInstructionVersionInput structure.

Attributes

client_token class-attribute instance-attribute
client_token: str | None = ...

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.

description class-attribute instance-attribute
description: str | None = ...

A description of this version. Independent of the retrieval instruction's own description.

retrieval_instruction_id class-attribute instance-attribute
retrieval_instruction_id: str | None = ...

The identifier of the retrieval instruction to version.

Output

CreateRetrievalInstructionVersionOutput dataclass

Bases: _SerdeShape

Dataclass for CreateRetrievalInstructionVersionOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

When this version was created.

description class-attribute instance-attribute
description: str | None = ...

The description of this version, when one was supplied.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

retrieval_instruction_arn instance-attribute
retrieval_instruction_arn: str

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

retrieval_instruction_id instance-attribute
retrieval_instruction_id: str

The identifier of the retrieval instruction.

version instance-attribute
version: str

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.