Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListConnectors

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

Request Syntax


POST /connector/list HTTP/1.1
Content-type: application/json

{
   "filterCriteria": { 
      "accounts": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "awsConfigConnectorArns": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "connectorArns": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "connectorType": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ],
      "provider": [ 
         { 
            "comparison": "string",
            "value": "string"
         }
      ]
   },
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

filterCriteria

The filter criteria to apply to the list of connectors.

Type: ConnectorFilterCriteria object

Required: No

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.

Type: Integer

Required: No

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "autoInstallVMScanner": boolean,
         "awsConfigConnectorArn": "string",
         "azureRegions": [ "string" ],
         "connectorArn": "string",
         "createdAt": "string",
         "description": "string",
         "enablementStatus": "string",
         "enablementStatusReason": "string",
         "health": { 
            "connectorStatus": "string",
            "lastCheckedAt": "string",
            "message": "string"
         },
         "name": "string",
         "provider": "string",
         "scopeConfiguration": { 
            "containerImageScanning": { 
               "scopeType": "string",
               "scopeValues": [ "string" ],
               "state": "string",
               "stateReason": "string"
            },
            "serverlessScanning": { 
               "scopeType": "string",
               "scopeValues": [ "string" ],
               "state": "string",
               "stateReason": "string"
            },
            "vmScanning": { 
               "scopeType": "string",
               "scopeValues": [ "string" ],
               "state": "string",
               "stateReason": "string"
            }
         },
         "tags": { 
            "string" : "string" 
         },
         "updatedAt": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

items

A list of connectors.

Type: Array of Connector objects

nextToken

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Error Types.

AccessDeniedException

You do not have sufficient access to perform this action.

For Enable, you receive this error if you attempt to use a feature in an unsupported AWS Region.

HTTP Status Code: 403

InternalServerException

The request has failed due to an internal failure of the Amazon Inspector service.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ThrottlingException

The limit on the number of requests per second was exceeded.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The request has failed validation due to missing required fields or having invalid inputs.

fields: The fields that failed validation.
reason: The reason for the validation failure.

HTTP Status Code: 400