update_connect_client_add_in ¶

update_connect_client_add_in(
    add_in_id: AmazonUuid,
    resource_id: DirectoryId,
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    name: Optional[AddInName] = None,
    url: Optional[AddInUrl] = None,
) -> UpdateConnectClientAddInResult

Updates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in.

Parameters:

add_in_id (AmazonUuid) –

The identifier of the client add-in to update.
resource_id (DirectoryId) –

The directory identifier for which the client add-in is configured.
name (Optional[AddInName], default: None ) –

The name of the client add-in.
url (Optional[AddInUrl], default: None ) –

The endpoint URL of the Connect Customer client add-in.

Raises:

AccessDeniedException –

The user is not authorized to access a resource.
InvalidParameterValuesException –

One or more parameter values are not valid.
ResourceNotFoundException –

The resource could not be found.
UnknownServiceError –

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

Source code in docs_src/capo_workspaces/_services/work_spaces.py

def update_connect_client_add_in(
    self,
    add_in_id: "capo_workspaces.types.amazon_uuid.AmazonUuid",
    resource_id: "capo_workspaces.types.directory_id.DirectoryId",
    *,
    config_overrides: Optional[WorkSpacesClientConfig] = None,
    name: Optional["capo_workspaces.types.add_in_name.AddInName"] = None,
    url: Optional["capo_workspaces.types.add_in_url.AddInUrl"] = None,
) -> "capo_workspaces.types.update_connect_client_add_in_result.UpdateConnectClientAddInResult":
    """<p>Updates a Connect Customer client add-in. Use this action to update the name and endpoint URL of a Connect Customer client add-in.</p>

    Args:
        add_in_id: <p>The identifier of the client add-in to update.</p>
        resource_id: <p>The directory identifier for which the client add-in is configured.</p>
        name: <p>The name of the client add-in.</p>
        url: <p>The endpoint URL of the Connect Customer client add-in.</p>

    Raises:
        capo_workspaces.errors.access_denied_exception.AccessDeniedException: <p>The user is not authorized to access a resource.</p>
        capo_workspaces.errors.invalid_parameter_values_exception.InvalidParameterValuesException: <p>One or more parameter values are not valid.</p>
        capo_workspaces.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource could not be found.</p>
        capo_workspaces.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workspaces.types.update_connect_client_add_in_request.UpdateConnectClientAddInRequest]",
    ) -> OperationResponse[
        "capo_workspaces.types.update_connect_client_add_in_result.UpdateConnectClientAddInResult"
    ]:
        import capo_workspaces._operations.workspaces_service.update_connect_client_add_in

        output, http_response = (
            capo_workspaces._operations.workspaces_service.update_connect_client_add_in.update_connect_client_add_in(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateConnectClientAddIn")
    )
    input_: capo_workspaces.types.update_connect_client_add_in_request.UpdateConnectClientAddInRequest = {
        "add_in_id": add_in_id,
        "resource_id": resource_id,
    }
    if name is not None:
        input_["name"] = name
    if url is not None:
        input_["url"] = url

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