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

ListConnectors

List Connectors.

Request Syntax


POST /ListConnectors HTTP/1.1
Content-type: application/json

{
   "filters": { 
      "connectorIDs": [ "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.

filters

List Connectors Request filters.

Type: ListConnectorsRequestFilters object

Required: No

maxResults

List Connectors Request max results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

List Connectors Request next token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "items": [ 
      { 
         "arn": "string",
         "connectorID": "string",
         "name": "string",
         "ssmCommandConfig": { 
            "cloudWatchLogGroupName": "string",
            "cloudWatchOutputEnabled": boolean,
            "outputS3BucketName": "string",
            "s3OutputEnabled": boolean
         },
         "ssmInstanceID": "string",
         "tags": { 
            "string" : "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

List connectors response items.

Type: Array of Connector objects

nextToken

List connectors response next token.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Errors

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

UninitializedAccountException

Uninitialized account exception.

HTTP Status Code: 400

ValidationException

Validate exception.

HTTP Status Code: 400