SecurityHub / Client / update_connector

update_connector

SecurityHub.Client.update_connector(**kwargs)

Updates a CSPM connector’s configuration, such as the scope or regions for the connected cloud provider.

See also: AWS API Documentation

Request Syntax

response = client.update_connector(
    ConnectorId='string',
    Description='string',
    Provider={
        'Azure': {
            'ScopeConfiguration': {
                'ScopeType': 'TENANT'|'SUBSCRIPTION',
                'ScopeValues': [
                    'string',
                ]
            },
            'AzureRegions': [
                'string',
            ]
        }
    }
)

Parameters:

• ConnectorId (string) –

  [REQUIRED]

  The unique identifier of the connector to update.

• Description (string) – The updated description of the connector.

• Provider (dict) –

  The updated cloud provider configuration for the connector.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: Azure.

  • Azure (dict) –

    The Azure update configuration.

    • ScopeConfiguration (dict) – [REQUIRED]

      The updated scope configuration.

      • ScopeType (string) – [REQUIRED]

        The type of scope. Valid values are tenant and subscription.

      • ScopeValues (list) –

        The list of scope values, such as subscription IDs, when the scope type is subscription.

        • (string) –

    • AzureRegions (list) – [REQUIRED]

      The updated list of Azure regions to monitor.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ConnectorStatus': 'CONNECTED'|'DEGRADED'|'FAILED_TO_CONNECT'|'UNKNOWN',
    'EnablementStatus': 'ENABLED'|'PENDING_ENABLEMENT'|'PENDING_UPDATE'|'PENDING_DELETION'
}

Response Structure

• (dict) –

  • ConnectorStatus (string) –

    The connectivity status of the connector after the update.

  • EnablementStatus (string) –

    The enablement status of the connector after the update.

Exceptions

• SecurityHub.Client.exceptions.AccessDeniedException

• SecurityHub.Client.exceptions.InvalidAccessException

• SecurityHub.Client.exceptions.InternalServerException

• SecurityHub.Client.exceptions.ValidationException

• SecurityHub.Client.exceptions.ThrottlingException

• SecurityHub.Client.exceptions.ConflictException

• SecurityHub.Client.exceptions.ResourceNotFoundException