BedrockAgentCore / Client / list_ab_tests

list_ab_tests¶

BedrockAgentCore.Client.list_ab_tests(**kwargs)¶

Lists all A/B tests in the account.

Request Syntax

response = client.list_ab_tests(
    maxResults=123,
    nextToken='string'
)

Parameters:

maxResults (integer) – The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.
nextToken (string) – If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Return type:

dict

Returns:

Response Syntax

{
    'abTests': [
        {
            'abTestId': 'string',
            'abTestArn': 'string',
            'name': 'string',
            'status': 'CREATING'|'ACTIVE'|'CREATE_FAILED'|'UPDATING'|'UPDATE_FAILED'|'DELETING'|'DELETE_FAILED'|'FAILED',
            'executionStatus': 'PAUSED'|'RUNNING'|'STOPPED'|'NOT_STARTED',
            'description': 'string',
            'gatewayArn': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- abTests (list) –
  
  The list of A/B test summaries.
  - (dict) –
    
    Summary information about an A/B test.
    - abTestId (string) –
      
      The unique identifier of the A/B test.
    - abTestArn (string) –
      
      The Amazon Resource Name (ARN) of the A/B test.
    - name (string) –
      
      The name of the A/B test.
    - status (string) –
      
      The current status of the A/B test.
    - executionStatus (string) –
      
      The execution status of the A/B test.
    - description (string) –
      
      The description of the A/B test.
    - gatewayArn (string) –
      
      The Amazon Resource Name (ARN) of the gateway used for traffic splitting.
    - createdAt (datetime) –
      
      The timestamp when the A/B test was created.
    - updatedAt (datetime) –
      
      The timestamp when the A/B test was last updated.
- nextToken (string) –
  
  If the total number of results is greater than the maxResults value provided in the request, use this token when making another request in the nextToken field to return the next batch of results.

Exceptions

BedrockAgentCore.Client.exceptions.UnauthorizedException
BedrockAgentCore.Client.exceptions.ValidationException
BedrockAgentCore.Client.exceptions.AccessDeniedException
BedrockAgentCore.Client.exceptions.ThrottlingException
BedrockAgentCore.Client.exceptions.InternalServerException