list-connectors¶

Description¶

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

Synopsis¶

  list-connectors
[--filter-criteria <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--filter-criteria (structure)

The filter criteria to apply to the list of connectors.

connectorArns -> (list)

Filter by connector ARNs.

Constraints:

min: 0

max: 25

(structure)

A filter that matches connectors by connector ARN.

comparison -> (string) [required]

The comparison operator for the connector ARN filter.

Possible values:

EQUALS

value -> (string) [required]

The connector ARN value to filter by.

Constraints:

min: 1

max: 256

pattern: arn:aws(-[a-z]+)*:inspector2:[a-z0-9-]+:[0-9]{12}:connector/([a-f0-9-]+|aws-service-connector/.+/[a-f0-9-]+)

accounts -> (list)

Filter by Amazon Web Services account IDs.

Constraints:

min: 1

max: 10

(structure)

An object that describes the details of a string filter.

comparison -> (string) [required]

The operator to use when comparing values in the filter.

Possible values:

EQUALS

PREFIX

NOT_EQUALS

value -> (string) [required]

The value to filter on.

Constraints:

min: 1

max: 1024

awsConfigConnectorArns -> (list)

Filter by Amazon Web Services Config connector ARNs.

Constraints:

min: 0

max: 1

(structure)

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.

Possible values:

EQUALS

value -> (string) [required]

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

Constraints:

min: 1

max: 512

pattern: arn:([^:]+):config:([^:]+):([^:]+):connector/([^/]+)/([^/]+)/([^/:\s]+)

connectorType -> (list)

Filter by connector type.

Constraints:

min: 0

max: 1

(structure)

A filter that matches connectors by connector type.

comparison -> (string) [required]

The comparison operator for the connector type filter.

Possible values:

EQUALS

value -> (string) [required]

The connector type value to filter by.

Possible values:

CUSTOMER_MANAGED

SERVICE_LINKED

provider -> (list)

Filter by cloud provider.

Constraints:

min: 0

max: 1

(structure)

A filter that matches connectors by cloud provider.

comparison -> (string) [required]

The comparison operator for the provider filter.

Possible values:

EQUALS

value -> (string) [required]

The cloud provider value to filter by.

Possible values:

AZURE

Shorthand Syntax:

connectorArns=[{comparison=string,value=string},{comparison=string,value=string}],accounts=[{comparison=string,value=string},{comparison=string,value=string}],awsConfigConnectorArns=[{comparison=string,value=string},{comparison=string,value=string}],connectorType=[{comparison=string,value=string},{comparison=string,value=string}],provider=[{comparison=string,value=string},{comparison=string,value=string}]

JSON Syntax:

{
  "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"
    }
    ...
  ]
}

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

items -> (list)

A list of connectors.

(structure)

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

connectorArn -> (string) [required]

The Amazon Resource Name (ARN) of the connector.

Constraints:

min: 1

max: 256

pattern: arn:aws(-[a-z]+)*:inspector2:[a-z0-9-]+:[0-9]{12}:connector/([a-f0-9-]+|aws-service-connector/.+/[a-f0-9-]+)

name -> (string)

The name of the connector.

Constraints:

min: 1

max: 50

pattern: [\p{L}\p{N}_-]+

description -> (string)

A description of the connector.

Constraints:

min: 0

max: 200

pattern: [^\p{C}]*

provider -> (string) [required]

The cloud provider for the connector.

Possible values:

AZURE

enablementStatus -> (string)

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

Possible values:

ENABLED

PENDING_ENABLEMENT

FAILED_TO_ENABLE

PENDING_UPDATE

FAILED_TO_UPDATE

PENDING_DELETION

DELETED

FAILED_TO_DELETE

enablementStatusReason -> (string)

Additional information about the current enablement status of the connector.

health -> (structure)

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

connectorStatus -> (string) [required]

The health status of the connector.

Possible values:

CONNECTED

DEGRADED

FAILED_TO_CONNECT

PENDING_AUTHORIZATION

PENDING_CONFIGURATION

UNKNOWN

lastCheckedAt -> (timestamp) [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 -> (timestamp) [required]

The date and time when the connector was created.

updatedAt -> (timestamp) [required]

The date and time when the connector was last updated.

azureRegions -> (list)

The Azure regions configured for the connector.

Constraints:

min: 1

max: 100

(string)

Constraints:

min: 1

max: 64

pattern: [a-zA-Z0-9-]+

awsConfigConnectorArn -> (string)

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

Constraints:

min: 1

max: 512

pattern: arn:([^:]+):config:([^:]+):([^:]+):connector/([^/]+)/([^/]+)/([^/:\s]+)

scopeConfiguration -> (structure)

The Azure scope configuration for the connector.

vmScanning -> (structure)

The scope configuration for VM scanning.

scopeType -> (string) [required]

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.

Possible values:

TENANT

SUBSCRIPTION

scopeValues -> (list)

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

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 36

max: 36

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

state -> (string)

The current state of the scope configuration.

Possible values:

ACTIVE

PENDING

ERROR

DISABLED

stateReason -> (string)

The reason for the current state of the scope configuration.

containerImageScanning -> (structure)

The scope configuration for container image scanning.

scopeType -> (string) [required]

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.

Possible values:

TENANT

SUBSCRIPTION

scopeValues -> (list)

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

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 36

max: 36

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

state -> (string)

The current state of the scope configuration.

Possible values:

ACTIVE

PENDING

ERROR

DISABLED

stateReason -> (string)

The reason for the current state of the scope configuration.

serverlessScanning -> (structure)

The scope configuration for serverless scanning.

scopeType -> (string) [required]

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.

Possible values:

TENANT

SUBSCRIPTION

scopeValues -> (list)

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

Constraints:

min: 0

max: 100

(string)

Constraints:

min: 36

max: 36

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

state -> (string)

The current state of the scope configuration.

Possible values:

ACTIVE

PENDING

ERROR

DISABLED

stateReason -> (string)

The reason for the current state of the scope configuration.

tags -> (map)

The tags associated with the connector.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 128

pattern: (?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*

value -> (string)

Constraints:

min: 0

max: 256

autoInstallVMScanner -> (boolean)

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

nextToken -> (string)

A pagination token. If this value is not null, there are additional results available. Use this token in the nextToken parameter of a subsequent request to retrieve the next page of results.

Constraints:

min: 1

max: 1024

Table of Contents

Feedback

User Guide