DevOpsAgentService / Paginator / ListAssociations

ListAssociations

class DevOpsAgentService.Paginator.ListAssociations

paginator = client.get_paginator('list_associations')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DevOpsAgentService.Client.list_associations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentSpaceId='string',
    filterServiceTypes='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the AgentSpace

• filterServiceTypes (string) – A comma-separated list of service types to filter list associations output

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'associations': [
        {
            'agentSpaceId': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'status': 'valid'|'invalid'|'pending-confirmation',
            'associationId': 'string',
            'serviceId': 'string',
            'configuration': {
                'sourceAws': {
                    'accountId': 'string',
                    'accountType': 'source',
                    'assumableRoleArn': 'string',
                    'externalId': 'string',
                    'agentElevatedRoleArn': 'string',
                    'agentElevatedRoleArnStatus': 'valid'|'invalid'|'pending-confirmation'
                },
                'aws': {
                    'assumableRoleArn': 'string',
                    'accountId': 'string',
                    'accountType': 'monitor',
                    'agentElevatedRoleArn': 'string',
                    'agentElevatedRoleArnStatus': 'valid'|'invalid'|'pending-confirmation'
                },
                'github': {
                    'repoName': 'string',
                    'repoId': 'string',
                    'owner': 'string',
                    'ownerType': 'organization'|'user',
                    'instanceIdentifier': 'string',
                    'runtimeRoleArn': 'string'
                },
                'slack': {
                    'workspaceId': 'string',
                    'workspaceName': 'string',
                    'transmissionTarget': {
                        'opsOncallTarget': {
                            'channelName': 'string',
                            'channelId': 'string'
                        },
                        'opsSRETarget': {
                            'channelName': 'string',
                            'channelId': 'string'
                        }
                    }
                },
                'dynatrace': {
                    'envId': 'string',
                    'resources': [
                        'string',
                    ]
                },
                'servicenow': {
                    'instanceId': 'string',
                    'authScopes': [
                        'string',
                    ]
                },
                'mcpservernewrelic': {
                    'accountId': 'string',
                    'endpoint': 'string'
                },
                'mcpserverdatadog': {
                    'enabledElevatedTools': [
                        {
                            'name': 'string',
                            'toolClassification': 'READ_ONLY'|'MUTATIVE'|'DESTRUCTIVE'
                        },
                    ]
                },
                'mcpserver': {
                    'tools': [
                        'string',
                    ],
                    'toolDetails': [
                        {
                            'name': 'string',
                            'toolClassification': 'READ_ONLY'|'MUTATIVE'|'DESTRUCTIVE'
                        },
                    ]
                },
                'gitlab': {
                    'projectId': 'string',
                    'projectPath': 'string',
                    'instanceIdentifier': 'string',
                    'runtimeRoleArn': 'string'
                },
                'mcpserversplunk': {},
                'eventChannel': {},
                'azure': {
                    'subscriptionId': 'string'
                },
                'azuredevops': {
                    'organizationName': 'string',
                    'projectId': 'string',
                    'projectName': 'string'
                },
                'mcpservergrafana': {
                    'endpoint': 'string',
                    'organizationId': 'string',
                    'tools': [
                        'string',
                    ],
                    'enabledElevatedTools': [
                        {
                            'name': 'string',
                            'toolClassification': 'READ_ONLY'|'MUTATIVE'|'DESTRUCTIVE'
                        },
                    ]
                },
                'pagerduty': {
                    'services': [
                        'string',
                    ],
                    'customerEmail': 'string'
                },
                'mcpserversigv4': {
                    'tools': [
                        'string',
                    ],
                    'toolDetails': [
                        {
                            'name': 'string',
                            'toolClassification': 'READ_ONLY'|'MUTATIVE'|'DESTRUCTIVE'
                        },
                    ]
                },
                'remoteagent': {},
                'remoteagentsigv4': {}
            },
            'capabilities': {
                'string': {
                    'enabled': True|False
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Output containing a list of service associations and pagination token.

  • associations (list) –

    The list of associations.

    • (dict) –

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

      • agentSpaceId (string) –

        The unique identifier of the AgentSpace

      • createdAt (datetime) –

        The timestamp when the resource was created.

      • updatedAt (datetime) –

        The timestamp when the resource was last updated.

      • status (string) –

        Validation status

      • associationId (string) –

        The unique identifier of the given association.

      • serviceId (string) –

        The identifier for associated service

      • configuration (dict) –

        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 will be set: sourceAws, aws, github, slack, dynatrace, servicenow, mcpservernewrelic, mcpserverdatadog, mcpserver, gitlab, mcpserversplunk, eventChannel, azure, azuredevops, mcpservergrafana, pagerduty, mcpserversigv4, remoteagent, remoteagentsigv4. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • sourceAws (dict) –

          AWS source account configuration for monitoring resources.

          • accountId (string) –

            AWS Account Id corresponding to provided resources.

          • accountType (string) –

            Account Type ‘source’ for AIDevOps monitoring.

          • assumableRoleArn (string) –

            Role ARN to be assumed by AIDevOps to operate on behalf of customer. To set this role ARN on AssociateService or UpdateAssociation, the caller must have at least the iam:PassRole permission on arn:aws:iam::<account-id>:role/* in the caller’s own account, with the condition iam:PassedToService set to aidevops.amazonaws.com. A broader iam:PassRole grant also satisfies this requirement.

          • externalId (string) –

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

          • agentElevatedRoleArn (string) –

            Optional IAM role ARN to be assumed by AIDevOps for elevated directed actions on behalf of the customer. Used for mutating operations gated by elevatedActionsEnabled on the AgentSpace. When not provided, only non-elevated directed actions are available for this AWS account. Setting this role is subject to the same minimum iam:PassRole requirement described on assumableRoleArn.

          • agentElevatedRoleArnStatus (string) –

            Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).

        • aws (dict) –

          AWS monitor account configuration.

          • assumableRoleArn (string) –

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

          • accountId (string) –

            AWS Account Id corresponding to provided resources.

          • accountType (string) –

            Account Type ‘monitor’ for AIDevOps monitoring.

          • agentElevatedRoleArn (string) –

            Optional IAM role ARN to be assumed by AIDevOps for elevated directed actions on behalf of the customer. Used for mutating operations gated by elevatedActionsEnabled on the AgentSpace. When not provided, only non-elevated directed actions are available for this AWS account.

          • agentElevatedRoleArnStatus (string) –

            Validation status of the agentElevatedRoleArn. Updated asynchronously after the customer registers an elevated role. Possible values: PENDING_CONFIRMATION (validation in progress), VALID (role validated), INVALID (validation failed).

        • github (dict) –

          GitHub repository integration configuration.

          • repoName (string) –

            Associated Github repo name

          • repoId (string) –

            Associated Github repo ID

          • owner (string) –

            The GitHub repository owner name.

          • ownerType (string) –

            Type of GitHub repository owner.

          • instanceIdentifier (string) –

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

          • runtimeRoleArn (string) –

            Optional role ARN that AIDevOps assumes at runtime for automatic verification testing and VPC connectivity on this association.

        • slack (dict) –

          Slack workspace integration configuration.

          • workspaceId (string) –

            Associated Slack workspace ID

          • workspaceName (string) –

            Associated Slack workspace name

          • transmissionTarget (dict) –

            Transmission targets for agent notifications

            • opsOncallTarget (dict) –

              Destination for On-call Agent (Ops1)

              • channelName (string) –

                Slack channel name

              • channelId (string) –

                Slack channel ID

            • opsSRETarget (dict) –

              Destination for SRE Agent (Ops1.5)

              • channelName (string) –

                Slack channel name

              • channelId (string) –

                Slack channel ID

        • dynatrace (dict) –

          Dynatrace monitoring integration configuration.

          • envId (string) –

            Dynatrace environment id

          • resources (list) –

            List of Dynatrace resources to monitor

            • (string) –

        • servicenow (dict) –

          ServiceNow instance integration configuration.

          • instanceId (string) –

            ServiceNow instance ID

          • authScopes (list) –

            Scoped down authentication scopes for fine grained control

            • (string) –

        • mcpservernewrelic (dict) –

          NewRelic instance integration configuration.

          • accountId (string) –

            New Relic Account ID

          • endpoint (string) –

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

        • mcpserverdatadog (dict) –

          Datadog MCP server integration configuration.

          • enabledElevatedTools (list) –

            The subset of elevated-access tools enabled for this integration.

            • (dict) –

              An MCP tool together with its access categorization.

              • name (string) –

                The name of the MCP tool.

              • toolClassification (string) –

                The access categorization of the MCP tool.

        • mcpserver (dict) –

          MCP (Model Context Protocol) server integration configuration.

          • tools (list) –

            List of MCP tools can be used with the association.

            • (string) –

          • toolDetails (list) –

            List of MCP tools with their access categorization. When provided, the tool names must match those in the tools member.

            • (dict) –

              An MCP tool together with its access categorization.

              • name (string) –

                The name of the MCP tool.

              • toolClassification (string) –

                The access categorization of the MCP tool.

        • gitlab (dict) –

          GitLab project integration configuration.

          • projectId (string) –

            GitLab numeric project ID.

          • projectPath (string) –

            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)

          • runtimeRoleArn (string) –

            Optional role ARN that AIDevOps assumes at runtime for automatic verification testing and VPC connectivity on this association.

        • mcpserversplunk (dict) –

          Splunk MCP server integration configuration.

        • eventChannel (dict) –

          Event Channel instance integration configuration.

        • azure (dict) –

          Azure subscription integration configuration.

          • subscriptionId (string) –

            Azure subscription ID corresponding to provided resources.

        • azuredevops (dict) –

          Azure DevOps project integration configuration.

          • organizationName (string) –

            Azure DevOps organization name.

          • projectId (string) –

            Azure DevOps project ID.

          • projectName (string) –

            Azure DevOps project name.

        • mcpservergrafana (dict) –

          Grafana MCP server integration configuration.

          • endpoint (string) –

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

          • organizationId (string) –

            The Grafana organization ID that can be used.

          • tools (list) –

            List of MCP tools that can be used.

            • (string) –

          • enabledElevatedTools (list) –

            The subset of elevated-access tools enabled for this integration.

            • (dict) –

              An MCP tool together with its access categorization.

              • name (string) –

                The name of the MCP tool.

              • toolClassification (string) –

                The access categorization of the MCP tool.

        • pagerduty (dict) –

          PagerDuty integration configuration

          • services (list) –

            List of Pagerduty service available for the association.

            • (string) –

          • customerEmail (string) –

            Email to be used in Pagerduty API header

        • mcpserversigv4 (dict) –

          SigV4-authenticated MCP server integration configuration.

          • tools (list) –

            List of MCP tools available for the association.

            • (string) –

          • toolDetails (list) –

            List of MCP tools with their access categorization. When provided, the tool names must match those in the tools member.

            • (dict) –

              An MCP tool together with its access categorization.

              • name (string) –

                The name of the MCP tool.

              • toolClassification (string) –

                The access categorization of the MCP tool.

        • remoteagent (dict) –

          Remote A2A agent integration configuration (token-based auth).

        • remoteagentsigv4 (dict) –

          Remote A2A agent integration configuration (SigV4 auth).

      • capabilities (dict) –

        Enabled capabilities for this association.

        • (string) –

          AWS DevOps Agent capability types representing the set of automated capabilities that can be enabled per association.

          • (dict) –

            Capability configuration for the AWS DevOps Agent.

            • enabled (boolean) –

              Whether the capability is enabled.

  • NextToken (string) –

    A token to resume pagination.