Skip to content

delete_retrieval_instruction

Operation

delete_retrieval_instruction

delete_retrieval_instruction(request: DeleteRetrievalInstructionInput | DeleteRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRetrievalInstructionInputDict]) -> DeleteRetrievalInstructionOutput

Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.

Parameters:

Name Type Description Default
request DeleteRetrievalInstructionInput | DeleteRetrievalInstructionInputDict | 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[DeleteRetrievalInstructionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRetrievalInstructionOutput

An instance of DeleteRetrievalInstructionOutput.

delete_retrieval_instruction async

delete_retrieval_instruction(request: DeleteRetrievalInstructionInput | DeleteRetrievalInstructionInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteRetrievalInstructionInputDict]) -> DeleteRetrievalInstructionOutput

Deletes a retrieval instruction or a single version of it. Omit retrievalInstructionVersion to delete the retrieval instruction itself; the service rejects that request with ConflictException while the retrieval instruction has versions or while lastTransitionStatus is CREATING or UPDATING. Specify retrievalInstructionVersion to delete only that version; the retrieval instruction and its other versions are unaffected.

Parameters:

Name Type Description Default
request DeleteRetrievalInstructionInput | DeleteRetrievalInstructionInputDict | 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[DeleteRetrievalInstructionInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteRetrievalInstructionOutput

An instance of DeleteRetrievalInstructionOutput.

Input

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

DeleteRetrievalInstructionInputDict

Bases: TypedDict

Dictionary form of DeleteRetrievalInstructionInput.

Attributes

retrieval_instruction_id instance-attribute
retrieval_instruction_id: Required[str]

The identifier of the retrieval instruction to delete.

retrieval_instruction_version instance-attribute
retrieval_instruction_version: str | None

The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.

DeleteRetrievalInstructionInput dataclass

Bases: _SerdeShape

Dataclass for DeleteRetrievalInstructionInput structure.

Attributes

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

The identifier of the retrieval instruction to delete.

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

The version to delete. Omit this field to delete the retrieval instruction itself, which you can do only when it has no versions; while any version exists the service rejects the request with ConflictException. You cannot delete DRAFT on its own; deleting the retrieval instruction removes it.

Output

DeleteRetrievalInstructionOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteRetrievalInstructionOutput structure.

Attributes

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 deleted retrieval instruction.

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

The version that you deleted. Absent when you deleted the whole retrieval instruction.