QuickSight / Client / update_agent

update_agent

QuickSight.Client.update_agent(**kwargs)

Updates an existing agent.

See also: AWS API Documentation

Request Syntax

response = client.update_agent(
    AgentId='string',
    AwsAccountId='string',
    Name='string',
    Description='string',
    IconId='string',
    StarterPrompts=[
        'string',
    ],
    WelcomeMessage='string',
    CustomPromptInput={
        'ExistingPrompt': {
            'ModelProfileId': 'string',
            'SubscriptionId': 'string',
            'QbsAwsAccountId': 'string'
        },
        'NewPrompt': {
            'ResponseLength': 'string',
            'OutputStyle': 'string',
            'Identity': 'string',
            'Tone': 'string',
            'CustomInstructions': 'string'
        }
    },
    SpacesToAdd=[
        'string',
    ],
    SpacesToRemove=[
        'string',
    ],
    ActionConnectorsToAdd=[
        'string',
    ],
    ActionConnectorsToRemove=[
        'string',
    ]
)
Parameters:

  • AgentId (string) –

    [REQUIRED]

    The unique identifier for the agent to update.

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the agent.

  • Name (string) –

    [REQUIRED]

    The name of the agent.

  • Description (string) – A description of the agent.

  • IconId (string) – The icon identifier for the agent.

  • StarterPrompts (list) –

    A list of starter prompts that are displayed to users when they begin interacting with the agent.

    • (string) –

  • WelcomeMessage (string) – The welcome message that is displayed when a user starts a conversation with the agent.

  • CustomPromptInput (dict) –

    The custom prompt configuration for the agent.

    Note

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

    • ExistingPrompt (dict) –

      An existing custom prompt profile to use for the agent.

      • ModelProfileId (string) – [REQUIRED]

        The identifier of the model profile.

      • SubscriptionId (string) – [REQUIRED]

        The subscription identifier.

      • QbsAwsAccountId (string) – [REQUIRED]

        The Amazon Web Services account ID for the Q Business service.

    • NewPrompt (dict) –

      New custom prompt parameters to configure for the agent.

      • ResponseLength (string) –

        Instructions for the desired response length.

      • OutputStyle (string) –

        Instructions for the desired output style.

      • Identity (string) –

        Instructions that define the agent’s identity and persona.

      • Tone (string) –

        Instructions for the desired tone of responses.

      • CustomInstructions (string) –

        Custom instructions for the agent’s behavior.

  • SpacesToAdd (list) –

    The Amazon Resource Names (ARNs) of the spaces to attach to the agent.

    • (string) –

  • SpacesToRemove (list) –

    The Amazon Resource Names (ARNs) of the spaces to detach from the agent.

    • (string) –

  • ActionConnectorsToAdd (list) –

    The Amazon Resource Names (ARNs) of the action connectors to attach to the agent.

    • (string) –

  • ActionConnectorsToRemove (list) –

    The Amazon Resource Names (ARNs) of the action connectors to detach from the agent.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'AgentId': 'string',
    'AgentStatus': 'ACTIVE'|'UPDATING'|'FAILED'|'CREATING',
    'FailedToAddSpaces': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToRemoveSpaces': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToAddActionConnectors': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'FailedToRemoveActionConnectors': [
        {
            'Arn': 'string',
            'ErrorMessage': 'string',
            'ErrorCode': 'string'
        },
    ],
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the agent.

    • AgentId (string) –

      The unique identifier for the agent.

    • AgentStatus (string) –

      The status of the agent.

    • FailedToAddSpaces (list) –

      A list of per-ARN failures from the spaces that were requested to be added.

      • (dict) –

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) –

          The ARN that could not be added or removed.

        • ErrorMessage (string) –

          A description of the failure.

        • ErrorCode (string) –

          The error code for the failure.

    • FailedToRemoveSpaces (list) –

      A list of per-ARN failures from the spaces that were requested to be removed.

      • (dict) –

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) –

          The ARN that could not be added or removed.

        • ErrorMessage (string) –

          A description of the failure.

        • ErrorCode (string) –

          The error code for the failure.

    • FailedToAddActionConnectors (list) –

      A list of per-ARN failures from the action connectors that were requested to be added.

      • (dict) –

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) –

          The ARN that could not be added or removed.

        • ErrorMessage (string) –

          A description of the failure.

        • ErrorCode (string) –

          The error code for the failure.

    • FailedToRemoveActionConnectors (list) –

      A list of per-ARN failures from the action connectors that were requested to be removed.

      • (dict) –

        Information about a per-ARN failure when updating agent associations.

        • Arn (string) –

          The ARN that could not be added or removed.

        • ErrorMessage (string) –

          A description of the failure.

        • ErrorCode (string) –

          The error code for the failure.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions