SecurityAgent / Client / list_integrated_resources

list_integrated_resources

SecurityAgent.Client.list_integrated_resources(**kwargs)

Lists the integrated resources for an agent space, optionally filtered by integration or resource type.

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]

  The unique identifier of the agent space to list integrated resources for.

• integrationId (string) – The unique identifier of the integration to filter by.

• resourceType (string) – The type of resource to filter by.

• nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

• maxResults (integer) – The maximum number of results to return in a single call.

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) –

    The list of integrated resource summaries.

    • (dict) –

      Contains summary information about an integrated resource.

      • integrationId (string) –

        The unique identifier of the integration that provides access to the resource.

      • resource (dict) –

        The metadata for the integrated resource.

        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) –

          The GitHub repository metadata.

          • name (string) –

            The name of the GitHub repository.

          • providerResourceId (string) –

            The provider-specific resource identifier for the GitHub repository.

          • owner (string) –

            The owner of the GitHub repository.

          • accessType (string) –

            The access type of the GitHub repository. Valid values are PRIVATE and PUBLIC.

      • capabilities (dict) –

        The capabilities enabled for 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) –

          The GitHub-specific resource capabilities.

          • leaveComments (boolean) –

            Indicates whether the integration can leave comments on pull requests.

          • remediateCode (boolean) –

            Indicates whether the integration can create code remediation pull requests.

  • nextToken (string) –

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Exceptions

• SecurityAgent.Client.exceptions.ResourceNotFoundException

• SecurityAgent.Client.exceptions.InternalServerException

• SecurityAgent.Client.exceptions.ValidationException

• SecurityAgent.Client.exceptions.ThrottlingException

• SecurityAgent.Client.exceptions.AccessDeniedException