list_retrieval_instructions¶
Operation¶
list_retrieval_instructions
¶
list_retrieval_instructions(request: ListRetrievalInstructionsInput | ListRetrievalInstructionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrievalInstructionsInputDict]) -> ListRetrievalInstructionsOutput
Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListRetrievalInstructionsInput | ListRetrievalInstructionsInputDict | 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[ListRetrievalInstructionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListRetrievalInstructionsOutput
|
An instance of |
list_retrieval_instructions
async
¶
list_retrieval_instructions(request: ListRetrievalInstructionsInput | ListRetrievalInstructionsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListRetrievalInstructionsInputDict]) -> ListRetrievalInstructionsOutput
Lists the retrieval instructions in the caller's account. Results are paginated. Use the nextToken parameter to retrieve additional results.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
ListRetrievalInstructionsInput | ListRetrievalInstructionsInputDict | 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[ListRetrievalInstructionsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ListRetrievalInstructionsOutput
|
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.
ListRetrievalInstructionsInputDict
¶
Bases: TypedDict
Dictionary form of ListRetrievalInstructionsInput.
Attributes¶
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return in a single page. The effective upper bound is enforced service-side.
ListRetrievalInstructionsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListRetrievalInstructionsInput structure.
Attributes¶
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return in a single page. The effective upper bound is enforced service-side.
Output¶
ListRetrievalInstructionsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ListRetrievalInstructionsOutput structure.
Attributes¶
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The pagination token to pass to the next ListRetrievalInstructions 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_summaries
instance-attribute
¶
retrieval_instruction_summaries: list[RetrievalInstructionSummary]
The retrieval instruction summaries in this page.