Skip to content

Lists the CSPM connectors and their metadata for the calling account

Description

Lists the CSPM connectors and their metadata for the calling account.

Usage

securityhub_list_connectors(NextToken, MaxResults, ProviderName,
  ConnectorStatus, EnablementStatus)

Arguments

  • NextToken

    The pagination token to request the next page of results.

  • MaxResults

    The maximum number of results to return.

  • ProviderName

    The name of the cloud provider to filter connectors by.

  • ConnectorStatus

    The connectivity status to filter connectors by.

  • EnablementStatus

    The enablement status to filter connectors by.

Value

A list with the following syntax:

list(
  NextToken = "string",
  Connectors = list(
    list(
      ConnectorArn = "string",
      ConnectorId = "string",
      Name = "string",
      Description = "string",
      ProviderSummary = list(
        ProviderName = "AZURE",
        ConnectorStatus = "CONNECTED"|"DEGRADED"|"FAILED_TO_CONNECT"|"UNKNOWN",
        ProviderConfiguration = list(
          Azure = list(
            AWSConfigConnectorArn = "string",
            ScopeConfiguration = list(
              ScopeType = "TENANT"|"SUBSCRIPTION",
              ScopeValues = list(
                "string"
              )
            ),
            AzureRegions = list(
              "string"
            )
          )
        )
      ),
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = "string",
      EnablementStatus = "ENABLED"|"PENDING_ENABLEMENT"|"PENDING_UPDATE"|"PENDING_DELETION"
    )
  )
)

Request syntax

svc$list_connectors(
  NextToken = "string",
  MaxResults = 123,
  ProviderName = "AZURE",
  ConnectorStatus = "CONNECTED"|"DEGRADED"|"FAILED_TO_CONNECT"|"UNKNOWN",
  EnablementStatus = "ENABLED"|"PENDING_ENABLEMENT"|"PENDING_UPDATE"|"PENDING_DELETION"
)