mgn / Client / update_connector

update_connector#

mgn.Client.update_connector(**kwargs)#

Update Connector.

See also: AWS API Documentation

Request Syntax

response = client.update_connector(
    connectorID='string',
    name='string',
    ssmCommandConfig={
        'cloudWatchLogGroupName': 'string',
        'cloudWatchOutputEnabled': True|False,
        'outputS3BucketName': 'string',
        's3OutputEnabled': True|False
    }
)
Parameters:

  • connectorID (string) –

    [REQUIRED]

    Update Connector request connector ID.

  • name (string) – Update Connector request name.

  • ssmCommandConfig (dict) –

    Update Connector request SSM command config.

    • cloudWatchLogGroupName (string) –

      Connector SSM command config CloudWatch log group name.

    • cloudWatchOutputEnabled (boolean) – [REQUIRED]

      Connector SSM command config CloudWatch output enabled.

    • outputS3BucketName (string) –

      Connector SSM command config output S3 bucket name.

    • s3OutputEnabled (boolean) – [REQUIRED]

      Connector SSM command config S3 output enabled.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'connectorID': 'string',
    'name': 'string',
    'ssmCommandConfig': {
        'cloudWatchLogGroupName': 'string',
        'cloudWatchOutputEnabled': True|False,
        'outputS3BucketName': 'string',
        's3OutputEnabled': True|False
    },
    'ssmInstanceID': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) –

    • arn (string) –

      Connector arn.

    • connectorID (string) –

      Connector ID.

    • name (string) –

      Connector name.

    • ssmCommandConfig (dict) –

      Connector SSM command config.

      • cloudWatchLogGroupName (string) –

        Connector SSM command config CloudWatch log group name.

      • cloudWatchOutputEnabled (boolean) –

        Connector SSM command config CloudWatch output enabled.

      • outputS3BucketName (string) –

        Connector SSM command config output S3 bucket name.

      • s3OutputEnabled (boolean) –

        Connector SSM command config S3 output enabled.

    • ssmInstanceID (string) –

      Connector SSM instance ID.

    • tags (dict) –

      Connector tags.

      • (string) –

        • (string) –

Exceptions