Lists connectors in your account¶

Description¶

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

Usage¶

inspector2_list_connectors(maxResults, nextToken, filterCriteria)

Arguments¶

maxResults

The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the nextToken value returned from this request.

nextToken

A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

filterCriteria

The filter criteria to apply to the list of connectors.

Value¶

A list with the following syntax:

list(
  items = list(
    list(
      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 = list(
        connectorStatus = "CONNECTED"|"DEGRADED"|"FAILED_TO_CONNECT"|"PENDING_AUTHORIZATION"|"PENDING_CONFIGURATION"|"UNKNOWN",
        lastCheckedAt = as.POSIXct(
          "2015-01-01"
        ),
        message = "string"
      ),
      createdAt = as.POSIXct(
        "2015-01-01"
      ),
      updatedAt = as.POSIXct(
        "2015-01-01"
      ),
      azureRegions = list(
        "string"
      ),
      awsConfigConnectorArn = "string",
      scopeConfiguration = list(
        vmScanning = list(
          scopeType = "TENANT"|"SUBSCRIPTION",
          scopeValues = list(
            "string"
          ),
          state = "ACTIVE"|"PENDING"|"ERROR"|"DISABLED",
          stateReason = "string"
        ),
        containerImageScanning = list(
          scopeType = "TENANT"|"SUBSCRIPTION",
          scopeValues = list(
            "string"
          ),
          state = "ACTIVE"|"PENDING"|"ERROR"|"DISABLED",
          stateReason = "string"
        ),
        serverlessScanning = list(
          scopeType = "TENANT"|"SUBSCRIPTION",
          scopeValues = list(
            "string"
          ),
          state = "ACTIVE"|"PENDING"|"ERROR"|"DISABLED",
          stateReason = "string"
        )
      ),
      tags = list(
        "string"
      ),
      autoInstallVMScanner = TRUE|FALSE
    )
  ),
  nextToken = "string"
)

Request syntax¶

svc$list_connectors(
  maxResults = 123,
  nextToken = "string",
  filterCriteria = list(
    connectorArns = list(
      list(
        comparison = "EQUALS",
        value = "string"
      )
    ),
    accounts = list(
      list(
        comparison = "EQUALS"|"PREFIX"|"NOT_EQUALS",
        value = "string"
      )
    ),
    awsConfigConnectorArns = list(
      list(
        comparison = "EQUALS",
        value = "string"
      )
    ),
    connectorType = list(
      list(
        comparison = "EQUALS",
        value = "CUSTOMER_MANAGED"|"SERVICE_LINKED"
      )
    ),
    provider = list(
      list(
        comparison = "EQUALS",
        value = "AZURE"
      )
    )
  )
)