BedrockRuntime / Paginator / ListAsyncInvokes
ListAsyncInvokes¶
- class BedrockRuntime.Paginator.ListAsyncInvokes¶
paginator = client.get_paginator('list_async_invokes')
- paginate(**kwargs)¶
Creates an iterator that will paginate through responses from
BedrockRuntime.Client.list_async_invokes()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( submitTimeAfter=datetime(2015, 1, 1), submitTimeBefore=datetime(2015, 1, 1), statusEquals='InProgress'|'Completed'|'Failed', sortBy='SubmissionTime', sortOrder='Ascending'|'Descending', PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
submitTimeAfter (datetime) – Include invocations submitted after this time.
submitTimeBefore (datetime) – Include invocations submitted before this time.
statusEquals (string) – Filter invocations by status.
sortBy (string) – How to sort the response.
sortOrder (string) – The sorting order for the response.
PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
Response Syntax
{ 'asyncInvokeSummaries': [ { 'invocationArn': 'string', 'modelArn': 'string', 'clientRequestToken': 'string', 'status': 'InProgress'|'Completed'|'Failed', 'failureMessage': 'string', 'submitTime': datetime(2015, 1, 1), 'lastModifiedTime': datetime(2015, 1, 1), 'endTime': datetime(2015, 1, 1), 'outputDataConfig': { 's3OutputDataConfig': { 's3Uri': 'string', 'kmsKeyId': 'string', 'bucketOwner': 'string' } } }, ], 'NextToken': 'string' }
Response Structure
(dict) –
asyncInvokeSummaries (list) –
A list of invocation summaries.
(dict) –
A summary of an asynchronous invocation.
invocationArn (string) –
The invocation’s ARN.
modelArn (string) –
The invoked model’s ARN.
clientRequestToken (string) –
The invocation’s idempotency token.
status (string) –
The invocation’s status.
failureMessage (string) –
An error message.
submitTime (datetime) –
When the invocation was submitted.
lastModifiedTime (datetime) –
When the invocation was last modified.
endTime (datetime) –
When the invocation ended.
outputDataConfig (dict) –
The invocation’s output data settings.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set:
s3OutputDataConfig
. If a client receives an unknown member it will setSDK_UNKNOWN_MEMBER
as the top level key, which maps to the name or tag of the unknown member. The structure ofSDK_UNKNOWN_MEMBER
is as follows:'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
s3OutputDataConfig (dict) –
A storage location for the output data in an S3 bucket
s3Uri (string) –
An object URI starting with
s3://
.kmsKeyId (string) –
A KMS encryption key ID.
bucketOwner (string) –
If the bucket belongs to another AWS account, specify that account’s ID.
NextToken (string) –
A token to resume pagination.