SecurityAgent / Paginator / ListIntegratedResources

ListIntegratedResources

class SecurityAgent.Paginator.ListIntegratedResources

paginator = client.get_paginator('list_integrated_resources')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SecurityAgent.Client.list_integrated_resources().

See also: AWS API Documentation

Request Syntax

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

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.

• 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

{
    '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 resume pagination.