BedrockRuntime / Client / list_async_invokes

list_async_invokes#

BedrockRuntime.Client.list_async_invokes(**kwargs)#

Lists asynchronous invocations.

See also: AWS API Documentation

Request Syntax

response = client.list_async_invokes(
    submitTimeAfter=datetime(2015, 1, 1),
    submitTimeBefore=datetime(2015, 1, 1),
    statusEquals='InProgress'|'Completed'|'Failed',
    maxResults=123,
    nextToken='string',
    sortBy='SubmissionTime',
    sortOrder='Ascending'|'Descending'
)
Parameters:

  • submitTimeAfter (datetime) – Include invocations submitted after this time.

  • submitTimeBefore (datetime) – Include invocations submitted before this time.

  • statusEquals (string) – Filter invocations by status.

  • maxResults (integer) – The maximum number of invocations to return in one page of results.

  • nextToken (string) – Specify the pagination token from a previous request to retrieve the next page of results.

  • sortBy (string) – How to sort the response.

  • sortOrder (string) – The sorting order for the response.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    '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'
                }
            }
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      Specify the pagination token from a previous request to retrieve the next page of results.

    • 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 set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_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.

Exceptions