SecurityAgent / Client / list_integrated_resources

list_integrated_resources

SecurityAgent.Client.list_integrated_resources(**kwargs)

Lists the integrated resources for an agent space

See also: AWS API Documentation

Request Syntax

response = client.list_integrated_resources(
    agentSpaceId='string',
    integrationId='string',
    resourceType='CODE_REPOSITORY',
    nextToken='string',
    maxResults=123
)

Parameters:

• agentSpaceId (string) –

  [REQUIRED]

  Unique identifier of the agent space

• integrationId (string) – Filter integrated resources by a specific integration

• resourceType (string) – Filter integrated resources by resource type

• nextToken (string) – Token for pagination

• maxResults (integer) – Maximum number of results to return

Return type:

dict

Returns:

Response Syntax

{
    'integratedResourceSummaries': [
        {
            'integrationId': 'string',
            'resource': {
                'githubRepository': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'owner': 'string',
                    'accessType': 'PRIVATE'|'PUBLIC'
                }
            },
            'capabilities': {
                'github': {
                    'leaveComments': True|False,
                    'remediateCode': True|False
                }
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • integratedResourceSummaries (list) –

    List of integrated resources

    • (dict) –

      Summary information about an integrated resource

      • integrationId (string) –

        Unique identifier of the integration

      • resource (dict) –

        The integrated resource details

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: githubRepository. 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'}
        

        • githubRepository (dict) –

          Metadata for a GitHub repository resource

          • name (string) –

            Name of the resource e.g. repository name, etc

          • providerResourceId (string) –

            Unique resource identifier from the vendor

          • owner (string) –

            Owner of the repository

          • accessType (string) –

            Access / Visibility Type of the integrated resource

      • capabilities (dict) –

        Capabilities of the integrated resource

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: github. 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'}
        

        • github (dict) –

          Capabilities for GitHub repositories

          • leaveComments (boolean) –

            Post code review comments on pull requests

          • remediateCode (boolean) –

            Create pull requests with automated fixes

  • nextToken (string) –

    Token for pagination to retrieve the next set of results

Exceptions

• SecurityAgent.Client.exceptions.ResourceNotFoundException

• SecurityAgent.Client.exceptions.InternalServerException

• SecurityAgent.Client.exceptions.ValidationException

• SecurityAgent.Client.exceptions.ThrottlingException

• SecurityAgent.Client.exceptions.AccessDeniedException