DevOpsAgentService / Client / update_agent_space

update_agent_space

DevOpsAgentService.Client.update_agent_space(**kwargs)

Updates the information of an existing AgentSpace.

See also: AWS API Documentation

Request Syntax

response = client.update_agent_space(
    agentSpaceId='string',
    name='string',
    description='string',
    locale='string',
    preferences={
        'string': True|False
    }
)
Parameters:

  • agentSpaceId (string) –

    [REQUIRED]

    The unique identifier of the AgentSpace

  • name (string) – The updated name of the AgentSpace.

  • description (string) – The updated description of the AgentSpace.

  • locale (string) – The updated locale for the AgentSpace, which determines the language used in agent responses.

  • preferences (dict) –

    The preferences to configure on the agent space. When provided, this replaces the full set of configured preferences; preferences not included revert to their default values. When omitted, the current preferences are left unchanged.

    • (string) –

      The key of a preference that can be configured on an agent space. The elevatedActionsEnabled key controls whether elevated directed actions are permitted in the agent space. Elevated directed actions are mutating operations that also require per-action operator approval, and default to false when not set.

      • (boolean) –

Return type:

dict

Returns:

Response Syntax

{
    'agentSpace': {
        'name': 'string',
        'description': 'string',
        'locale': 'string',
        'createdAt': datetime(2015, 1, 1),
        'updatedAt': datetime(2015, 1, 1),
        'kmsKeyArn': 'string',
        'agentSpaceId': 'string',
        'preferences': {
            'string': True|False
        }
    }
}

Response Structure

  • (dict) –

    Output containing the updated AgentSpace.

    • agentSpace (dict) –

      Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.

      • name (string) –

        The name of the AgentSpace.

      • description (string) –

        The description of the AgentSpace.

      • locale (string) –

        The locale for the AgentSpace, which determines the language used in agent responses.

      • createdAt (datetime) –

        The timestamp when the resource was created.

      • updatedAt (datetime) –

        The timestamp when the resource was last updated.

      • kmsKeyArn (string) –

        The ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.

      • agentSpaceId (string) –

        The unique identifier of the AgentSpace

      • preferences (dict) –

        The preferences configured on the agent space. Preferences that are not set take their default values.

        • (string) –

          The key of a preference that can be configured on an agent space. The elevatedActionsEnabled key controls whether elevated directed actions are permitted in the agent space. Elevated directed actions are mutating operations that also require per-action operator approval, and default to false when not set.

          • (boolean) –

Exceptions