AWS API Changes

2024/05/03 - Agents for Amazon Bedrock - 4 updated api methods

Changes This release adds support for using Provisioned Throughput with Bedrock Agents.

CreateAgentAlias (updated)

Link ¶
Changes (request, response)
Request

{'routingConfiguration': {'provisionedThroughput': 'string'}}

Response

{'agentAlias': {'agentAliasHistoryEvents': {'routingConfiguration': {'provisionedThroughput': 'string'}},
                'failureReasons': ['string'],
                'routingConfiguration': {'provisionedThroughput': 'string'}}}

Creates an alias of an agent that can be used to deploy the agent.

See also: AWS API Documentation

Request Syntax

client.create_agent_alias(
    agentAliasName='string',
    agentId='string',
    clientToken='string',
    description='string',
    routingConfiguration=[
        {
            'agentVersion': 'string',
            'provisionedThroughput': 'string'
        },
    ],
    tags={
        'string': 'string'
    }
)

type agentAliasName:

string

param agentAliasName:

[REQUIRED]

The name of the alias.

type agentId:

string

param agentId:

[REQUIRED]

The unique identifier of the agent.

type clientToken:

string

param clientToken:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

type description:

string

param description:

A description of the alias of the agent.

type routingConfiguration:

list

param routingConfiguration:

Contains details about the routing configuration of the alias.

(dict) --

Contains details about the routing configuration of the alias.
- agentVersion (string) --
  
  The version of the agent with which the alias is associated.
- provisionedThroughput (string) --
  
  Information on the Provisioned Throughput assigned to an agent alias.

type tags:

dict

param tags:

