Skip to content

update_retrieval_instruction

Operation

update_retrieval_instruction

update_retrieval_instruction(request: UpdateRetrievalInstructionInput | UpdateRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrievalInstructionInputDict]) -> UpdateRetrievalInstructionOutput

Updates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the served content does not change while the update is in flight. The service rejects the request with ConflictException while lastTransitionStatus is CREATING or UPDATING.

Parameters:

Name Type Description Default
request UpdateRetrievalInstructionInput | UpdateRetrievalInstructionInputDict | 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[UpdateRetrievalInstructionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRetrievalInstructionOutput

An instance of UpdateRetrievalInstructionOutput.

update_retrieval_instruction async

update_retrieval_instruction(request: UpdateRetrievalInstructionInput | UpdateRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateRetrievalInstructionInputDict]) -> UpdateRetrievalInstructionOutput

Updates the content of a retrieval instruction. The update is processed asynchronously; the stored content is a candidate until content review passes, and the served content does not change while the update is in flight. The service rejects the request with ConflictException while lastTransitionStatus is CREATING or UPDATING.

Parameters:

Name Type Description Default
request UpdateRetrievalInstructionInput | UpdateRetrievalInstructionInputDict | 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[UpdateRetrievalInstructionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
UpdateRetrievalInstructionOutput

An instance of UpdateRetrievalInstructionOutput.

Input

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

UpdateRetrievalInstructionInputDict

Bases: TypedDict

Dictionary form of UpdateRetrievalInstructionInput.

Attributes

description instance-attribute
description: str | None

A replacement description; applied together with the content when the review passes. Omit to clear.

instruction instance-attribute

The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

retrieval_instruction_id instance-attribute
retrieval_instruction_id: Required[str]

The identifier of the retrieval instruction to update.

UpdateRetrievalInstructionInput dataclass

Bases: _SerdeShape

Dataclass for UpdateRetrievalInstructionInput structure.

Attributes

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

A replacement description; applied together with the content when the review passes. Omit to clear.

instruction class-attribute instance-attribute
instruction: RetrievalInstructionContent | None = ...

The replacement instruction content. This is a full replacement of all four fields, not a patch. During UPDATING, Get continues to return the previously-served content until the update review passes.

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

The identifier of the retrieval instruction to update.

Output

UpdateRetrievalInstructionOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateRetrievalInstructionOutput structure.

Attributes

created_at instance-attribute
created_at: datetime

When you created the retrieval instruction.

last_transition_status instance-attribute
last_transition_status: str

Always UPDATING on this response. Poll GetRetrievalInstruction until this member is neither CREATING nor UPDATING, then read the outcome from it.

name instance-attribute
name: str

The name of the retrieval instruction.

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.

retrieval_instruction_id instance-attribute
retrieval_instruction_id: str

The identifier of the retrieval instruction.

status instance-attribute
status: str

Whether the instruction can be used. An update never lowers status. Unchanged from the previous value on this response.

updated_at instance-attribute
updated_at: datetime

When the retrieval instruction was last updated.