start_async_invoke¶
Operation¶
start_async_invoke
¶
start_async_invoke(request: StartAsyncInvokeInput | StartAsyncInvokeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartAsyncInvokeInputDict]) -> StartAsyncInvokeOutput
Starts an asynchronous invocation.
This operation requires permission for the bedrock:InvokeModel action.
Warning
To deny all inference access to resources that you specify in the
modelId field, you need to deny access to the bedrock:InvokeModel and
bedrock:InvokeModelWithResponseStream actions. Doing this also denies
access to the resource through the Converse API actions
(Converse
and
ConverseStream).
For more information see Deny access for inference on specific
models.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartAsyncInvokeInput | StartAsyncInvokeInputDict | 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[StartAsyncInvokeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartAsyncInvokeOutput
|
An instance of |
start_async_invoke
async
¶
start_async_invoke(request: StartAsyncInvokeInput | StartAsyncInvokeInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[StartAsyncInvokeInputDict]) -> StartAsyncInvokeOutput
Starts an asynchronous invocation.
This operation requires permission for the bedrock:InvokeModel action.
Warning
To deny all inference access to resources that you specify in the
modelId field, you need to deny access to the bedrock:InvokeModel and
bedrock:InvokeModelWithResponseStream actions. Doing this also denies
access to the resource through the Converse API actions
(Converse
and
ConverseStream).
For more information see Deny access for inference on specific
models.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
StartAsyncInvokeInput | StartAsyncInvokeInputDict | 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[StartAsyncInvokeInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
StartAsyncInvokeOutput
|
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.
StartAsyncInvokeInputDict
¶
Bases: TypedDict
Dictionary form of StartAsyncInvokeInput.
Attributes¶
client_request_token
instance-attribute
¶
client_request_token: str | None
Specify idempotency token to ensure that requests are not duplicated.
This field is autopopulated if not provided.
output_data_config
instance-attribute
¶
output_data_config: Required[AsyncInvokeOutputDataConfig | AsyncInvokeOutputDataConfigDict]
Where to store the output.
StartAsyncInvokeInput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartAsyncInvokeInput structure.
Attributes¶
client_request_token
class-attribute
instance-attribute
¶
client_request_token: str | None = ...
Specify idempotency token to ensure that requests are not duplicated.
This field is autopopulated if not provided.
model_input
class-attribute
instance-attribute
¶
Input to send to the model.
output_data_config
class-attribute
instance-attribute
¶
output_data_config: AsyncInvokeOutputDataConfig | None = ...
Where to store the output.
Output¶
StartAsyncInvokeOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for StartAsyncInvokeOutput structure.