list_retrieval_instruction_versions¶
Operation¶
list_retrieval_instruction_versions
¶
list_retrieval_instruction_versions(request: ListRetrievalInstructionVersionsInput | ListRetrievalInstructionVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrievalInstructionVersionsInputDict]) -> ListRetrievalInstructionVersionsOutput
Lists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without retrievalInstructionVersion. Results are paginated. Use the nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListRetrievalInstructionVersionsInput | ListRetrievalInstructionVersionsInputDict | 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[ListRetrievalInstructionVersionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListRetrievalInstructionVersionsOutput
|
An instance of |
list_retrieval_instruction_versions
async
¶
list_retrieval_instruction_versions(request: ListRetrievalInstructionVersionsInput | ListRetrievalInstructionVersionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrievalInstructionVersionsInputDict]) -> ListRetrievalInstructionVersionsOutput
Lists the numbered versions of a retrieval instruction, newest first. DRAFT is not listed; read it with GetRetrievalInstruction without retrievalInstructionVersion. Results are paginated. Use the nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListRetrievalInstructionVersionsInput | ListRetrievalInstructionVersionsInputDict | 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[ListRetrievalInstructionVersionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListRetrievalInstructionVersionsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ListRetrievalInstructionVersionsInputDict
¶
Bases: TypedDict
Dictionary form of ListRetrievalInstructionVersionsInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | None
Specifies the maximum number of versions to return in a single page. The service enforces the effective upper bound.
ListRetrievalInstructionVersionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListRetrievalInstructionVersionsInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
Specifies the maximum number of versions to return in a single page. The service enforces the effective upper bound.
Output¶
ListRetrievalInstructionVersionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListRetrievalInstructionVersionsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination token to pass to the next ListRetrievalInstructionVersions call, absent on the last page.
response_metadata
class-attribute
instance-attribute
¶
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_version_summaries
instance-attribute
¶
retrieval_instruction_version_summaries: list[RetrievalInstructionVersionSummary]
The version summaries in this page, newest first.