---
title: "POST /connector/list"
method: POST
path: "/connector/list"
---

# POST /connector/list

`POST /connector/list`

Lists connectors in your account. Results are paginated. Use the <code>nextToken</code> parameter to retrieve the next page of results.

## Request body

- object
  - `maxResults` integer — The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the <code>nextToken</code> value returned from this request.
  - `nextToken` string, password — A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request.
  - `filterCriteria` object — Contains the filter criteria for narrowing the results returned by a <code>ListConnectors</code> request. You can filter by connector ARN, Amazon Web Services account ID, Amazon Web Services Config connector ARN, connector type, or cloud provider.
    - `connectorArns` ConnectorArnFilter[] — Filter by connector ARNs.
      - `comparison` 'EQUALS', required — The comparison operator for the connector ARN filter.
      - `value` string, required — The connector ARN value to filter by.
    - `accounts` StringFilter[] — Filter by Amazon Web Services account IDs.
      - `comparison` 'EQUALS' | 'PREFIX' | 'NOT_EQUALS', required — The operator to use when comparing values in the filter.
      - `value` string, required — The value to filter on.
    - `awsConfigConnectorArns` AwsConfigConnectorArnFilter[] — Filter by Amazon Web Services Config connector ARNs.
      - `comparison` 'EQUALS', 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` ConnectorTypeFilter[] — Filter by connector type.
      - `comparison` 'EQUALS', required — The comparison operator for the connector type filter.
      - `value` 'CUSTOMER_MANAGED' | 'SERVICE_LINKED', required — The connector type value to filter by.
    - `provider` ProviderFilter[] — Filter by cloud provider.
      - `comparison` 'EQUALS', required — The comparison operator for the provider filter.
      - `value` 'AZURE', required — The cloud provider value to filter by.

## Response `200`

Success

- ListConnectorsResponse
  - `items` Connector[], required — A list of connectors.
    - `connectorArn` string, required — The Amazon Resource Name (ARN) of the connector.
    - `name` string — The name of the connector.
    - `description` string — A description of the connector.
    - `provider` 'AZURE', required — The cloud provider for the connector.
    - `enablementStatus` 'ENABLED' | 'PENDING_ENABLEMENT' | 'FAILED_TO_ENABLE' | 'PENDING_UPDATE' | 'FAILED_TO_UPDATE' | 'PENDING_DELETION' | 'DELETED' | 'FAILED_TO_DELETE' — 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` object — The health of the connector, which indicates whether Amazon Inspector can reach and scan the connected resources.
      - `connectorStatus` 'CONNECTED' | 'DEGRADED' | 'FAILED_TO_CONNECT' | 'PENDING_AUTHORIZATION' | 'PENDING_CONFIGURATION' | 'UNKNOWN', required — The health status of the connector.
      - `lastCheckedAt` string, date-time, required — The date and time when the connector health was last checked.
      - `message` string — A message providing additional details about the connector health status.
    - `createdAt` string, date-time, required — The date and time when the connector was created.
    - `updatedAt` string, date-time, required — The date and time when the connector was last updated.
    - `azureRegions` AzureRegion[] — The Azure regions configured for the connector.
    - `awsConfigConnectorArn` string — The ARN of the Amazon Web Services Config connector associated with this connector.
    - `scopeConfiguration` object — The Azure scope configuration for the connector.
      - `vmScanning` object — The scope configuration for VM scanning.
        - `scopeType` 'TENANT' | 'SUBSCRIPTION', required — The type of scope. Valid values are <code>TENANT</code>, which scans all resources in the Azure tenant, and <code>SUBSCRIPTION</code>, which scans only the resources in the specified Azure subscriptions.
        - `scopeValues` ScopeValue[] — The list of scope values. For subscription-level scope, these are Azure subscription IDs.
        - `state` 'ACTIVE' | 'PENDING' | 'ERROR' | 'DISABLED' — The current state of the scope configuration.
        - `stateReason` string — The reason for the current state of the scope configuration.
      - `containerImageScanning` object — The scope configuration for container image scanning.
        - `scopeType` 'TENANT' | 'SUBSCRIPTION', required — The type of scope. Valid values are <code>TENANT</code>, which scans all resources in the Azure tenant, and <code>SUBSCRIPTION</code>, which scans only the resources in the specified Azure subscriptions.
        - `scopeValues` ScopeValue[] — The list of scope values. For subscription-level scope, these are Azure subscription IDs.
        - `state` 'ACTIVE' | 'PENDING' | 'ERROR' | 'DISABLED' — The current state of the scope configuration.
        - `stateReason` string — The reason for the current state of the scope configuration.
      - `serverlessScanning` object — The scope configuration for serverless scanning.
        - `scopeType` 'TENANT' | 'SUBSCRIPTION', required — The type of scope. Valid values are <code>TENANT</code>, which scans all resources in the Azure tenant, and <code>SUBSCRIPTION</code>, which scans only the resources in the specified Azure subscriptions.
        - `scopeValues` ScopeValue[] — The list of scope values. For subscription-level scope, these are Azure subscription IDs.
        - `state` 'ACTIVE' | 'PENDING' | 'ERROR' | 'DISABLED' — The current state of the scope configuration.
        - `stateReason` string — The reason for the current state of the scope configuration.
    - `tags` object — The tags associated with the connector.
    - `autoInstallVMScanner` boolean — Specifies whether the VM scanner is automatically installed on connected resources.
  - `nextToken` string, password — A pagination token. If this value is not null, there are additional results available. Use this token in the <code>nextToken</code> parameter of a subsequent request to retrieve the next page of results.

## Other responses

- `480` — ValidationException
- `481` — AccessDeniedException
- `482` — ThrottlingException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/inspector2.md) · [All operations](https://skmtc.net/aws/apis/inspector2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/inspector2/versions/c51110c7cd43/schema)