AgentsforBedrock / Client / update_agent_alias

update_agent_alias

AgentsforBedrock.Client.update_agent_alias(**kwargs)

Updates an existing Alias for an Amazon Bedrock Agent

See also: AWS API Documentation

Request Syntax

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

Parameters:

• agentId (string) –

  [REQUIRED]

  Id generated at the server side when an Agent is created

• agentAliasId (string) –

  [REQUIRED]

  Id generated at the server side when an Agent Alias is created

• agentAliasName (string) –

  [REQUIRED]

  Name for a resource.

• description (string) – Description of the Resource.

• routingConfiguration (list) –

  Routing configuration for an Agent alias.

  • (dict) –

    Details about the routing configuration for an Agent alias.

    • agentVersion (string) – [REQUIRED]

      Agent Version.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  Update Agent Alias Response

  • agentAlias (dict) –

    Contains the information of an agent alias

    • agentId (string) –

      Identifier for a resource.

    • agentAliasId (string) –

      Id for an Agent Alias generated at the server side.

    • agentAliasName (string) –

      Name for a resource.

    • agentAliasArn (string) –

      Arn representation of the Agent Alias.

    • clientToken (string) –

      Client specified token used for idempotency checks

    • description (string) –

      Description of the Resource.

    • routingConfiguration (list) –

      Routing configuration for an Agent alias.

      • (dict) –

        Details about the routing configuration for an Agent alias.

        • agentVersion (string) –

          Agent Version.

    • createdAt (datetime) –

      Time Stamp.

    • updatedAt (datetime) –

      Time Stamp.

    • agentAliasHistoryEvents (list) –

      The list of history events for an alias for an Agent.

      • (dict) –

        History event for an alias for an Agent.

        • routingConfiguration (list) –

          Routing configuration for an Agent alias.

          • (dict) –

            Details about the routing configuration for an Agent alias.

            • agentVersion (string) –

              Agent Version.

        • endDate (datetime) –

          Time Stamp.

        • startDate (datetime) –

          Time Stamp.

    • agentAliasStatus (string) –

      The statuses an Agent Alias can be in.

Exceptions

• AgentsforBedrock.Client.exceptions.ThrottlingException

• AgentsforBedrock.Client.exceptions.AccessDeniedException

• AgentsforBedrock.Client.exceptions.ValidationException

• AgentsforBedrock.Client.exceptions.InternalServerException

• AgentsforBedrock.Client.exceptions.ResourceNotFoundException

• AgentsforBedrock.Client.exceptions.ConflictException

• AgentsforBedrock.Client.exceptions.ServiceQuotaExceededException