associations

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

Overview

Name	associations
Type	Resource
Id	aws.devops_agent.associations

Fields

The following fields are returned by SELECT queries:

get_association

Name	Datatype	Description
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>)
association_id	string	The unique identifier of the given association. (pattern: <code>[a-zA-Z0-9-]+</code>)
capabilities	object	Enabled capabilities for this association.
configuration	object	Union of all supported service configuration types. Each service has its own specific configuration structure.
created_at	string (date-time)	The timestamp when the resource was created.
service_id	string	Unique identifier for a registered service (pattern: <code>[a-zA-Z0-9_-]+</code>)
status	string	Validation status (valid, invalid, pending-confirmation)
updated_at	string (date-time)	The timestamp when the resource was last updated.

list_associations

Name	Datatype	Description
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>)
association_id	string	The unique identifier of the given association. (pattern: <code>[a-zA-Z0-9-]+</code>)
capabilities	object	Enabled capabilities for this association.
configuration	object	Union of all supported service configuration types. Each service has its own specific configuration structure.
created_at	string (date-time)	The timestamp when the resource was created.
service_id	string	Unique identifier for a registered service (pattern: <code>[a-zA-Z0-9_-]+</code>)
status	string	Validation status (valid, invalid, pending-confirmation)
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_association	select	agent_space_id, association_id, region		Retrieves given associations configured for a specific AgentSpace.
list_associations	select	agent_space_id, region	maxResults, nextToken, filterServiceTypes	List all associations for given AgentSpace
update_association	update	agent_space_id, association_id, region, configuration		Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.
validate_aws_associations	exec	agent_space_id, region		Validates an aws association and set status and returns a 204 No Content response on success.

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 unique identifier of the AgentSpace
association_id	string	The unique identifier of the given association.
region	string	AWS region (default: us-east-1)
filterServiceTypes	string	A comma-separated list of service types to filter list associations output
maxResults	integer	Maximum number of results to return in a single call.
nextToken	string	Token for the next page of results.

SELECT examples

get_association

Retrieves given associations configured for a specific AgentSpace.

SELECT
agent_space_id,
association_id,
capabilities,
configuration,
created_at,
service_id,
status,
updated_at
FROM aws.devops_agent.associations
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND association_id = '{{ association_id }}' -- required
AND region = '{{ region }}' -- required
;

list_associations

List all associations for given AgentSpace

SELECT
agent_space_id,
association_id,
capabilities,
configuration,
created_at,
service_id,
status,
updated_at
FROM aws.devops_agent.associations
WHERE agent_space_id = '{{ agent_space_id }}' -- required
AND region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND filterServiceTypes = '{{ filterServiceTypes }}'
;

UPDATE examples

update_association

Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.

UPDATE aws.devops_agent.associations
SET 
configuration = '{{ configuration }}',
capabilities = '{{ capabilities }}'
WHERE 
agent_space_id = '{{ agent_space_id }}' --required
AND association_id = '{{ association_id }}' --required
AND region = '{{ region }}' --required
AND configuration = '{{ configuration }}' --required
RETURNING
association,
webhook;

Lifecycle Methods

validate_aws_associations

Validates an aws association and set status and returns a 204 No Content response on success.

EXEC aws.devops_agent.associations.validate_aws_associations 
@agent_space_id='{{ agent_space_id }}' --required, 
@region='{{ region }}' --required
;