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

ListCloudConnectors

Returns a list of connectors filtered by its AWS Lambda Amazon Resource Name (ARN) and type.

Request Syntax


GET /cloud-connectors?LambdaArn=LambdaArn&MaxResults=MaxResults&NextToken=NextToken&Type=Type HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

LambdaArn

The Amazon Resource Name (ARN) of the Lambda function to filter cloud connectors by.

Pattern: (arn:aws:lambda:[0-9a-zA-Z-]+:[0-9]+:function:)?([a-zA-Z0-9-_]+(:(\$LATEST|[a-zA-Z0-9-_]+))?)

MaxResults

The maximum number of results to return at one time.

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

NextToken

A token that can be used to retrieve the next set of results.

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

Pattern: [a-zA-Z0-9=_-]+

Type

The type of cloud connectors to filter by when listing available connectors.

Valid Values: LISTED | UNLISTED

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Items": [ 
      { 
         "Description": "string",
         "EndpointConfig": { 
            "lambda": { 
               "arn": "string"
            }
         },
         "EndpointType": "string",
         "Id": "string",
         "Name": "string",
         "Type": "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

The list of connectors.

Type: Array of ConnectorItem objects

NextToken

A token that can be used to retrieve the next set of results.

Type: String

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

Pattern: [a-zA-Z0-9=_-]+

Errors

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

AccessDeniedException

User is not authorized.

HTTP Status Code: 403

InternalServerException

Internal error from the service that indicates an unexpected error or that the service is unavailable.

HTTP Status Code: 500

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

A validation error occurred when performing the API request.

HTTP Status Code: 400