DescribeConnectorCommand

Suggest an Edit

Describes the connector that's identified by the ConnectorId.

Example Syntax

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

import { TransferClient, DescribeConnectorCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, DescribeConnectorCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // DescribeConnectorRequest
  ConnectorId: "STRING_VALUE", // required
};
const command = new DescribeConnectorCommand(input);
const response = await client.send(command);
// { // DescribeConnectorResponse
//   Connector: { // DescribedConnector
//     Arn: "STRING_VALUE", // required
//     ConnectorId: "STRING_VALUE",
//     Url: "STRING_VALUE",
//     As2Config: { // As2ConnectorConfig
//       LocalProfileId: "STRING_VALUE",
//       PartnerProfileId: "STRING_VALUE",
//       MessageSubject: "STRING_VALUE",
//       Compression: "ZLIB" || "DISABLED",
//       EncryptionAlgorithm: "AES128_CBC" || "AES192_CBC" || "AES256_CBC" || "DES_EDE3_CBC" || "NONE",
//       SigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE",
//       MdnSigningAlgorithm: "SHA256" || "SHA384" || "SHA512" || "SHA1" || "NONE" || "DEFAULT",
//       MdnResponse: "SYNC" || "NONE",
//       BasicAuthSecretId: "STRING_VALUE",
//       PreserveContentType: "ENABLED" || "DISABLED",
//     },
//     AccessRole: "STRING_VALUE",
//     LoggingRole: "STRING_VALUE",
//     Tags: [ // Tags
//       { // Tag
//         Key: "STRING_VALUE", // required
//         Value: "STRING_VALUE", // required
//       },
//     ],
//     SftpConfig: { // SftpConnectorConfig
//       UserSecretId: "STRING_VALUE",
//       TrustedHostKeys: [ // SftpConnectorTrustedHostKeyList
//         "STRING_VALUE",
//       ],
//       MaxConcurrentConnections: Number("int"),
//     },
//     ServiceManagedEgressIpAddresses: [ // ServiceManagedEgressIpAddresses
//       "STRING_VALUE",
//     ],
//     SecurityPolicyName: "STRING_VALUE",
//   },
// };

DescribeConnectorCommand Input

See DescribeConnectorCommandInput for more details

Parameter
Type
Description
ConnectorId
Required
string | undefined

The unique identifier for the connector.

DescribeConnectorCommand Output

See DescribeConnectorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Connector
Required
DescribedConnector | undefined

The structure that contains the details of the connector.

Throws

Name
Fault
Details
InternalServiceError
server

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

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.