AgentsforBedrock / Client / update_agent_action_group

update_agent_action_group

AgentsforBedrock.Client.update_agent_action_group(**kwargs)

Updates an existing Action Group for Amazon Bedrock Agent

See also: AWS API Documentation

Request Syntax

response = client.update_agent_action_group(
    agentId='string',
    agentVersion='string',
    actionGroupId='string',
    actionGroupName='string',
    description='string',
    parentActionGroupSignature='AMAZON.UserInput',
    actionGroupExecutor={
        'lambda': 'string'
    },
    actionGroupState='ENABLED'|'DISABLED',
    apiSchema={
        's3': {
            's3BucketName': 'string',
            's3ObjectKey': 'string'
        },
        'payload': 'string'
    }
)

Parameters:

• agentId (string) –

  [REQUIRED]

  Id generated at the server side when an Agent is created

• agentVersion (string) –

  [REQUIRED]

  Draft Version of the Agent.

• actionGroupId (string) –

  [REQUIRED]

  Id generated at the server side when an Action Group is created under Agent

• actionGroupName (string) –

  [REQUIRED]

  Name for a resource.

• description (string) – Description of the Resource.

• parentActionGroupSignature (string) – Action Group Signature for a BuiltIn Action

• actionGroupExecutor (dict) –

  Type of Executors for an Action Group

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: lambda.

  • lambda (string) –

    ARN of a Lambda.

• actionGroupState (string) – State of the action group

• apiSchema (dict) –

  Contains information about the API Schema for the Action Group

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: s3, payload.

  • s3 (dict) –

    The identifier for the S3 resource.

    • s3BucketName (string) –

      A bucket in S3.

    • s3ObjectKey (string) –

      A object key in S3.

  • payload (string) –

    String OpenAPI Payload

Return type:

dict

Returns:

Response Syntax

{
    'agentActionGroup': {
        'agentId': 'string',
        'agentVersion': 'string',
        'actionGroupId': 'string',
        'actionGroupName': 'string',
        'clientToken': 'string',
        'description': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'parentActionSignature': 'AMAZON.UserInput',
        'actionGroupExecutor': {
            'lambda': 'string'
        },
        'apiSchema': {
            's3': {
                's3BucketName': 'string',
                's3ObjectKey': 'string'
            },
            'payload': 'string'
        },
        'actionGroupState': 'ENABLED'|'DISABLED'
    }
}

Response Structure

• (dict) –

  Update Action Group Response

  • agentActionGroup (dict) –

    Contains the information of an Agent Action Group

    • agentId (string) –

      Identifier for a resource.

    • agentVersion (string) –

      Agent Version.

    • actionGroupId (string) –

      Identifier for a resource.

    • actionGroupName (string) –

      Name for a resource.

    • clientToken (string) –

      Client specified token used for idempotency checks

    • description (string) –

      Description of the Resource.

    • createdAt (datetime) –

      Time Stamp.

    • updatedAt (datetime) –

      Time Stamp.

    • parentActionSignature (string) –

      Action Group Signature for a BuiltIn Action

    • actionGroupExecutor (dict) –

      Type of Executors for an Action Group

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: lambda. 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'}
      

      • lambda (string) –

        ARN of a Lambda.

    • apiSchema (dict) –

      Contains information about the API Schema for the Action Group

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: s3, payload. 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'}
      

      • s3 (dict) –

        The identifier for the S3 resource.

        • s3BucketName (string) –

          A bucket in S3.

        • s3ObjectKey (string) –

          A object key in S3.

      • payload (string) –

        String OpenAPI Payload

    • actionGroupState (string) –

      State of the action group

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