Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . inspector2 ]

list-connectors

Description

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

See also: AWS API Documentation

list-connectors is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: items

Synopsis

  list-connectors
[--filter-criteria <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--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>]
[--v2-debug]

Options

--filter-criteria (structure)

The filter criteria to apply to the list of connectors.

connectorArns -> (list)

Filter by connector ARNs.

(structure)

A filter that matches connectors by connector ARN.

comparison -> (string)

The comparison operator for the connector ARN filter.

value -> (string)

The connector ARN value to filter by.

accounts -> (list)

Filter by Amazon Web Services account IDs.

(structure)

An object that describes the details of a string filter.

comparison -> (string)

The operator to use when comparing values in the filter.

value -> (string)

The value to filter on.

awsConfigConnectorArns -> (list)

Filter by Amazon Web Services Config connector ARNs.

(structure)

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

comparison -> (string)

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

value -> (string)

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

connectorType -> (list)

Filter by connector type.

(structure)

A filter that matches connectors by connector type.

comparison -> (string)

The comparison operator for the connector type filter.

value -> (string)

The connector type value to filter by.

provider -> (list)

Filter by cloud provider.

(structure)

A filter that matches connectors by cloud provider.

comparison -> (string)

The comparison operator for the provider filter.

value -> (string)

The cloud provider value to filter by.

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

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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 .

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

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)

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 -> (structure)

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 -> (timestamp)

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)

The date and time when the connector was created.

updatedAt -> (timestamp)

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 -> (structure)

The Azure scope configuration for the connector.

vmScanning -> (structure)

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 -> (structure)

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 -> (structure)

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 -> (map)

The tags associated with the connector.

key -> (string)

value -> (string)

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.