mgn / Client / list_connectors

list_connectors#

mgn.Client.list_connectors(**kwargs)#

List Connectors.

See also: AWS API Documentation

Request Syntax

response = client.list_connectors(
    filters={
        'connectorIDs': [
            'string',
        ]
    },
    maxResults=123,
    nextToken='string'
)
Parameters:

  • filters (dict) –

    List Connectors Request filters.

    • connectorIDs (list) –

      List Connectors Request Filters connector IDs.

      • (string) –

  • maxResults (integer) – List Connectors Request max results.

  • nextToken (string) – List Connectors Request next token.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • items (list) –

      List connectors response items.

      • (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) –

    • nextToken (string) –

      List connectors response next token.

Exceptions