Any tags that you want to attach to the alias of the agent.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{
    'agentAlias': {
        'agentAliasArn': 'string',
        'agentAliasHistoryEvents': [
            {
                'endDate': datetime(2015, 1, 1),
                'routingConfiguration': [
                    {
                        'agentVersion': 'string',
                        'provisionedThroughput': 'string'
                    },
                ],
                'startDate': datetime(2015, 1, 1)
            },
        ],
        'agentAliasId': 'string',
        'agentAliasName': 'string',
        'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
        'agentId': 'string',
        'clientToken': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'routingConfiguration': [
            {
                'agentVersion': 'string',
                'provisionedThroughput': 'string'
            },
        ],
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- agentAlias (dict) --
  
  Contains details about the alias that was created.
  - agentAliasArn (string) --
    
    The Amazon Resource Name (ARN) of the alias of the agent.
  - agentAliasHistoryEvents (list) --
    
    Contains details about the history of the alias.
    - (dict) --
      
      Contains details about the history of the alias.
      - endDate (datetime) --
        
        The date that the alias stopped being associated to the version in the routingConfiguration object
      - routingConfiguration (list) --
        
        Contains details about the version of the agent with which the alias is associated.
        
        (dict) --
        
        Contains details about the routing configuration of the alias.
        
        agentVersion (string) --
        
        The version of the agent with which the alias is associated.
        
        provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
      - startDate (datetime) --
        
        The date that the alias began being associated to the version in the routingConfiguration object.
  - agentAliasId (string) --
    
    The unique identifier of the alias of the agent.
  - agentAliasName (string) --
    
    The name of the alias of the agent.
  - agentAliasStatus (string) --
    
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent alias is being created.
    - PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    - FAILED – The agent alias API operation failed.
    - UPDATING – The agent alias is being updated.
    - DELETING – The agent alias is being deleted.
  - agentId (string) --
    
    The unique identifier of the agent.
  - clientToken (string) --
    
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  - createdAt (datetime) --
    
    The time at which the alias of the agent was created.
  - description (string) --
    
    The description of the alias of the agent.
  - failureReasons (list) --
    
    Information on the failure of Provisioned Throughput assigned to an agent alias.
    - (string) --
  - routingConfiguration (list) --
    
    Contains details about the routing configuration of the alias.
    - (dict) --
      
      Contains details about the routing configuration of the alias.
      - agentVersion (string) --
        
        The version of the agent with which the alias is associated.
      - provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
  - updatedAt (datetime) --
    
    The time at which the alias was last updated.

GetAgentAlias (updated)

Link ¶
Changes (response)

{'agentAlias': {'agentAliasHistoryEvents': {'routingConfiguration': {'provisionedThroughput': 'string'}},
                'failureReasons': ['string'],
                'routingConfiguration': {'provisionedThroughput': 'string'}}}

Gets information about an alias of an agent.

See also: AWS API Documentation

Request Syntax

client.get_agent_alias(
    agentAliasId='string',
    agentId='string'
)

type agentAliasId:

string

param agentAliasId:

[REQUIRED]

The unique identifier of the alias for which to get information.

type agentId:

string

param agentId:

[REQUIRED]

The unique identifier of the agent to which the alias to get information belongs.

rtype:

dict

returns:

Response Syntax

{
    'agentAlias': {
        'agentAliasArn': 'string',
        'agentAliasHistoryEvents': [
            {
                'endDate': datetime(2015, 1, 1),
                'routingConfiguration': [
                    {
                        'agentVersion': 'string',
                        'provisionedThroughput': 'string'
                    },
                ],
                'startDate': datetime(2015, 1, 1)
            },
        ],
        'agentAliasId': 'string',
        'agentAliasName': 'string',
        'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
        'agentId': 'string',
        'clientToken': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'routingConfiguration': [
            {
                'agentVersion': 'string',
                'provisionedThroughput': 'string'
            },
        ],
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- agentAlias (dict) --
  
  Contains information about the alias.
  - agentAliasArn (string) --
    
    The Amazon Resource Name (ARN) of the alias of the agent.
  - agentAliasHistoryEvents (list) --
    
    Contains details about the history of the alias.
    - (dict) --
      
      Contains details about the history of the alias.
      - endDate (datetime) --
        
        The date that the alias stopped being associated to the version in the routingConfiguration object
      - routingConfiguration (list) --
        
        Contains details about the version of the agent with which the alias is associated.
        
        (dict) --
        
        Contains details about the routing configuration of the alias.
        
        agentVersion (string) --
        
        The version of the agent with which the alias is associated.
        
        provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
      - startDate (datetime) --
        
        The date that the alias began being associated to the version in the routingConfiguration object.
  - agentAliasId (string) --
    
    The unique identifier of the alias of the agent.
  - agentAliasName (string) --
    
    The name of the alias of the agent.
  - agentAliasStatus (string) --
    
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent alias is being created.
    - PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    - FAILED – The agent alias API operation failed.
    - UPDATING – The agent alias is being updated.
    - DELETING – The agent alias is being deleted.
  - agentId (string) --
    
    The unique identifier of the agent.
  - clientToken (string) --
    
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  - createdAt (datetime) --
    
    The time at which the alias of the agent was created.
  - description (string) --
    
    The description of the alias of the agent.
  - failureReasons (list) --
    
    Information on the failure of Provisioned Throughput assigned to an agent alias.
    - (string) --
  - routingConfiguration (list) --
    
    Contains details about the routing configuration of the alias.
    - (dict) --
      
      Contains details about the routing configuration of the alias.
      - agentVersion (string) --
        
        The version of the agent with which the alias is associated.
      - provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
  - updatedAt (datetime) --
    
    The time at which the alias was last updated.

ListAgentAliases (updated)

Link ¶
Changes (response)

{'agentAliasSummaries': {'routingConfiguration': {'provisionedThroughput': 'string'}}}

Lists the aliases of an agent and information about each one.

See also: AWS API Documentation

Request Syntax

client.list_agent_aliases(
    agentId='string',
    maxResults=123,
    nextToken='string'
)

type agentId:

string

param agentId:

[REQUIRED]

The unique identifier of the agent.

type maxResults:

integer

param maxResults:

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.

type nextToken:

string

param nextToken:

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.

rtype:

dict

returns:

Response Syntax

{
    'agentAliasSummaries': [
        {
            'agentAliasId': 'string',
            'agentAliasName': 'string',
            'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
            'createdAt': datetime(2015, 1, 1),
            'description': 'string',
            'routingConfiguration': [
                {
                    'agentVersion': 'string',
                    'provisionedThroughput': 'string'
                },
            ],
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- agentAliasSummaries (list) --
  
  A list of objects, each of which contains information about an alias of the agent.
  - (dict) --
    
    Contains details about an alias of an agent.
    - agentAliasId (string) --
      
      Contains details about
    - agentAliasName (string) --
      
      The name of the alias.
    - agentAliasStatus (string) --
      
      The status of the alias.
    - createdAt (datetime) --
      
      The time at which the alias of the agent was created.
    - description (string) --
      
      The description of the alias.
    - routingConfiguration (list) --
      
      Contains details about the version of the agent with which the alias is associated.
      - (dict) --
        
        Contains details about the routing configuration of the alias.
        
        agentVersion (string) --
        
        The version of the agent with which the alias is associated.
        
        provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
    - updatedAt (datetime) --
      
      The time at which the alias 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.

UpdateAgentAlias (updated)

Link ¶
Changes (request, response)
Request

{'routingConfiguration': {'provisionedThroughput': 'string'}}

Response

{'agentAlias': {'agentAliasHistoryEvents': {'routingConfiguration': {'provisionedThroughput': 'string'}},
                'failureReasons': ['string'],
                'routingConfiguration': {'provisionedThroughput': 'string'}}}

Updates configurations for an alias of an agent.

See also: AWS API Documentation

Request Syntax

client.update_agent_alias(
    agentAliasId='string',
    agentAliasName='string',
    agentId='string',
    description='string',
    routingConfiguration=[
        {
            'agentVersion': 'string',
            'provisionedThroughput': 'string'
        },
    ]
)

type agentAliasId:

string

param agentAliasId:

[REQUIRED]

The unique identifier of the alias.

type agentAliasName:

string

param agentAliasName:

[REQUIRED]

Specifies a new name for the alias.

type agentId:

string

param agentId:

[REQUIRED]

The unique identifier of the agent.

type description:

string

param description:

Specifies a new description for the alias.

type routingConfiguration:

list

param routingConfiguration:

Contains details about the routing configuration of the alias.

(dict) --

Contains details about the routing configuration of the alias.
- agentVersion (string) --
  
  The version of the agent with which the alias is associated.
- provisionedThroughput (string) --
  
  Information on the Provisioned Throughput assigned to an agent alias.

rtype:

dict

returns:

Response Syntax

{
    'agentAlias': {
        'agentAliasArn': 'string',
        'agentAliasHistoryEvents': [
            {
                'endDate': datetime(2015, 1, 1),
                'routingConfiguration': [
                    {
                        'agentVersion': 'string',
                        'provisionedThroughput': 'string'
                    },
                ],
                'startDate': datetime(2015, 1, 1)
            },
        ],
        'agentAliasId': 'string',
        'agentAliasName': 'string',
        'agentAliasStatus': 'CREATING'|'PREPARED'|'FAILED'|'UPDATING'|'DELETING',
        'agentId': 'string',
        'clientToken': 'string',
        'createdAt': datetime(2015, 1, 1),
        'description': 'string',
        'failureReasons': [
            'string',
        ],
        'routingConfiguration': [
            {
                'agentVersion': 'string',
                'provisionedThroughput': 'string'
            },
        ],
        'updatedAt': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- agentAlias (dict) --
  
  Contains details about the alias that was updated.
  - agentAliasArn (string) --
    
    The Amazon Resource Name (ARN) of the alias of the agent.
  - agentAliasHistoryEvents (list) --
    
    Contains details about the history of the alias.
    - (dict) --
      
      Contains details about the history of the alias.
      - endDate (datetime) --
        
        The date that the alias stopped being associated to the version in the routingConfiguration object
      - routingConfiguration (list) --
        
        Contains details about the version of the agent with which the alias is associated.
        
        (dict) --
        
        Contains details about the routing configuration of the alias.
        
        agentVersion (string) --
        
        The version of the agent with which the alias is associated.
        
        provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
      - startDate (datetime) --
        
        The date that the alias began being associated to the version in the routingConfiguration object.
  - agentAliasId (string) --
    
    The unique identifier of the alias of the agent.
  - agentAliasName (string) --
    
    The name of the alias of the agent.
  - agentAliasStatus (string) --
    
    The status of the alias of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent alias is being created.
    - PREPARED – The agent alias is finished being created or updated and is ready to be invoked.
    - FAILED – The agent alias API operation failed.
    - UPDATING – The agent alias is being updated.
    - DELETING – The agent alias is being deleted.
  - agentId (string) --
    
    The unique identifier of the agent.
  - clientToken (string) --
    
    A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
  - createdAt (datetime) --
    
    The time at which the alias of the agent was created.
  - description (string) --
    
    The description of the alias of the agent.
  - failureReasons (list) --
    
    Information on the failure of Provisioned Throughput assigned to an agent alias.
    - (string) --
  - routingConfiguration (list) --
    
    Contains details about the routing configuration of the alias.
    - (dict) --
      
      Contains details about the routing configuration of the alias.
      - agentVersion (string) --
        
        The version of the agent with which the alias is associated.
      - provisionedThroughput (string) --
        
        Information on the Provisioned Throughput assigned to an agent alias.
  - updatedAt (datetime) --
    
    The time at which the alias was last updated.