agent_spaces

Creates, updates, deletes, gets or lists an agent_spaces resource.

Overview

Name	agent_spaces
Type	Resource
Id	aws.devops_agent.agent_spaces

Fields

The following fields are returned by SELECT queries:

get_agent_space

Name	Datatype	Description
agent_space	object	Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
tags	object	Tags associated with the AgentSpace.

list_agent_spaces

Name	Datatype	Description
name	string	Agent space name field (pattern: <code>[\p{L}\p{N}\p{P}\p{S}\p{Z}]+</code>)
agent_space_id	string	Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters) (pattern: <code>[a-zA-Z0-9-]{1,64}</code>)
created_at	string (date-time)	The timestamp when the resource was created.
description	string	Description field (pattern: <code>[\p{L}\p{N}\p{P}\p{S}\p{Z}]+</code>)
kms_key_arn	string	The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources. (pattern: <code>arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
locale	string	A BCP 47 locale identifier for configuring the language used in agent responses. (pattern: <code>[a-zA-Z]{2,3}(-[a-zA-Z0-9]{2,8})*</code>)
updated_at	string (date-time)	The timestamp when the resource was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_agent_space	select	agent_space_id, region		Retrieves detailed information about a specific AgentSpace.
list_agent_spaces	select	region	maxResults, nextToken	Lists all AgentSpaces with optional pagination.
create_agent_space	insert	region, name		Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.
update_agent_space	update	agent_space_id, region		Updates the information of an existing AgentSpace.
delete_agent_space	delete	agent_space_id, region		Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.
disable_operator_app	exec	agent_space_id, region	x-amzn-app-auth-flow	Disable the Operator App for the specified AgentSpace
enable_operator_app	exec	agent_space_id, region, authFlow, operatorAppRoleArn		Enable the Operator App to access the given AgentSpace
send_message	exec	agent_space_id, region, executionId, content		Sends a chat message and streams the response for the specified agent space execution

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agent_space_id	string	The agent space identifier
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of results to return in a single call.
nextToken	string	Token for the next page of results.
x-amzn-app-auth-flow	string	The authentication flow configured for the operator App. e.g. idc

SELECT examples

get_agent_space

Retrieves detailed information about a specific AgentSpace.

SELECT
agent_space,
tags
FROM aws.devops_agent.agent_spaces
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND region = '{{ region }}' -- required
;

list_agent_spaces

Lists all AgentSpaces with optional pagination.

SELECT
name,
agent_space_id,
created_at,
description,
kms_key_arn,
locale,
updated_at
FROM aws.devops_agent.agent_spaces
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_agent_space

Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.

INSERT INTO aws.devops_agent.agent_spaces (
name,
description,
locale,
kmsKeyArn,
clientToken,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ locale }}',
'{{ kmsKeyArn }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
agent_space,
tags
;

Manifest

# Description fields are for documentation purposes
- name: agent_spaces
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the agent_spaces resource.
  - name: name
    value: "{{ name }}"
    description: |
      Agent space name field
  - name: description
    value: "{{ description }}"
    description: |
      Description field
  - name: locale
    value: "{{ locale }}"
    description: |
      A BCP 47 locale identifier for configuring the language used in agent responses.
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"
    description: |
      The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Map of tag keys to values.

UPDATE examples

update_agent_space

Updates the information of an existing AgentSpace.

UPDATE aws.devops_agent.agent_spaces
SET 
name = '{{ name }}',
description = '{{ description }}',
locale = '{{ locale }}'
WHERE 
agent_space_id = '{{ agent_space_id }}' --required
AND region = '{{ region }}' --required
RETURNING
agent_space;

DELETE examples

delete_agent_space

Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.

DELETE FROM aws.devops_agent.agent_spaces
WHERE agent_space_id = '{{ agent_space_id }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

disable_operator_app

Disable the Operator App for the specified AgentSpace

EXEC aws.devops_agent.agent_spaces.disable_operator_app 
@agent_space_id='{{ agent_space_id }}' --required, 
@region='{{ region }}' --required, 
@x-amzn-app-auth-flow='{{ x-amzn-app-auth-flow }}'
;

enable_operator_app

Enable the Operator App to access the given AgentSpace

EXEC aws.devops_agent.agent_spaces.enable_operator_app 
@agent_space_id='{{ agent_space_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"authFlow": "{{ authFlow }}", 
"operatorAppRoleArn": "{{ operatorAppRoleArn }}", 
"idcInstanceArn": "{{ idcInstanceArn }}", 
"issuerUrl": "{{ issuerUrl }}", 
"idpClientId": "{{ idpClientId }}", 
"idpClientSecret": "{{ idpClientSecret }}", 
"provider": "{{ provider }}"
}'
;

send_message

Sends a chat message and streams the response for the specified agent space execution

EXEC aws.devops_agent.agent_spaces.send_message 
@agent_space_id='{{ agent_space_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"executionId": "{{ executionId }}", 
"content": "{{ content }}", 
"context": "{{ context }}", 
"userId": "{{ userId }}", 
"assetIds": "{{ assetIds }}"
}'
;