Inspector2 / Paginator / ListConnectors

ListConnectors

class Inspector2.Paginator.ListConnectors

paginator = client.get_paginator('list_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Inspector2.Client.list_connectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    filterCriteria={
        'connectorArns': [
            {
                'comparison': 'EQUALS',
                'value': 'string'
            },
        ],
        'accounts': [
            {
                'comparison': 'EQUALS'|'PREFIX'|'NOT_EQUALS',
                'value': 'string'
            },
        ],
        'awsConfigConnectorArns': [
            {
                'comparison': 'EQUALS',
                'value': 'string'
            },
        ],
        'connectorType': [
            {
                'comparison': 'EQUALS',
                'value': 'CUSTOMER_MANAGED'|'SERVICE_LINKED'
            },
        ],
        'provider': [
            {
                'comparison': 'EQUALS',
                'value': 'AZURE'
            },
        ]
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• filterCriteria (dict) –

  The filter criteria to apply to the list of connectors.

  • connectorArns (list) –

    Filter by connector ARNs.

    • (dict) –

      A filter that matches connectors by connector ARN.

      • comparison (string) – [REQUIRED]

        The comparison operator for the connector ARN filter.

      • value (string) – [REQUIRED]

        The connector ARN value to filter by.

  • accounts (list) –

    Filter by Amazon Web Services account IDs.

    • (dict) –

      An object that describes the details of a string filter.

      • comparison (string) – [REQUIRED]

        The operator to use when comparing values in the filter.

      • value (string) – [REQUIRED]

        The value to filter on.

  • awsConfigConnectorArns (list) –

    Filter by Amazon Web Services Config connector ARNs.

    • (dict) –

      A filter that matches connectors by the ARN of the associated Amazon Web Services Config connector.

      • comparison (string) – [REQUIRED]

        The comparison operator for the Amazon Web Services Config connector ARN filter.

      • value (string) – [REQUIRED]

        The Amazon Web Services Config connector ARN value to filter by.

  • connectorType (list) –

    Filter by connector type.

    • (dict) –

      A filter that matches connectors by connector type.

      • comparison (string) – [REQUIRED]

        The comparison operator for the connector type filter.

      • value (string) – [REQUIRED]

        The connector type value to filter by.

  • provider (list) –

    Filter by cloud provider.

    • (dict) –

      A filter that matches connectors by cloud provider.

      • comparison (string) – [REQUIRED]

        The comparison operator for the provider filter.

      • value (string) – [REQUIRED]

        The cloud provider value 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

{
    'items': [
        {
            'connectorArn': 'string',
            'name': 'string',
            'description': 'string',
            'provider': 'AZURE',
            'enablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'FAILED_TO_ENABLE'|'PENDING_UPDATE'|'FAILED_TO_UPDATE'|'PENDING_DELETION'|'DELETED'|'FAILED_TO_DELETE',
            'enablementStatusReason': 'string',
            'health': {
                'connectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'PENDING_AUTHORIZATION'|'PENDING_CONFIGURATION'|'UNKNOWN',
                'lastCheckedAt': datetime(2015, 1, 1),
                'message': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1),
            'azureRegions': [
                'string',
            ],
            'awsConfigConnectorArn': 'string',
            'scopeConfiguration': {
                'vmScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ],
                    'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
                    'stateReason': 'string'
                },
                'containerImageScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ],
                    'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
                    'stateReason': 'string'
                },
                'serverlessScanning': {
                    'scopeType': 'TENANT'|'SUBSCRIPTION',
                    'scopeValues': [
                        'string',
                    ],
                    'state': 'ACTIVE'|'PENDING'|'ERROR'|'DISABLED',
                    'stateReason': 'string'
                }
            },
            'tags': {
                'string': 'string'
            },
            'autoInstallVMScanner': True|False
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    A list of connectors.

    • (dict) –

      Describes a connector that links an external cloud provider to Amazon Inspector for vulnerability scanning.

      • connectorArn (string) –

        The Amazon Resource Name (ARN) of the connector.

      • name (string) –

        The name of the connector.

      • description (string) –

        A description of the connector.

      • provider (string) –

        The cloud provider for the connector.

      • enablementStatus (string) –

        The enablement status of the connector, which indicates whether the connector is active and scanning resources.

      • enablementStatusReason (string) –

        Additional information about the current enablement status of the connector.

      • health (dict) –

        The health of the connector, which indicates whether Amazon Inspector can reach and scan the connected resources.

        • connectorStatus (string) –

          The health status of the connector.

        • lastCheckedAt (datetime) –

          The date and time when the connector health was last checked.

        • message (string) –

          A message providing additional details about the connector health status.

      • createdAt (datetime) –

        The date and time when the connector was created.

      • updatedAt (datetime) –

        The date and time when the connector was last updated.

      • azureRegions (list) –

        The Azure regions configured for the connector.

        • (string) –

      • awsConfigConnectorArn (string) –

        The ARN of the Amazon Web Services Config connector associated with this connector.

      • scopeConfiguration (dict) –

        The Azure scope configuration for the connector.

        • vmScanning (dict) –

          The scope configuration for VM scanning.

          • scopeType (string) –

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

          • state (string) –

            The current state of the scope configuration.

          • stateReason (string) –

            The reason for the current state of the scope configuration.

        • containerImageScanning (dict) –

          The scope configuration for container image scanning.

          • scopeType (string) –

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

          • state (string) –

            The current state of the scope configuration.

          • stateReason (string) –

            The reason for the current state of the scope configuration.

        • serverlessScanning (dict) –

          The scope configuration for serverless scanning.

          • scopeType (string) –

            The type of scope. Valid values are TENANT, which scans all resources in the Azure tenant, and SUBSCRIPTION, which scans only the resources in the specified Azure subscriptions.

          • scopeValues (list) –

            The list of scope values. For subscription-level scope, these are Azure subscription IDs.

            • (string) –

          • state (string) –

            The current state of the scope configuration.

          • stateReason (string) –

            The reason for the current state of the scope configuration.

      • tags (dict) –

        The tags associated with the connector.

        • (string) –

          • (string) –

      • autoInstallVMScanner (boolean) –

        Specifies whether the VM scanner is automatically installed on connected resources.

  • NextToken (string) –

    A token to resume pagination.