ListConnectorsCommand

Suggest an Edit

Lists the connectors for the specified Region.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TransferClient, ListConnectorsCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, ListConnectorsCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // ListConnectorsRequest
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListConnectorsCommand(input);
const response = await client.send(command);
// { // ListConnectorsResponse
//   NextToken: "STRING_VALUE",
//   Connectors: [ // ListedConnectors // required
//     { // ListedConnector
//       Arn: "STRING_VALUE",
//       ConnectorId: "STRING_VALUE",
//       Url: "STRING_VALUE",
//     },
//   ],
// };

ListConnectorsCommand Input

See ListConnectorsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

The maximum number of items to return.

NextToken
string | undefined

When you can get additional results from the ListConnectors call, a NextToken parameter is returned in the output. You can then pass in a subsequent command to the NextToken parameter to continue listing additional connectors.

ListConnectorsCommand Output

See ListConnectorsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Connectors
Required
ListedConnector[] | undefined

Returns an array, where each item contains the details of a connector.

NextToken
string | undefined

Returns a token that you can use to call ListConnectors again and receive additional results, if there are any.

Throws

Name
Fault
Details
InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidNextTokenException
client

The NextToken parameter that was passed is invalid.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

TransferServiceException
Base exception class for all service exceptions from Transfer service.