Skip to content

update_connector

update_connector(
    connector_arn: ConnectorArn,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    description: Optional[ConnectorDescription] = None,
    provider_detail: Optional[ProviderDetailUpdate] = None,
) -> UpdateConnectorResponse

Updates the description or provider-specific configuration details of an existing connector.

Parameters:

  • connector_arn (ConnectorArn) –

    The Amazon Resource Name (ARN) of the connector to update.

  • description (Optional[ConnectorDescription], default: None ) –

    The updated description of the connector.

  • provider_detail (Optional[ProviderDetailUpdate], default: None ) –

    The updated provider-specific configuration details for the connector.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

    For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

  • ConflictException –

    A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.

  • InternalServerException –

    The request has failed due to an internal failure of the Amazon Inspector service.

  • ResourceNotFoundException –

    The operation tried to access an invalid resource. Make sure the resource is specified correctly.

  • ThrottlingException –

    The limit on the number of requests per second was exceeded.

  • ValidationException –

    The request has failed validation due to missing required fields or having invalid inputs.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

Expand the Azure regions covered by a connector

>>> client.update_connector(connector_arn='arn:aws:inspector2:us-east-1:123456789012:connector/6ccf8549-b52b-57ca-bf52-a2266da3c53a', provider_detail={'azure': {'azureRegions': ['eastus', 'westus']}})
Source code in docs_src/capo_inspector2/_services/inspector2.py
def update_connector(
    self,
    connector_arn: "capo_inspector2.types.connector_arn.ConnectorArn",
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    description: Optional[
        "capo_inspector2.types.connector_description.ConnectorDescription"
    ] = None,
    provider_detail: Optional[
        "capo_inspector2.types.provider_detail_update.ProviderDetailUpdate"
    ] = None,
) -> "capo_inspector2.types.update_connector_response.UpdateConnectorResponse":
    """<p>Updates the description or provider-specific configuration details of an existing connector.</p>

    Args:
        connector_arn: <p>The Amazon Resource Name (ARN) of the connector to update.</p>
        description: <p>The updated description of the connector.</p>
        provider_detail: <p>The updated provider-specific configuration details for the connector.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.conflict_exception.ConflictException: <p>A conflict occurred. This exception occurs when the same resource is being modified by concurrent requests.</p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Expand the Azure regions covered by a connector

        >>> client.update_connector(connector_arn='arn:aws:inspector2:us-east-1:123456789012:connector/6ccf8549-b52b-57ca-bf52-a2266da3c53a', provider_detail={'azure': {'azureRegions': ['eastus', 'westus']}})
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.update_connector_request.UpdateConnectorRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.update_connector_response.UpdateConnectorResponse"
    ]:
        import capo_inspector2._operations.inspector2.update_connector

        output, http_response = (
            capo_inspector2._operations.inspector2.update_connector.update_connector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConnector")
    )
    input_: capo_inspector2.types.update_connector_request.UpdateConnectorRequest = {
        "connector_arn": connector_arn
    }
    if description is not None:
        input_["description"] = description
    if provider_detail is not None:
        input_["provider_detail"] = provider_detail

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output