UpdateConnectorCommand

Suggest an Edit

Update Connector.

Example Syntax

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

import { MgnClient, UpdateConnectorCommand } from "@aws-sdk/client-mgn"; // ES Modules import
// const { MgnClient, UpdateConnectorCommand } = require("@aws-sdk/client-mgn"); // CommonJS import
const client = new MgnClient(config);
const input = { // UpdateConnectorRequest
  connectorID: "STRING_VALUE", // required
  name: "STRING_VALUE",
  ssmCommandConfig: { // ConnectorSsmCommandConfig
    s3OutputEnabled: true || false, // required
    outputS3BucketName: "STRING_VALUE",
    cloudWatchOutputEnabled: true || false, // required
    cloudWatchLogGroupName: "STRING_VALUE",
  },
};
const command = new UpdateConnectorCommand(input);
const response = await client.send(command);
// { // Connector
//   connectorID: "STRING_VALUE",
//   name: "STRING_VALUE",
//   ssmInstanceID: "STRING_VALUE",
//   arn: "STRING_VALUE",
//   tags: { // TagsMap
//     "<keys>": "STRING_VALUE",
//   },
//   ssmCommandConfig: { // ConnectorSsmCommandConfig
//     s3OutputEnabled: true || false, // required
//     outputS3BucketName: "STRING_VALUE",
//     cloudWatchOutputEnabled: true || false, // required
//     cloudWatchLogGroupName: "STRING_VALUE",
//   },
// };

UpdateConnectorCommand Input

See UpdateConnectorCommandInput for more details

Parameter
Type
Description
connectorID
Required
string | undefined

Update Connector request connector ID.

name
string | undefined

Update Connector request name.

ssmCommandConfig
ConnectorSsmCommandConfig | undefined

Update Connector request SSM command config.

UpdateConnectorCommand Output

See UpdateConnectorCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
arn
string | undefined

Connector arn.

connectorID
string | undefined

Connector ID.

name
string | undefined

Connector name.

ssmCommandConfig
ConnectorSsmCommandConfig | undefined

Connector SSM command config.

ssmInstanceID
string | undefined

Connector SSM instance ID.

tags
Record<string, string> | undefined

Connector tags.

Throws

Name
Fault
Details
ResourceNotFoundException
client

Resource not found exception.

UninitializedAccountException
client

Uninitialized account exception.

ValidationException
client

Validate exception.

MgnServiceException
Base exception class for all service exceptions from Mgn service.