list-associations¶

Description¶

List all associations for given AgentSpace

Synopsis¶

  list-associations
--agent-space-id <value>
[--filter-service-types <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--agent-space-id (string) [required]

The unique identifier of the AgentSpace

Constraints:

pattern: [a-zA-Z0-9-]{1,64}

--filter-service-types (string)

A comma-separated list of service types to filter list associations output

Constraints:

pattern: \w+(?:,\s*\w+)*

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

nextToken -> (string)

Token to retrieve the next page of results, if there are more results.

Constraints:

min: 1

max: 2048

associations -> (list)

The list of associations.

(structure)

Represents a service association within an AgentSpace, defining how the agent interacts with external services.

agentSpaceId -> (string) [required]

The unique identifier of the AgentSpace

Constraints:

pattern: [a-zA-Z0-9-]{1,64}

createdAt -> (timestamp) [required]

The timestamp when the resource was created.

updatedAt -> (timestamp) [required]

The timestamp when the resource was last updated.

status -> (string)

Validation status

Possible values:

valid

invalid

pending-confirmation

associationId -> (string) [required]

The unique identifier of the given association.

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9-]+

serviceId -> (string) [required]

The identifier for associated service

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9_-]+

configuration -> (tagged union structure) [required]

The configuration that directs how AgentSpace interacts with the given service.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: sourceAws, aws, github, slack, dynatrace, servicenow, mcpservernewrelic, gitlab, eventChannel, azure, azuredevops, mcpservergrafana, pagerduty.

sourceAws -> (structure)

AWS source account configuration for monitoring resources.

accountId -> (string) [required]

AWS Account Id corresponding to provided resources.

Constraints:

pattern: \d{12}

accountType -> (string) [required]

Account Type ‘source’ for AIDevOps monitoring.

Possible values:

source

assumableRoleArn -> (string) [required]

Role ARN to be assumed by AIDevOps to operate on behalf of customer.

Constraints:

min: 1

max: 255

pattern: arn:aws:iam::\d{12}:role/[a-zA-Z0-9+=,.@_/-]+

externalId -> (string)

External ID for additional security when assuming the role. Used to prevent the confused deputy problem.

aws -> (structure)

AWS monitor account configuration.

assumableRoleArn -> (string) [required]

Role ARN to be assumed by AIDevOps to operate on behalf of customer.

Constraints:

min: 1

max: 255

pattern: arn:aws:iam::\d{12}:role/[a-zA-Z0-9+=,.@_/-]+

accountId -> (string) [required]

AWS Account Id corresponding to provided resources.

Constraints:

pattern: \d{12}

accountType -> (string) [required]

Account Type ‘monitor’ for AIDevOps monitoring.

Possible values:

monitor

github -> (structure)

GitHub repository integration configuration.

repoName -> (string) [required]

Associated Github repo name

repoId -> (string) [required]

Associated Github repo ID

owner -> (string) [required]

The GitHub repository owner name.

ownerType -> (string) [required]

Type of GitHub repository owner.

Possible values:

organization

user

instanceIdentifier -> (string)

GitHub instance identifier (e.g., github.com or github.enterprise.com)

slack -> (structure)

Slack workspace integration configuration.

workspaceId -> (string) [required]

Associated Slack workspace ID

Constraints:

pattern: [TE][A-Z0-9]+

workspaceName -> (string) [required]

Associated Slack workspace name

transmissionTarget -> (structure) [required]

Transmission targets for agent notifications

opsOncallTarget -> (structure) [required]

Destination for On-call Agent (Ops1)

channelName -> (string)

Slack channel name

channelId -> (string) [required]

Slack channel ID

Constraints:

min: 8

max: 16

pattern: [CGD][A-Z0-9]+

opsSRETarget -> (structure)

Destination for SRE Agent (Ops1.5)

channelName -> (string)

Slack channel name

channelId -> (string) [required]

Slack channel ID

Constraints:

min: 8

max: 16

pattern: [CGD][A-Z0-9]+

dynatrace -> (structure)

Dynatrace monitoring integration configuration.

envId -> (string) [required]

Dynatrace environment id

resources -> (list)

List of Dynatrace resources to monitor

(string)

servicenow -> (structure)

ServiceNow instance integration configuration.

instanceId -> (string)

ServiceNow instance ID

authScopes -> (list)

Scoped down authentication scopes for fine grained control

(string)

mcpservernewrelic -> (structure)

NewRelic instance integration configuration.

accountId -> (string) [required]

New Relic Account ID

Constraints:

min: 6

pattern: [0-9]+

endpoint -> (string) [required]

MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)

Constraints:

pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)?

gitlab -> (structure)

GitLab project integration configuration.

projectId -> (string) [required]

GitLab numeric project ID.

projectPath -> (string) [required]

Full GitLab project path (e.g., namespace/project-name).

instanceIdentifier -> (string)

GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)

eventChannel -> (structure)

Event Channel instance integration configuration.

azure -> (structure)

Azure subscription integration configuration.

subscriptionId -> (string) [required]

Azure subscription ID corresponding to provided resources.

azuredevops -> (structure)

Azure DevOps project integration configuration.

organizationName -> (string) [required]

Azure DevOps organization name.

projectId -> (string) [required]

Azure DevOps project ID.

projectName -> (string) [required]

Azure DevOps project name.

mcpservergrafana -> (structure)

Grafana MCP server integration configuration.

endpoint -> (string) [required]

Grafana instance URL (e.g., https://your-instance.grafana.net)

Constraints:

pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)?

organizationId -> (string)

The Grafana organization ID that can be used.

Constraints:

pattern: [0-9]+

tools -> (list)

List of MCP tools that can be used.

(string)

Constraints:

pattern: [a-zA-Z0-9_-]+

pagerduty -> (structure)

PagerDuty integration configuration

services -> (list) [required]

List of Pagerduty service available for the association.

(string)

customerEmail -> (string) [required]

Email to be used in Pagerduty API header

Constraints:

pattern: [a-zA-Z0-9._%+\-]+@[a-zA-Z0-9.\-]+\.[a-zA-Z]{2,}

Table of Contents

Feedback

User Guide

list-associations¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note