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'|'DOCUMENT'|'PROJECT',
    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'
                },
                'gitlabRepository': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'namespace': 'string',
                    'accessType': 'PRIVATE'|'PUBLIC'
                },
                'bitbucketRepository': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'workspace': 'string',
                    'accessType': 'PRIVATE'|'PUBLIC'
                },
                'confluenceDocument': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'spaceKey': 'string',
                    'pageId': 'string',
                    'title': 'string',
                    'spaceTitle': 'string'
                },
                'azureDevOpsRepository': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'organization': 'string',
                    'project': 'string',
                    'projectId': 'string',
                    'accessType': 'PRIVATE'|'PUBLIC'
                },
                'jiraProject': {
                    'name': 'string',
                    'providerResourceId': 'string',
                    'projectKey': 'string',
                    'projectId': 'string',
                    'projectName': 'string'
                }
            },
            'capabilities': {
                'github': {
                    'triggerFilterGroups': [
                        {
                            'events': [
                                'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
                            ],
                            'filters': [
                                {
                                    'type': 'TARGET_BRANCH'|'LABEL',
                                    'patterns': [
                                        'string',
                                    ],
                                    'matchMode': 'INCLUDE'|'EXCLUDE'
                                },
                            ]
                        },
                    ],
                    'leaveComments': True|False,
                    'remediateCode': True|False
                },
                'gitlab': {
                    'triggerFilterGroups': [
                        {
                            'events': [
                                'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
                            ],
                            'filters': [
                                {
                                    'type': 'TARGET_BRANCH'|'LABEL',
                                    'patterns': [
                                        'string',
                                    ],
                                    'matchMode': 'INCLUDE'|'EXCLUDE'
                                },
                            ]
                        },
                    ],
                    'leaveComments': True|False,
                    'remediateCode': True|False
                },
                'bitbucket': {
                    'triggerFilterGroups': [
                        {
                            'events': [
                                'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
                            ],
                            'filters': [
                                {
                                    'type': 'TARGET_BRANCH'|'LABEL',
                                    'patterns': [
                                        'string',
                                    ],
                                    'matchMode': 'INCLUDE'|'EXCLUDE'
                                },
                            ]
                        },
                    ],
                    'leaveComments': True|False,
                    'remediateCode': True|False
                },
                'confluence': {
                    'fetchDocument': True|False,
                    'createDocument': True|False,
                    'updateDocument': True|False
                },
                'azureDevOps': {
                    'triggerFilterGroups': [
                        {
                            'events': [
                                'PULL_REQUEST_READY_FOR_REVIEW'|'PULL_REQUEST_DRAFT'|'PULL_REQUEST_LABEL_ADDED',
                            ],
                            'filters': [
                                {
                                    'type': 'TARGET_BRANCH'|'LABEL',
                                    'patterns': [
                                        'string',
                                    ],
                                    'matchMode': 'INCLUDE'|'EXCLUDE'
                                },
                            ]
                        },
                    ],
                    'leaveComments': True|False,
                    'remediateCode': True|False
                },
                'jira': {
                    'createIssue': True|False,
                    'commentIssue': 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, gitlabRepository, bitbucketRepository, confluenceDocument, azureDevOpsRepository, jiraProject. 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.

        • gitlabRepository (dict) –

          Metadata for an integrated GitLab repository.

          • name (string) –

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

          • providerResourceId (string) –

            Provider Id of the resource e.g. GitHub repository id, etc.

          • namespace (string) –

            The namespace (group or user path) that owns the project.

          • accessType (string) –

            Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.

        • bitbucketRepository (dict) –

          Metadata for an integrated Bitbucket repository.

          • name (string) –

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

          • providerResourceId (string) –

            Provider Id of the resource e.g. GitHub repository id, etc.

          • workspace (string) –

            The workspace slug that owns the repository.

          • accessType (string) –

            Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.

        • confluenceDocument (dict) –

          Metadata for an integrated Confluence document.

          • name (string) –

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

          • providerResourceId (string) –

            Provider Id of the resource e.g. GitHub repository id, etc.

          • spaceKey (string) –

            The Confluence space key containing the document.

          • pageId (string) –

            The Confluence page identifier.

          • title (string) –

            The display title of the Confluence page.

          • spaceTitle (string) –

            The display title of the Confluence space.

        • azureDevOpsRepository (dict) –

          The Azure DevOps repository metadata.

          • name (string) –

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

          • providerResourceId (string) –

            Provider Id of the resource e.g. GitHub repository id, etc.

          • organization (string) –

            The name of the Azure DevOps organization that owns the repository.

          • project (string) –

            The name of the Azure DevOps project that contains the repository.

          • projectId (string) –

            The GUID of the Azure DevOps project that contains the repository.

          • accessType (string) –

            Defines the visibility level of provider resources. PRIVATE indicates restricted access, while PUBLIC indicates open access.

        • jiraProject (dict) –

          The Jira project metadata.

          • name (string) –

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

          • providerResourceId (string) –

            Provider Id of the resource e.g. GitHub repository id, etc.

          • projectKey (string) –

            The Jira project key, for example PROJ.

          • projectId (string) –

            The Jira project identifier.

          • projectName (string) –

            The display name of the Jira project.

      • 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, gitlab, bitbucket, confluence, azureDevOps, jira. 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.

          • triggerFilterGroups (list) –

            The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.

            • (dict) –

              A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.

              • events (list) –

                Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.

                • (string) –

                  A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.

              • filters (list) –

                Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.

                • (dict) –

                  A condition on a pull request value.

                  • type (string) –

                    The pull request value to match.

                  • patterns (list) –

                    The regular expressions to match against the value.

                    • (string) –

                      A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.

                  • matchMode (string) –

                    Whether the value must match the patterns. The default is INCLUDE.

          • leaveComments (boolean) –

            Indicates whether the integration can leave comments on pull requests.

          • remediateCode (boolean) –

            Indicates whether the integration can create code remediation pull requests.

        • gitlab (dict) –

          Capabilities for an integrated GitLab repository.

          • triggerFilterGroups (list) –

            The filter groups that control which merge request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.

            • (dict) –

              A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.

              • events (list) –

                Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.

                • (string) –

                  A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.

              • filters (list) –

                Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.

                • (dict) –

                  A condition on a pull request value.

                  • type (string) –

                    The pull request value to match.

                  • patterns (list) –

                    The regular expressions to match against the value.

                    • (string) –

                      A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.

                  • matchMode (string) –

                    Whether the value must match the patterns. The default is INCLUDE.

          • leaveComments (boolean) –

            Whether to post code review comments on merge request discussions.

          • remediateCode (boolean) –

            Whether to create merge requests with automated fixes.

        • bitbucket (dict) –

          Capabilities for an integrated Bitbucket repository.

          • triggerFilterGroups (list) –

            The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.

            • (dict) –

              A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.

              • events (list) –

                Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.

                • (string) –

                  A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.

              • filters (list) –

                Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.

                • (dict) –

                  A condition on a pull request value.

                  • type (string) –

                    The pull request value to match.

                  • patterns (list) –

                    The regular expressions to match against the value.

                    • (string) –

                      A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.

                  • matchMode (string) –

                    Whether the value must match the patterns. The default is INCLUDE.

          • leaveComments (boolean) –

            Whether to post code review comments on pull requests.

          • remediateCode (boolean) –

            Whether to create pull requests with automated fixes.

        • confluence (dict) –

          Capabilities for an integrated Confluence space.

          • fetchDocument (boolean) –

            Whether to fetch documents from this space.

          • createDocument (boolean) –

            Whether to create documents in this space.

          • updateDocument (boolean) –

            Whether to update documents in this space.

        • azureDevOps (dict) –

          The Azure DevOps-specific resource capabilities.

          • triggerFilterGroups (list) –

            The filter groups that control which pull request events start an automatic code review when leaveComments is enabled. A review starts when any group matches. If you omit this, a review starts on PULL_REQUEST_READY_FOR_REVIEW events.

            • (dict) –

              A set of conditions that start an automatic code review when they all pass. A filter group must include events, filters, or both.

              • events (list) –

                Passes when the pull request event is one of the listed events. If you omit this, the group matches PULL_REQUEST_READY_FOR_REVIEW and PULL_REQUEST_DRAFT events only.

                • (string) –

                  A pull request event that can start an automatic code review. For GitLab repositories, pull request refers to a merge request.

              • filters (list) –

                Passes when every filter passes. If you omit this, the group matches its events on any target branch and with any labels.

                • (dict) –

                  A condition on a pull request value.

                  • type (string) –

                    The pull request value to match.

                  • patterns (list) –

                    The regular expressions to match against the value.

                    • (string) –

                      A regular expression in RE2 syntax that must match the entire value, for example main or release/.*.

                  • matchMode (string) –

                    Whether the value must match the patterns. The default is INCLUDE.

          • leaveComments (boolean) –

            Whether to post code review comments on pull requests.

          • remediateCode (boolean) –

            Whether to create pull requests with automated fixes.

        • jira (dict) –

          The Jira-specific resource capabilities.

          • createIssue (boolean) –

            Whether to create issues in the integrated jira project.

          • commentIssue (boolean) –

            Whether to post comments on issues in the integrated jira project.

  • NextToken (string) –

    A token to resume pagination.